Properties

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
  }
}

GET

/v1/properties

GET

Bearer Token (JWT)

Bearer Tokenstring

Required

Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.

query

fieldsstring

Required

Campos a serem retornados, separados por vírgula. Use GET /v1/fields para consultar campos disponíveis. Exemplo: code,title,status,pricing,address

query

pageinteger

Número da página (começa em 1)

Min: 1

query

limitinteger

Quantidade de itens por página (máximo 100)

Min: 1 • Max: 100

query

statusstring

Filtrar por status do imóvel

Options: AVAILABLE, SOLD, RENTED, RESERVED, UNAVAILABLE

query

operationstring

Filtrar por tipo de operação

Options: SALE, RENT, SEASONAL

query

typestring

Filtrar por tipo de imóvel (case-insensitive, busca parcial). Exemplo: Apartamento, Casa

query

createdAfterstring

Retornar imóveis criados após esta data (ISO 8601)

Format: date-time

query

createdBeforestring

Retornar imóveis criados antes desta data (ISO 8601)

Format: date-time

query

updatedAfterstring

Retornar imóveis atualizados após esta data (ISO 8601). Útil para sincronização incremental.

Format: date-time

query

updatedBeforestring

Retornar imóveis atualizados antes desta data (ISO 8601)

Format: date-time

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token (JWT). Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.

Query Parameters

fieldsstring

Required

Campos a serem retornados, separados por vírgula. Use GET /v1/fields para consultar campos disponíveis. Exemplo: code,title,status,pricing,address

pageinteger

Número da página (começa em 1)

limitinteger

Quantidade de itens por página (máximo 100)

statusstring

Filtrar por status do imóvel

Allowed values:AVAILABLESOLDRENTEDRESERVEDUNAVAILABLE

operationstring

Filtrar por tipo de operação

Allowed values:SALERENTSEASONAL

typestring

Filtrar por tipo de imóvel (case-insensitive, busca parcial). Exemplo: Apartamento, Casa