Skip to main content
POST
/
geo_boundaries
/
search
curl --request POST \
  --url https://data.apartmentiq.io/apartmentiq/api/v1/geo_boundaries/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "your_account_id",
  "query": "raleigh",
  "geo_type": [
    "MSA",
    "BespokeSubmarket"
  ],
  "limit": 10
}
'
{
  "data": [
    {
      "id": "1",
      "type": "geo_boundary_search_result",
      "attributes": {
        "id": 1,
        "name": "Raleigh-Cary, NC Metro Area",
        "description": "Raleigh-Cary, NC",
        "geo_type": "MSA",
        "centroid": [
          35.7567464,
          -78.4604412
        ],
        "property_count": 8053,
        "place_type": null
      }
    },
    {
      "id": "2",
      "type": "geo_boundary_search_result",
      "attributes": {
        "id": 2,
        "name": "Raleigh, NC",
        "description": "Raleigh city, North Carolina",
        "geo_type": "CensusPlace",
        "centroid": [
          35.835066941818184,
          -78.61623107999999
        ],
        "property_count": 3098,
        "place_type": "city"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
account_id
integer
required

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

Example:

9901947

​
query
string
default:*

The search query for geo boundary names. Supports partial matching and word start matching. Use '*' or omit to return all boundaries.

Example:

"raleigh"

​
geo_type
enum<string>[]

Filter results by geo boundary type(s). Can be a single value or an array of values. If not provided, all types are returned.

Available options:
MSA,
BespokeSubmarket,
CensusPlace,
ZipCode,
County,
Neighborhood
Example:
["MSA", "BespokeSubmarket"]
​
limit
integer
default:10

Maximum number of results to return. Must be between 1 and 1000.

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

10

​
geo_boundary_id
integer

Filter results to boundaries that intersect with this geo boundary ID.

Example:

123

​
intersecting_geometry
object

GeoJSON Polygon or MultiPolygon geometry object to filter results by spatial intersection.

Example:
{
  "type": "Polygon",
  "coordinates": [
    [
      [-78.663, 35.821],
      [-78.663, 35.85],
      [-78.623, 35.85],
      [-78.623, 35.821],
      [-78.663, 35.821]
    ]
  ]
}

Response

Successfully retrieved matching geo boundaries.

​
data
object[]
required

Array of geo boundary search results