> ## Documentation Index > Fetch the complete documentation index at: https://glasser.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Dados de mercado > Valores de imóveis nos EUA, estimativas de aluguel, registros de imóveis, anúncios, estatísticas de mercado por ZIP e cotações de ações, com uma única saída normalizada. 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](https://glasser.ai/docs/pt/api-reference/runs/get.md). `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](https://glasser.ai/docs/pt/api-reference/solutions/overview.md#how-provider-selection-works). ## 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. | `action` | `output` | | - | - | | `property_value` | campos de propriedade mais `estimated_value_usd`, `value_low_usd`, `value_high_usd`, `comparables_count` | | `property_rent` | campos de propriedade mais `estimated_rent_usd` (mensal), `rent_low_usd`, `rent_high_usd`, `comparables_count` | | `property_search` | `items[]`: `property_id`, campos de propriedade, `last_sale_price_usd`, `last_sale_date`, `owner_names`\[], `owner_type`, `owner_mailing_address`, `owner_occupied` | | `listings_sale` | `items[]`: campos de anúncio mais `price_usd` (`price` solicitado) | | `listings_rental` | `items[]`: campos de anúncio mais `monthly_rent_usd` | | `market_stats` | `zip`, `updated_at`, `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, average_days_on_market, median_days_on_market, total_listings, new_listings}` | | `stock_quote` | `symbol`, `name`, `exchange`, `currency`, `price`, `change`, `change_percent`, `extended_hours_session`, `extended_hours_price`, `extended_hours_change`, `extended_hours_change_percent`, `as_of_text` | * `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`. ```json { "action": "property_value", "provider": "rentcast", "status": "COMPLETED", "result_status": "success", "output": { "address": "5500 Grand Lake Dr, San Antonio, TX 78244", "property_type": "Single Family", "bedrooms": 3, "bathrooms": 2, "living_area_sqft": 1878, "lot_size_sqft": 8843, "year_built": 1973, "latitude": 29.476011, "longitude": -98.351454, "estimated_value_usd": 235000, "value_low_usd": 203000, "value_high_usd": 266000, "comparables_count": 15 }, "charge_usd": "0.0814", "runs": [{ "provider": "rentcast", "status": "COMPLETED", "charge_usd": "0.0814" }], "result_url": "/v1/solutions/gtm/market_data/result?token=…" } ``` ## OpenAPI ````yaml /openapi.pt.json post /v1/solutions/gtm/market_data openapi: 3.1.0 info: title: Glasser version: 0.0.1 description: >- Uma chave, sem contrato, pagamento por chamada, para todas as APIs pagas adquiridas no atacado. Cada resposta contém x-request-id; cada corpo de erro contém o mesmo envelope. servers: - url: https://api.glasser.ai security: [] tags: - name: Solutions - name: Endpoints - name: Runs - name: Balance paths: /v1/solutions/gtm/market_data: post: tags: - Solutions summary: Dados de mercado description: >- Valores de imóveis nos EUA, estimativas de aluguel, registros de imóveis, anúncios de venda e aluguel, estatísticas de mercado por ZIP e cotações de ações. Escolha uma ação e informe um endereço, uma cidade com estado, um ZIP ou um símbolo de ticker. Cada ação retorna dados normalizados com o id, o provedor de dados e o status do ciclo de vida do último Run: property_value, property_rent, market_stats e stock_quote fornecem campos de nível superior fixos; property_search, listings_sale e listings_rental fornecem output.items[] com campos fixos por linha. A saída nativa do provedor de dados não é repetida em output; ela permanece no Run e pode ser lida com GET /v1/runs/:id. Um valor não informado pelo provedor de dados é null; valores monetários de imóveis são em USD, e uma cotação de ação inclui sua moeda. Leia result_status separadamente de status: success, no_result, error ou pending. charge_usd é o total dos Runs desta resposta e permanece null até que todos os Runs listados sejam concluídos; runs[] contém a cobrança de cada Run. Um provedor de dados nomeado nunca usa fallback. Para QUEUED/RUNNING (HTTP 202), consulte result_url autenticado na origem da API. Reutilize o mesmo Idempotency-Key e os parâmetros de execução para uma nova tentativa intencional. operationId: gtm-market-data parameters: - name: idempotency-key in: header schema: type: string minLength: 1 description: >- 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. required: true requestBody: content: application/json: schema: type: object properties: action: type: string enum: - property_value - property_rent - property_search - listings_sale - listings_rental - market_stats - stock_quote description: >- 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. provider: anyOf: - type: string enum: - auto - rentcast - serpapi description: >- 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. - type: 'null' address: anyOf: - type: string minLength: 1 maxLength: 300 - type: 'null' city: anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' state: anyOf: - type: string pattern: ^[A-Za-z]{2}$ - type: 'null' zip: anyOf: - type: string pattern: ^\d{5}$ - type: 'null' symbol: anyOf: - type: string minLength: 1 maxLength: 40 - type: 'null' limit: anyOf: - type: integer minimum: 1 maximum: 100 description: >- 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. - type: 'null' task_id: anyOf: - type: string description: >- 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. - type: 'null' metadata: anyOf: - anyOf: - type: object additionalProperties: type: string minLength: 1 maxLength: 500 maxProperties: 20 propertyNames: type: string pattern: ^[a-z][a-z0-9_]{0,39}$ - {} description: >- 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. - type: 'null' required: - action additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/MarketDataResult' '202': description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/MarketDataResult' '400': description: ValidationFailed | IdempotencyKeyRequired content: application/json: schema: anyOf: - $ref: '#/components/schemas/ValidationFailedEncoded' - $ref: '#/components/schemas/IdempotencyKeyRequiredEncoded' - $ref: '#/components/schemas/ValidationFailedEncoded' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedEncoded' '402': description: InsufficientBalance content: application/json: schema: $ref: '#/components/schemas/InsufficientBalanceEncoded' '403': description: EndpointNotPermitted | Forbidden content: application/json: schema: anyOf: - $ref: '#/components/schemas/EndpointNotPermittedEncoded' - $ref: '#/components/schemas/ForbiddenEncoded' '409': description: IdempotencyConflict content: application/json: schema: $ref: '#/components/schemas/IdempotencyConflictEncoded' '429': description: RateLimited content: application/json: schema: $ref: '#/components/schemas/RateLimitedEncoded' '503': description: ServiceUnavailable content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableEncoded' security: - bearer: [] components: schemas: MarketDataResult: type: object properties: id: type: string run_url: type: string description: Abra este Run no console. Requer associação ao Workspace. provider: type: string pattern: ^[a-z0-9][a-z0-9-]*$ endpoint: type: string pattern: ^\/.+$ endpoint_version: type: integer exclusiveMinimum: 0 status: type: string enum: - QUEUED - RUNNING - COMPLETED - FAILED - STOPPED description: >- 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. failure: anyOf: - type: object properties: kind: type: string enum: - TIMED_OUT - INTERNAL message: type: string required: - kind - message additionalProperties: false - type: 'null' description: Motivo da falha do Run. Não nulo somente quando status é FAILED. input: type: object output: anyOf: - anyOf: - type: object properties: address: anyOf: - type: string - type: 'null' property_type: anyOf: - type: string - type: 'null' bedrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' bathrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' living_area_sqft: anyOf: - type: integer - type: 'null' lot_size_sqft: anyOf: - type: integer - type: 'null' year_built: anyOf: - type: integer - type: 'null' latitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' longitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' estimated_value_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' value_low_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' value_high_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' comparables_count: anyOf: - type: integer - type: 'null' required: - address - property_type - bedrooms - bathrooms - living_area_sqft - lot_size_sqft - year_built - latitude - longitude - estimated_value_usd - value_low_usd - value_high_usd - comparables_count additionalProperties: false - type: object properties: address: anyOf: - type: string - type: 'null' property_type: anyOf: - type: string - type: 'null' bedrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' bathrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' living_area_sqft: anyOf: - type: integer - type: 'null' lot_size_sqft: anyOf: - type: integer - type: 'null' year_built: anyOf: - type: integer - type: 'null' latitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' longitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' estimated_rent_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' rent_low_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' rent_high_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' comparables_count: anyOf: - type: integer - type: 'null' required: - address - property_type - bedrooms - bathrooms - living_area_sqft - lot_size_sqft - year_built - latitude - longitude - estimated_rent_usd - rent_low_usd - rent_high_usd - comparables_count additionalProperties: false - type: object properties: items: type: array items: type: object properties: property_id: anyOf: - type: string - type: 'null' address: anyOf: - type: string - type: 'null' property_type: anyOf: - type: string - type: 'null' bedrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' bathrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' living_area_sqft: anyOf: - type: integer - type: 'null' lot_size_sqft: anyOf: - type: integer - type: 'null' year_built: anyOf: - type: integer - type: 'null' latitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' longitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' last_sale_price_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' last_sale_date: anyOf: - type: string - type: 'null' owner_names: anyOf: - type: array items: type: string - type: 'null' owner_type: anyOf: - type: string - type: 'null' owner_mailing_address: anyOf: - type: string - type: 'null' owner_occupied: anyOf: - type: boolean - type: 'null' required: - property_id - address - property_type - bedrooms - bathrooms - living_area_sqft - lot_size_sqft - year_built - latitude - longitude - last_sale_price_usd - last_sale_date - owner_names - owner_type - owner_mailing_address - owner_occupied additionalProperties: false required: - items additionalProperties: false - type: object properties: items: type: array items: type: object properties: listing_id: anyOf: - type: string - type: 'null' address: anyOf: - type: string - type: 'null' property_type: anyOf: - type: string - type: 'null' bedrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' bathrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' living_area_sqft: anyOf: - type: integer - type: 'null' lot_size_sqft: anyOf: - type: integer - type: 'null' year_built: anyOf: - type: integer - type: 'null' latitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' longitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' status: anyOf: - type: string - type: 'null' listing_type: anyOf: - type: string - type: 'null' listed_date: anyOf: - type: string - type: 'null' days_on_market: anyOf: - type: integer - type: 'null' hoa_fee_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' mls_name: anyOf: - type: string - type: 'null' mls_number: anyOf: - type: string - type: 'null' agent: anyOf: - type: object properties: name: anyOf: - type: string - type: 'null' phone: anyOf: - type: string - type: 'null' email: anyOf: - type: string - type: 'null' website: anyOf: - type: string - type: 'null' required: - name - phone - email - website additionalProperties: false - type: 'null' office: anyOf: - type: object properties: name: anyOf: - type: string - type: 'null' phone: anyOf: - type: string - type: 'null' email: anyOf: - type: string - type: 'null' website: anyOf: - type: string - type: 'null' required: - name - phone - email - website additionalProperties: false - type: 'null' price_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' required: - listing_id - address - property_type - bedrooms - bathrooms - living_area_sqft - lot_size_sqft - year_built - latitude - longitude - status - listing_type - listed_date - days_on_market - hoa_fee_usd - mls_name - mls_number - agent - office - price_usd additionalProperties: false required: - items additionalProperties: false - type: object properties: items: type: array items: type: object properties: listing_id: anyOf: - type: string - type: 'null' address: anyOf: - type: string - type: 'null' property_type: anyOf: - type: string - type: 'null' bedrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' bathrooms: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' living_area_sqft: anyOf: - type: integer - type: 'null' lot_size_sqft: anyOf: - type: integer - type: 'null' year_built: anyOf: - type: integer - type: 'null' latitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' longitude: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' status: anyOf: - type: string - type: 'null' listing_type: anyOf: - type: string - type: 'null' listed_date: anyOf: - type: string - type: 'null' days_on_market: anyOf: - type: integer - type: 'null' hoa_fee_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' mls_name: anyOf: - type: string - type: 'null' mls_number: anyOf: - type: string - type: 'null' agent: anyOf: - type: object properties: name: anyOf: - type: string - type: 'null' phone: anyOf: - type: string - type: 'null' email: anyOf: - type: string - type: 'null' website: anyOf: - type: string - type: 'null' required: - name - phone - email - website additionalProperties: false - type: 'null' office: anyOf: - type: object properties: name: anyOf: - type: string - type: 'null' phone: anyOf: - type: string - type: 'null' email: anyOf: - type: string - type: 'null' website: anyOf: - type: string - type: 'null' required: - name - phone - email - website additionalProperties: false - type: 'null' monthly_rent_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' required: - listing_id - address - property_type - bedrooms - bathrooms - living_area_sqft - lot_size_sqft - year_built - latitude - longitude - status - listing_type - listed_date - days_on_market - hoa_fee_usd - mls_name - mls_number - agent - office - monthly_rent_usd additionalProperties: false required: - items additionalProperties: false - type: object properties: zip: anyOf: - type: string - type: 'null' updated_at: anyOf: - type: string - type: 'null' sale: anyOf: - type: object properties: average_price_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' median_price_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' average_price_per_sqft_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' median_price_per_sqft_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' average_days_on_market: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' median_days_on_market: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' total_listings: anyOf: - type: integer - type: 'null' new_listings: anyOf: - type: integer - type: 'null' required: - 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 additionalProperties: false - type: 'null' rental: anyOf: - type: object properties: average_rent_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' median_rent_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' average_rent_per_sqft_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' median_rent_per_sqft_usd: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' average_days_on_market: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' median_days_on_market: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' total_listings: anyOf: - type: integer - type: 'null' new_listings: anyOf: - type: integer - type: 'null' required: - average_rent_usd - median_rent_usd - average_rent_per_sqft_usd - median_rent_per_sqft_usd - average_days_on_market - median_days_on_market - total_listings - new_listings additionalProperties: false - type: 'null' required: - zip - updated_at - sale - rental additionalProperties: false - type: object properties: symbol: anyOf: - type: string - type: 'null' name: anyOf: - type: string - type: 'null' exchange: anyOf: - type: string - type: 'null' currency: anyOf: - type: string - type: 'null' price: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' change: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' change_percent: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' extended_hours_session: anyOf: - type: string - type: 'null' extended_hours_price: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' extended_hours_change: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' extended_hours_change_percent: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' as_of_text: anyOf: - type: string - type: 'null' required: - symbol - name - exchange - currency - price - change - change_percent - extended_hours_session - extended_hours_price - extended_hours_change - extended_hours_change_percent - as_of_text additionalProperties: false - type: 'null' description: >- 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: anyOf: - type: object properties: http_status: type: integer minimum: 100 maximum: 599 description: >- Status HTTP retornado pelo provedor de dados. Verifique-o mesmo quando o Run estiver COMPLETED. error: anyOf: - {} - type: 'null' required: - http_status additionalProperties: false - type: 'null' description: >- 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: anyOf: - type: string pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$ description: >- String decimal exata em USD (mínimo de 2 e máximo de 6 casas decimais, com uma única grafia canônica). Some usando aritmética decimal ou multiplique por 10^6 — nunca use números de ponto flutuante. - type: 'null' description: >- 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. charge_basis: anyOf: - type: object properties: clause: type: string enum: - rule - NO_RESULT - PROVIDER_ERROR - TIMED_OUT - INTERNAL quantity: anyOf: - type: integer minimum: 0 - type: 'null' required: - clause - quantity additionalProperties: false - type: 'null' description: >- 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: type: boolean description: >- 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: anyOf: - type: string description: carimbo de data e hora UTC ISO-8601 format: date-time - type: 'null' description: >- Momento em que uma interrupção foi solicitada. O Run ainda pode continuar se o despacho já tiver começado. created_at: type: string description: carimbo de data e hora UTC ISO-8601 format: date-time started_at: anyOf: - type: string description: carimbo de data e hora UTC ISO-8601 format: date-time - type: 'null' completed_at: anyOf: - type: string description: carimbo de data e hora UTC ISO-8601 format: date-time - type: 'null' task_id: anyOf: - type: string - type: 'null' metadata: type: object additionalProperties: type: string minLength: 1 maxLength: 500 maxProperties: 20 propertyNames: type: string pattern: ^[a-z][a-z0-9_]{0,39}$ description: >- 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: type: string enum: - property_value - property_rent - property_search - listings_sale - listings_rental - market_stats - stock_quote result_status: type: string enum: - success - no_result - error - pending description: >- 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. error: anyOf: - type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false - type: 'null' runs: type: array items: type: object properties: id: type: string run_url: type: string description: Abra este Run no console. Requer associação ao Workspace. provider: type: string pattern: ^[a-z0-9][a-z0-9-]*$ endpoint: type: string pattern: ^\/.+$ endpoint_version: type: integer exclusiveMinimum: 0 status: type: string enum: - QUEUED - RUNNING - COMPLETED - FAILED - STOPPED description: >- 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. failure: anyOf: - type: object properties: kind: type: string enum: - TIMED_OUT - INTERNAL message: type: string required: - kind - message additionalProperties: false - type: 'null' description: >- Motivo da falha do Run. Não nulo somente quando status é FAILED. input: type: object properties: omitted: type: boolean enum: - true required: - omitted additionalProperties: false output: type: object properties: omitted: type: boolean enum: - true required: - omitted additionalProperties: false provider_response: anyOf: - type: object properties: http_status: type: integer minimum: 100 maximum: 599 description: >- Status HTTP retornado pelo provedor de dados. Verifique-o mesmo quando o Run estiver COMPLETED. required: - http_status additionalProperties: false - type: 'null' charge_usd: anyOf: - type: string pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$ description: >- String decimal exata em USD (mínimo de 2 e máximo de 6 casas decimais, com uma única grafia canônica). Some usando aritmética decimal ou multiplique por 10^6 — nunca use números de ponto flutuante. - type: 'null' description: >- Cobrança final como uma string decimal exata em USD. Nulo enquanto estiver QUEUED ou RUNNING. Um Run FAILED pode ter uma cobrança diferente de zero conforme o Price do Endpoint. charge_basis: anyOf: - type: object properties: clause: type: string enum: - rule - NO_RESULT - PROVIDER_ERROR - TIMED_OUT - INTERNAL quantity: anyOf: - type: integer minimum: 0 - type: 'null' required: - clause - quantity additionalProperties: false - type: 'null' description: >- Cláusula de Price usada para calcular a cobrança. Nulo antes da liquidação ou quando nenhuma tentativa com o provedor de dados foi feita. stoppable: type: boolean description: >- 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: anyOf: - type: string description: carimbo de data e hora UTC ISO-8601 format: date-time - type: 'null' description: >- Momento em que uma interrupção foi solicitada. O Run ainda pode continuar se o despacho já tiver começado. created_at: type: string description: carimbo de data e hora UTC ISO-8601 format: date-time started_at: anyOf: - type: string description: carimbo de data e hora UTC ISO-8601 format: date-time - type: 'null' completed_at: anyOf: - type: string description: carimbo de data e hora UTC ISO-8601 format: date-time - type: 'null' task_id: anyOf: - type: string - type: 'null' metadata: type: object additionalProperties: type: string minLength: 1 maxLength: 500 maxProperties: 20 propertyNames: type: string pattern: ^[a-z][a-z0-9_]{0,39}$ description: >- 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. required: - id - run_url - provider - endpoint - endpoint_version - status - failure - input - output - provider_response - charge_usd - charge_basis - stoppable - stop_requested_at - created_at - started_at - completed_at - task_id - metadata additionalProperties: false result_url: type: string description: >- 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. required: - id - run_url - provider - endpoint - endpoint_version - status - failure - input - output - provider_response - charge_usd - charge_basis - stoppable - stop_requested_at - created_at - started_at - completed_at - task_id - metadata - action - result_status - error - runs - result_url additionalProperties: false ValidationFailedEncoded: type: object properties: error: type: object properties: code: type: string enum: - validation_failed message: type: string reason: anyOf: - type: string - type: 'null' control: anyOf: - type: string - type: 'null' retry_after_ms: anyOf: - anyOf: - type: integer - type: 'null' - type: 'null' details: anyOf: - type: object - type: 'null' required: - code - message additionalProperties: false request_id: type: string required: - error - request_id additionalProperties: false IdempotencyKeyRequiredEncoded: type: object properties: error: type: object properties: code: type: string enum: - idempotency_key_required message: type: string reason: anyOf: - type: string - type: 'null' control: anyOf: - type: string - type: 'null' retry_after_ms: anyOf: - anyOf: - type: integer - type: 'null' - type: 'null' details: anyOf: - type: object - type: 'null' required: - code - message additionalProperties: false request_id: type: string required: - error - request_id additionalProperties: false UnauthorizedEncoded: type: object properties: error: type: object properties: code: type: string enum: - unauthorized message: type: string reason: anyOf: - type: string - type: 'null' control: anyOf: - type: string - type: 'null' retry_after_ms: anyOf: - anyOf: - type: integer - type: 'null' - type: 'null' details: anyOf: - type: object - type: 'null' required: - code - message additionalProperties: false request_id: type: string required: - error - request_id additionalProperties: false InsufficientBalanceEncoded: type: object properties: error: type: object properties: code: type: string enum: - insufficient_balance message: type: string reason: anyOf: - type: string - type: 'null' control: anyOf: - type: string - type: 'null' retry_after_ms: anyOf: - anyOf: - type: integer - type: 'null' - type: 'null' details: anyOf: - type: object - type: 'null' required: - code - message additionalProperties: false request_id: type: string required: - error - request_id additionalProperties: false EndpointNotPermittedEncoded: type: object properties: error: type: object properties: code: type: string enum: - endpoint_not_permitted message: type: string reason: anyOf: - type: string - type: 'null' control: anyOf: - type: string - type: 'null' retry_after_ms: anyOf: - anyOf: - type: integer - type: 'null' - type: 'null' details: anyOf: - type: object - type: 'null' required: - code - message additionalProperties: false request_id: type: string required: - error - request_id additionalProperties: false ForbiddenEncoded: type: object properties: error: type: object properties: code: type: string enum: - forbidden message: type: string reason: anyOf: - type: string - type: 'null' control: anyOf: - type: string - type: 'null' retry_after_ms: anyOf: - anyOf: - type: integer - type: 'null' - type: 'null' details: anyOf: - type: object - type: 'null' required: - code - message additionalProperties: false request_id: type: string required: - error - request_id additionalProperties: false IdempotencyConflictEncoded: type: object properties: error: type: object properties: code: type: string enum: - idempotency_conflict message: type: string reason: anyOf: - type: string - type: 'null' control: anyOf: - type: string - type: 'null' retry_after_ms: anyOf: - anyOf: - type: integer - type: 'null' - type: 'null' details: anyOf: - type: object - type: 'null' required: - code - message additionalProperties: false request_id: type: string required: - error - request_id additionalProperties: false RateLimitedEncoded: type: object properties: error: type: object properties: code: type: string enum: - rate_limited message: type: string reason: anyOf: - type: string - type: 'null' control: anyOf: - type: string - type: 'null' retry_after_ms: anyOf: - anyOf: - type: integer - type: 'null' - type: 'null' details: anyOf: - type: object - type: 'null' required: - code - message additionalProperties: false request_id: type: string required: - error - request_id additionalProperties: false ServiceUnavailableEncoded: type: object properties: error: type: object properties: code: type: string enum: - service_unavailable message: type: string reason: anyOf: - type: string - type: 'null' control: anyOf: - type: string - type: 'null' retry_after_ms: anyOf: - anyOf: - type: integer - type: 'null' - type: 'null' details: anyOf: - type: object - type: 'null' required: - code - message additionalProperties: false request_id: type: string required: - error - request_id additionalProperties: false securitySchemes: bearer: type: http scheme: Bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.