Skip to main content
GET
List Floorplans

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[collected_at_gte]
string<date>

Filter the data by the earliest date it was collected, in ISO 8601 format. Collection date is when the data was gathered, not when a unit becomes available — for that, use filter[date_available_gte]. Dates later than the most recent available collection day are clamped to that day. Omit both collection filters to get the most recent available collection day on its own.

filter[collected_at_lte]
string<date>

Filter the data by the latest date it was collected, in ISO 8601 format. Collection date is when the data was gathered, not when a unit becomes available — for that, use filter[date_available_lte]. Omit both collection filters to get the most recent available collection day on its own.

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.

filter[aggregation_type]
string

Optional aggregation type to apply to the floor plan results (for example, averaging across units). If omitted, the service default is used.

Response

A Map with a data attribute that contains an array of floorplans for the comp set.

data
object