Skip to main content
GET
Get Market Survey Data

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.

Path Parameters

comp_set_id
string
required

ID of the comp set to get data for.

Query Parameters

filter[bedroom_count]
string

Filter the data by a comma-separated list of bedroom counts.

filter[bathroom_count]
string

Filter the data by a comma-separated list of bathroom counts.

filter[iq_property_ids]
string

Filter the data by a comma-separated list of property IDs.

filter[size_gte]
integer

Filter the data by minimum unit size, in square feet.

filter[size_lte]
integer

Filter the data by maximum unit size, in square feet.

filter[rent_gte]
integer

Filter the data by minimum rent, in dollars.

filter[rent_lte]
integer

Filter the data by maximum rent, in dollars.

filter[date_available_gte]
string<date>

Filter the data by minimum date available, in ISO 8601 format.

filter[date_available_lte]
string<date>

Filter the data by maximum date available, in ISO 8601 format.

filter[year_built_gte]
integer

Filter the data by minimum year built.

filter[year_built_lte]
integer

Filter the data by maximum year built.

filter[unit_style]
string

Filter the data by a comma-separated list of unit styles, where unit styles are affordable, standard, penthouse, or renovated.

filter[lease_term_ids]
string

Filter the data by a comma-separated list of lease lengths in months, such as 6,12. Rent and NER average across the selected terms that each unit offers. Units that offer none of the selected terms stay in the data with blank rent values; the endpoint description says which values. Requires lease terms on the comp set's account; otherwise the request returns 403. An empty value counts as no filter.

Response

A Map with a data attribute that contains the market survey for the comp sets.

data
object