Skip to main content
POST
Market data

Headers

idempotency-key
string
required

A caller-generated idempotency key (a UUID is recommended). One key binds to one run: a retry with the same key after a network timeout is a read, not a second execution.

Minimum string length: 1

Body

application/json
action
enum<string>
required

property_value and property_rent take address. property_search, listings_sale and listings_rental take address, or city plus state, or zip. market_stats takes zip. stock_quote takes symbol.

Available options:
property_value,
property_rent,
property_search,
listings_sale,
listings_rental,
market_stats,
stock_quote
provider
enum<string> | null

Data provider: auto (default) or one of rentcast, serpapi. Name one only when the caller asks for that vendor.

Available options:
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

Rows to return. Keep it small: the routed Endpoint's charge rule may read it. Each capability caps it further.

Required range: 1 <= x <= 100

Response

a terminal run: COMPLETED, FAILED or STOPPED

id
string
required
run_url
string
required
provider
string
required
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
required
Pattern: ^\/.+$
endpoint_version
integer
required
status
enum<string>
required
Available options:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
required
input
object
required
output
any
required
provider_response
object | null
required
charge_usd
string | null
required

Exact USD decimal string (min 2, max 6 decimals, one canonical spelling). Sum with decimal arithmetic or scale by 10^6 — never floats.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
required
stoppable
boolean
required
stop_requested_at
string<date-time> | null
required

ISO-8601 UTC timestamp

created_at
string<date-time>
required

ISO-8601 UTC timestamp

started_at
string<date-time> | null
required

ISO-8601 UTC timestamp

completed_at
string<date-time> | null
required

ISO-8601 UTC timestamp