Pular para o conteúdo principal
POST
Dados de mercado
Cada ação retorna output normalizado. A saída nativa do provedor não é repetida nele; ela permanece no Run e pode ser lida com Get Run. property_value, property_rent, market_stats e stock_quote expõem campos de nível superior fixos; property_search, listings_sale e listings_rental expõem output.items[]. Um valor que o provedor não informa é null. Os valores monetários das propriedades estão em USD; uma cotação de ações inclui seu currency. Leia result_status separadamente de status: success, no_result, error ou pending. Uma resposta vazia, mas válida, como um endereço sem uma estimativa, é no_result e mantém a estrutura da ação: cada campo é null, ou items é []. charge_usd totaliza runs desta resposta. Consulte Seleção de provedores e cobranças.

Saída por ação

Os campos de propriedade são address, property_type, bedrooms, bathrooms, living_area_sqft, lot_size_sqft, year_built, latitude, longitude. Os campos de anúncio são listing_id, os campos de propriedade, status, listing_type, listed_date, days_on_market, hoa_fee_usd (taxa mensal de HOA), mls_name, mls_number, agent e office. agent e office são {name, phone, email, website}, ou null quando o provedor não informa nenhum.
  • comparables_count é o número de vendas ou aluguéis comparáveis usados na estimativa.
  • last_sale_date e listed_date são YYYY-MM-DD; updated_at está em UTC no formato ISO 8601, indicando quando a RentCast atualizou o agregado pela última vez.
  • O lado rental de market_stats, monthly_rent_usd e estimated_rent_usd corresponde aos aluguéis mensais.
  • price é o último preço da sessão regular em currency; as cotações do Google Finance podem estar atrasadas. change é a variação absoluta em currency e change_percent está em pontos percentuais (1,5 = 1,5%), ambos em relação ao fechamento regular anterior.
  • extended_hours_session é o rótulo da sessão conforme exibido (pré-mercado ou após o horário) e é null durante o horário regular. Os valores de extended_hours_* comparam a cotação do horário estendido com o preço da sessão regular, nas mesmas unidades.
  • as_of_text é o carimbo de data e hora da página do Google Finance exatamente como exibido. Ele não está no formato ISO e não corresponde ao horário de price.

Cabeçalhos

idempotency-key
string
obrigatório

Gere um valor exclusivo para cada execução pretendida (recomenda-se um UUID). Tente novamente com a mesma chave e os mesmos parâmetros de execução para recuperar o Run original sem uma segunda cobrança. Alterar os parâmetros de execução usando a mesma chave retorna 409; alterar task_id ou metadata não atualiza o Run original.

Minimum string length: 1

Corpo

application/json
action
enum<string>
obrigatório

Escolha os dados a serem recuperados:

  • property_value ou property_rent: informe o endereço.
  • property_search, listings_sale ou listings_rental: informe o endereço, a cidade com o estado ou o ZIP.
  • market_stats: informe o ZIP.
  • stock_quote: informe o símbolo.
Opções disponíveis:
property_value,
property_rent,
property_search,
listings_sale,
listings_rental,
market_stats,
stock_quote
provider
enum<string> | null

Padrão auto: seleciona o primeiro provedor de dados elegível na ordem de preferência da Glasser. Um provedor de dados nomeado precisa ser compatível com a solicitação e permitido pela sua Key; ele não usa fallback para outro provedor de dados. Os valores disponíveis estão listados abaixo.

Opções disponíveis:
auto,
rentcast,
serpapi
address
string | null
Required string length: 1 - 300
city
string | null
Required string length: 1 - 100
state
string | null
Pattern: ^[A-Za-z]{2}$
zip
string | null
Pattern: ^\d{5}$
symbol
string | null
Required string length: 1 - 40
limit
integer | null

Linhas a retornar. Mantenha esse número baixo: a regra de cobrança do endpoint roteado pode considerá-lo. Cada capacidade pode impor um limite menor.

Intervalo obrigatório: 1 <= x <= 100
task_id
string | null

Agrupe Runs relacionados, incluindo o fallback automático, em uma única Task. Reutilize uma string estável e filtre a lista de Runs por task para recuperá-los.

metadata

Campos opcionais de acompanhamento, retornados no Run e disponíveis como filtros. Eles nunca são enviados ao provedor de dados nem afetam o roteamento, o Price ou a idempotência.

  • Até 20 chaves: letras minúsculas, dígitos e sublinhados; comece com uma letra; no máximo 40 caracteres.
  • Valores: strings de 1–500 caracteres.
  • user_id: o ID opaco do seu usuário final, nunca o endereço de e-mail ou o nome dele.

Entradas inválidas são descartadas por completo, sem truncamento. A solicitação continua, e o Run retorna os campos que foram armazenados.

Resposta

Success

id
string
obrigatório
run_url
string
obrigatório

Abra este Run no console. Requer associação ao Workspace.

provider
string
obrigatório
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
obrigatório
Pattern: ^\/.+$
endpoint_version
integer
obrigatório
status
enum<string>
obrigatório

QUEUED ou RUNNING: ainda em andamento. COMPLETED: uma resposta do provedor de dados está disponível, incluindo respostas não 2xx. FAILED: consulte failure. STOPPED: interrompido antes do despacho. Leia charge_usd separadamente de status.

Opções disponíveis:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
obrigatório

Motivo da falha do Run. Não nulo somente quando status é FAILED.

input
object
obrigatório
output
object
obrigatório

