Skip to main content
POST

Authorizations

Authorization
string
header
required

Enter a Bearer token obtained via the OAuth client credentials flow or from the Access Tokens tab in your account settings.

Body

application/json
account_id
integer
required

The ID of the account you're requesting data for.

Example:

2222

filters
object

Market-level filters to narrow results by geography or market performance metrics.

property_filters
object

Filters applied to properties before aggregating market metrics. Only properties matching these filters will contribute to the market-level calculations.

sort_by
string

Field to sort results by. Can be any numeric response attribute.

Example:

"population_total"

sort_order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
Example:

"desc"

limit
integer
default:50

Maximum number of markets to return.

Required range: 1 <= x <= 100
Example:

50

Response

Successfully retrieved market data. Returns markets in JSON:API format with comprehensive market-level metrics.

data
object[]
required

Array of market data in JSON:API format.