Listar imóveis
Retorna uma lista paginada de imóveis publicados. Você controla quais campos são retornados através do parâmetro fields (obrigatório).
Campos simples como title, status retornam valores diretos. Campos agrupados como address, features, pricing retornam objetos com sub-campos.
Suporta filtros por status, tipo de operação, tipo de imóvel e datas de criação/atualização.
curl -X GET "https://sandbox-partner-api.keyspot.com.br/v1/properties?fields=code,title,status,operationType,pricing&page=25&limit=42&status=AVAILABLE&operation=SALE&type=Apartamento&createdAfter=2025-01-01T00:00:00Z&createdBefore=2026-01-01T00:00:00Z&updatedAfter=2026-03-01T00:00:00Z&updatedBefore=2024-12-25T10:00:00Z" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)"
import requests
import json
url = "https://sandbox-partner-api.keyspot.com.br/v1/properties?fields=code,title,status,operationType,pricing&page=25&limit=42&status=AVAILABLE&operation=SALE&type=Apartamento&createdAfter=2025-01-01T00:00:00Z&createdBefore=2026-01-01T00:00:00Z&updatedAfter=2026-03-01T00:00:00Z&updatedBefore=2024-12-25T10:00:00Z"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://sandbox-partner-api.keyspot.com.br/v1/properties?fields=code,title,status,operationType,pricing&page=25&limit=42&status=AVAILABLE&operation=SALE&type=Apartamento&createdAfter=2025-01-01T00:00:00Z&createdBefore=2026-01-01T00:00:00Z&updatedAfter=2026-03-01T00:00:00Z&updatedBefore=2024-12-25T10:00:00Z", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://sandbox-partner-api.keyspot.com.br/v1/properties?fields=code,title,status,operationType,pricing&page=25&limit=42&status=AVAILABLE&operation=SALE&type=Apartamento&createdAfter=2025-01-01T00:00:00Z&createdBefore=2026-01-01T00:00:00Z&updatedAfter=2026-03-01T00:00:00Z&updatedBefore=2024-12-25T10:00:00Z", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://sandbox-partner-api.keyspot.com.br/v1/properties?fields=code,title,status,operationType,pricing&page=25&limit=42&status=AVAILABLE&operation=SALE&type=Apartamento&createdAfter=2025-01-01T00:00:00Z&createdBefore=2026-01-01T00:00:00Z&updatedAfter=2026-03-01T00:00:00Z&updatedBefore=2024-12-25T10:00:00Z')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
response = http.request(request)
puts response.body
{
"data": [
{
"code": "PROP-001",
"title": "Apartamento Moderno no Centro",
"status": "AVAILABLE",
"operationType": "SALE",
"pricing": {
"salePrice": 450000,
"rentalPrice": null,
"condominiumFee": 800,
"iptu": 2400
}
}
],
"meta": {
"page": 1,
"limit": 20,
"total": 50,
"totalPages": 3
}
}
{
"error": "fields: The "fields" parameter is required",
"code": "VALIDATION_ERROR"
}
{
"error": "Invalid fields: foo, bar",
"code": "INVALID_FIELDS"
}
{
"error": "Invalid or expired token",
"code": "INVALID_TOKEN"
}
{
"error": "Rate limit exceeded",
"code": "RATE_LIMIT_EXCEEDED"
}
{
"error": "Internal server error",
"code": "INTERNAL_ERROR"
}
/v1/properties
Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.
POST /v1/auth/token. Válido por 1 hora.Campos a serem retornados, separados por vírgula. Use GET /v1/fields para consultar campos disponíveis. Exemplo: code,title,status,pricing,address
Número da página (começa em 1)
Quantidade de itens por página (máximo 100)
Filtrar por status do imóvel
Filtrar por tipo de operação
Filtrar por tipo de imóvel (case-insensitive, busca parcial). Exemplo: Apartamento, Casa
Retornar imóveis criados após esta data (ISO 8601)
Retornar imóveis criados antes desta data (ISO 8601)
Retornar imóveis atualizados após esta data (ISO 8601). Útil para sincronização incremental.
Retornar imóveis atualizados antes desta data (ISO 8601)
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.
Query Parameters
Campos a serem retornados, separados por vírgula. Use GET /v1/fields para consultar campos disponíveis. Exemplo: code,title,status,pricing,address
Número da página (começa em 1)
Quantidade de itens por página (máximo 100)
Filtrar por tipo de imóvel (case-insensitive, busca parcial). Exemplo: Apartamento, Casa
Retornar imóveis criados após esta data (ISO 8601)
Retornar imóveis criados antes desta data (ISO 8601)
Retornar imóveis atualizados após esta data (ISO 8601). Útil para sincronização incremental.
Retornar imóveis atualizados antes desta data (ISO 8601)
Responses
Identificador único do imóvel
Código do imóvel na imobiliária
Título do imóvel
Descrição detalhada do imóvel
Tipo de operação do imóvel
SALERENTSEASONALStatus do imóvel
AVAILABLESOLDRENTEDRESERVEDUNAVAILABLETipo do imóvel (ex: Apartamento, Casa, Terreno)
Endereço do imóvel
Nome da rua
Número
Complemento
Bairro
Cidade
Estado
Sigla do estado
CEP
Coordenadas geográficas do imóvel
Latitude
Longitude
Características do imóvel
Área total em m²
Área construída em m²
Número de quartos
Número de banheiros
Número de suítes
Número de vagas de garagem
Andar do imóvel
Total de andares do edifício
Se o imóvel é mobiliado
Valores do imóvel
Preço de venda em reais
Preço de aluguel mensal em reais
Taxa de condomínio mensal em reais
IPTU anual em reais
Opções de financiamento
Se aceita financiamento
Nível de destaque do imóvel
Se o imóvel é exclusivo da imobiliária
Se o imóvel está publicado
Fotos do imóvel ordenadas por order
Identificador da foto
URL da imagem
Texto alternativo
Ordem de exibição
Se é a foto principal
Data de criação (ISO 8601)
Data da última atualização (ISO 8601)
Metadados de paginação
Página atual
Itens por página
Total de registros
Total de páginas
Mensagem de erro legível
Código de erro programático
Mensagem de erro legível
Código de erro programático
Mensagem de erro legível
Código de erro programático
Mensagem de erro legível
Código de erro programático
Last updated Mar 13, 2026
Built with Documentation.AI