Campos normalizados por ação. A saída nativa do provedor de dados não é repetida aqui; ela permanece no Run (GET /v1/runs/:id). Os valores que o provedor de dados não informar são nulos; uma resposta vazia mantém a estrutura da ação, com todos os campos nulos (ou items: []) e result_status no_result. Os valores monetários estão em USD, a menos que a ação tenha um campo de moeda. As datas denominadas *_date são YYYY-MM-DD, *_at são UTC ISO 8601 e *_text é o texto de exibição exatamente como retornado.

  • property_value: address, property_type, bedrooms, bathrooms, living_area_sqft (área habitável), lot_size_sqft, year_built, latitude, longitude, estimated_value_usd, value_low_usd, value_high_usd, comparables_count (número de vendas comparáveis usadas na estimativa)
  • property_rent: address, property_type, bedrooms, bathrooms, living_area_sqft (área habitável), lot_size_sqft, year_built, latitude, longitude, estimated_rent_usd (mensal), rent_low_usd, rent_high_usd, comparables_count (número de aluguéis comparáveis usados na estimativa)
  • property_search: items[]: property_id, address, property_type, bedrooms, bathrooms, living_area_sqft (área habitável), lot_size_sqft, year_built, latitude, longitude, last_sale_price_usd, last_sale_date (YYYY-MM-DD), owner_names[], owner_type, owner_mailing_address, owner_occupied
  • listings_sale: items[]: listing_id, address, property_type, bedrooms, bathrooms, living_area_sqft (área habitável), lot_size_sqft, year_built, latitude, longitude, status, listing_type, listed_date (YYYY-MM-DD), days_on_market, hoa_fee_usd (taxa mensal de HOA), mls_name, mls_number, agent {name, phone, email, website}, office {name, phone, email, website}, price_usd (preço pedido)
  • listings_rental: items[]: listing_id, address, property_type, bedrooms, bathrooms, living_area_sqft (área habitável), lot_size_sqft, year_built, latitude, longitude, status, listing_type, listed_date (YYYY-MM-DD), days_on_market, hoa_fee_usd (taxa mensal de HOA), mls_name, mls_number, agent {name, phone, email, website}, office {name, phone, email, website}, monthly_rent_usd
  • market_stats: zip, updated_at (UTC ISO 8601, quando a RentCast atualizou o agregado pela última vez), sale {average_price_usd, median_price_usd, average_price_per_sqft_usd, median_price_per_sqft_usd, average_days_on_market, median_days_on_market, total_listings, new_listings}, rental {average_rent_usd, median_rent_usd, average_rent_per_sqft_usd, median_rent_per_sqft_usd (aluguel mensal), average_days_on_market, median_days_on_market, total_listings, new_listings}
  • stock_quote: symbol, name, exchange, currency, price (último preço da sessão regular, na moeda; as cotações do Google Finance podem estar atrasadas), change (variação absoluta, na moeda, em relação ao fechamento regular anterior), change_percent (pontos percentuais em relação ao fechamento regular anterior: 1.5 = 1.5%), extended_hours_session (rótulo da sessão conforme exibido, por exemplo, Pre-market ou After hours; nulo durante o horário regular), extended_hours_price, extended_hours_change e extended_hours_change_percent (cotação fora do horário regular em relação ao preço da sessão regular, nas mesmas unidades), as_of_text (carimbo de data e hora da página do Google Finance exatamente como exibido, não em ISO e não o horário do preço)
provider_response
object | null
obrigatório

Não nulo somente quando status é COMPLETED.

  • Para respostas 2xx, output contém JSON nativo do provedor de dados (qualquer estrutura) ou nulo para um corpo vazio.
  • Para respostas não 2xx, error contém o corpo de erro do provedor de dados e output é nulo.

Os campos confidenciais são removidos de ambos os corpos.

charge_usd
string | null
obrigatório

Cobrança total dos Runs nesta resposta de Solution. Nulo até que todos os Runs listados sejam liquidados. Cada Run mantém sua própria cobrança; falhas também podem ser cobradas.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
obrigatório

Base de cobrança de um único Run ou nulo para um total de vários Runs. Leia runs[].charge_basis para cada cobrança.

stoppable
boolean
obrigatório

Indica se uma solicitação de interrupção pode ser aceita no momento. Isso não garante que o Run possa ser interrompido antes do despacho.

stop_requested_at
string<date-time> | null
obrigatório

Momento em que uma interrupção foi solicitada. O Run ainda pode continuar se o despacho já tiver começado.

created_at
string<date-time>
obrigatório

carimbo de data e hora UTC ISO-8601

started_at
string<date-time> | null
obrigatório

carimbo de data e hora UTC ISO-8601

completed_at
string<date-time> | null
obrigatório

carimbo de data e hora UTC ISO-8601

task_id
string | null
obrigatório
metadata
object
obrigatório

Seus campos de acompanhamento armazenados. Use-os para filtrar Runs. Eles nunca são enviados ao provedor de dados nem afetam o roteamento, o Price ou a idempotência.

  • Até 20 chaves: letras minúsculas, dígitos e sublinhados; comece com uma letra; no máximo 40 caracteres.
  • Valores: strings de 1–500 caracteres.
  • user_id: o ID opaco do seu usuário final, nunca o endereço de e-mail ou o nome dele.
action
enum<string>
obrigatório
Opções disponíveis:
property_value,
property_rent,
property_search,
listings_sale,
listings_rental,
market_stats,
stock_quote
result_status
enum<string>
obrigatório

Status de entrega comercial, independente do ciclo de vida final do Run em status. no_result é uma resposta vazia, mas válida; error significa que não foi possível entregar a saída do provedor de dados.

Opções disponíveis:
success,
no_result,
error,
pending
error
object | null
obrigatório
runs
object[]
obrigatório
result_url
string
obrigatório

Caminho de URL autenticado e somente leitura para consultar este resultado normalizado e a cobrança total. Use com a origem da API. Não cria Runs nem retoma o fallback. GET /v1/runs/:id ainda retorna o Run nativo e individual.