Dataset composition
GET /v1/areas returns 349 areas in total. They are not all NYC neighborhoods:
Match the count to the scope you mean: 349 areas across NYC and Northern New
Jersey for the whole dataset, or 316 NYC neighborhoods and sub-areas for
NYC places only.
Hierarchy
Borough organizes its geography into a nested tree. Every area inGET /v1/areas
has an id, name, level, parentId, and slug. Levels run from 0 to 5, and
the depth varies by borough. Manhattan nests an extra sub-borough grouping that
the outer boroughs don’t.
In Manhattan, neighborhoods sit at level 3 under a level-2 grouping (e.g.
Upper East Side (140) → All Upper East Side (139) → Manhattan (100)). In
Brooklyn, Queens, the Bronx, and Staten Island, neighborhoods sit directly at
level 2 under the borough (e.g. Williamsburg (302) → Brooklyn (300)).
Borough IDs
There is no single “all NYC” area ID. To search the whole city, pass the five
borough IDs together (
areas=100,200,300,400,500). The level-0 container
NYC and NJ (1) also includes New Jersey. Area ID 1000000 is New Jersey,
not all of NYC.Using area filters
Pass area IDs to theareas parameter on the search endpoints:
Listing areas
GET /v1/areas accepts level, parentId, q, include, page, and
perPage (no borough parameter):
Popular Manhattan neighborhoods
Popular Brooklyn neighborhoods
Use
GET /v1/areas to retrieve all 349 areas with their IDs, levels, and parent
relationships. The endpoint is paginated: the default perPage is 10, so page
through the results (or raise perPage within your tier’s limit) to collect the
full set. See Dataset composition for what the 349 rows
contain.