Skip to main content
GET
List areas and neighborhoods

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
perPage
integer
default:10

Results per page. Maximum depends on tier: Free=10, Starter=50, Pro/Business=500.

Required range: 1 <= x <= 500
level
integer

Area hierarchy level (0 = NYC top container, 1 = borough, 2-5 = neighborhood; Manhattan neighborhoods are level 3, outer-borough neighborhoods level 2).

Required range: 0 <= x <= 5
parentId
integer

Filter by parent area ID (100=Manhattan, 200=Bronx, 300=Brooklyn, 400=Queens, 500=Staten Island)

q
string

Case-insensitive area name or slug lookup. Exact name matches are returned first, followed by broader suggestions.

Minimum string length: 1
include
enum<string>

Include optional boundary data in each area record.

Available options:
boundary

Response

List of areas

data
object[]
meta
object