Skip to main content
POST
Enumerate every Place of a category within a jurisdiction

Authorizations

Authorization
string
header
required

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

Body

application/json
categories
enum<string>[]

Place categories to enumerate, such as county or school_district.

Available options:
postal_code,
county,
municipality,
region,
country,
military_installation,
school_district
isoCodes
string[]

Jurisdiction codes to enumerate within, matched exactly (e.g. US-CA). Not hierarchical — "US" matches only the country record. A bare foreign code such as "JP" scopes overseas military installations. At most 60 codes per call, which is above the 53 needed to cover every US state and territory at once.

Maximum array length: 60
perPage
integer
default:25

Results per page. Default 25, maximum 100.

Required range: x <= 100
cursor
string

Opaque cursor from meta.nextCursor of the previous page. A cursor is bound to the filters that produced it and is rejected if you change them.

Response

A page of places

data
object[]
required
meta
object
required

Cursor pagination metadata for place enumeration.