List Areas
Returns the area hierarchy: 349 areas across NYC and Northern New Jersey, of which 316 are NYC neighborhoods and sub-areas and 5 are boroughs. Optionally filter by level or parent area.
This route is paginated: perPage defaults to 10 (and is capped at 10 on
the Free tier), so a single unfiltered call returns 10 of 349 rows. Read
meta.total and page through, or raise perPage on a paid tier.
Tier: Free+
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Page number (1-indexed)
x >= 1Results per page. Maximum depends on tier: Free=10, Starter=50, Pro/Business=500.
1 <= x <= 500Area hierarchy level (0 = NYC top container, 1 = borough, 2-5 = neighborhood; Manhattan neighborhoods are level 3, outer-borough neighborhoods level 2).
0 <= x <= 5Filter by parent area ID (100=Manhattan, 200=Bronx, 300=Brooklyn, 400=Queens, 500=Staten Island)
Case-insensitive area name or slug lookup. Exact name matches are returned first, followed by broader suggestions.
1Include optional boundary data in each area record.
boundary