Skip to main content
POST
Search Geo Boundaries

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
account_id
required

ApartmentIQ account ID used to set the request account context.

query
string
required

Search term.

geo_types
enum<string>[]

Frontend geo types to include. Defaults to market geo types when omitted. Valid values: Custom, MSA, BespokeSubmarket, CensusPlace, Neighborhood, County, ZipCode, State.

Available options:
Custom,
MSA,
BespokeSubmarket,
CensusPlace,
Neighborhood,
County,
ZipCode,
State
limit
integer

Maximum number of markets to return. Defaults to 10.

Required range: x >= 1

Response

Matching market geo boundaries.

Geo-boundary search results.

markets
object[]
required

Markets and geographies matching the search query.