Pular para o conteúdo principal
GET
Ler um resultado de dados de mercado
Use result_url sem alterações na origem da API e autentique-se com uma Key autorizada a ler todos os Runs. A resposta usa os mesmos campos da resposta inicial da Solution. HTTP 200 ainda pode conter result_status: pending; continue consultando até que status seja terminal. Essa leitura não cria Runs, não chama Providers e não retoma o fallback.

Parâmetros de consulta

token
string
obrigatório

Contexto de resultado opaco retornado em result_url. Mantenha-o inalterado e autentique-se com uma Key autorizada a ler todos os Runs listados.

Required string length: 1 - 16384

Resposta

MarketDataResult

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.