> ## Documentation Index
> Fetch the complete documentation index at: https://qwady.wiki/llms.txt
> Use this file to discover all available pages before exploring further.

# Areas & Neighborhoods

> Area IDs, hierarchy levels, and borough mapping across NYC and Northern New Jersey

## Dataset composition

`GET /v1/areas` returns **349 areas** in total. They are not all NYC neighborhoods:

| Group                                                       | Rows    |
| ----------------------------------------------------------- | ------- |
| NYC neighborhoods and sub-areas                             | 316     |
| NYC boroughs                                                | 5       |
| Northern New Jersey (region, municipalities, and sub-areas) | 26      |
| Administrative (`NYC and NJ` (1), `Unassigned` (9999999))   | 2       |
| **Total**                                                   | **349** |

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 in `GET /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.

| Level | Description                                                       | Example                                |
| ----- | ----------------------------------------------------------------- | -------------------------------------- |
| 0     | Top region container                                              | NYC and NJ (1)                         |
| 1     | Borough / region                                                  | Manhattan (100)                        |
| 2     | Sub-borough grouping (Manhattan) or neighborhood (outer boroughs) | All Downtown (102), Williamsburg (302) |
| 3     | Neighborhood (Manhattan)                                          | Upper East Side (140)                  |
| 4–5   | Sub-neighborhood                                                  | Hell's Kitchen (152)                   |

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

| Borough       | Area ID |
| ------------- | ------- |
| Manhattan     | 100     |
| Bronx         | 200     |
| Brooklyn      | 300     |
| Queens        | 400     |
| Staten Island | 500     |

<Note>
  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.
</Note>

## Using area filters

Pass area IDs to the `areas` parameter on the search endpoints:

```bash theme={null}
# Search Upper East Side
curl ".../v1/search/rentals?areas=140"

# Search multiple neighborhoods
curl ".../v1/search/rentals?areas=140,137,120"

# Search an entire borough
curl ".../v1/search/rentals?areas=100"
```

## Listing areas

`GET /v1/areas` accepts `level`, `parentId`, `q`, `include`, `page`, and
`perPage` (no `borough` parameter):

```bash theme={null}
# First page of areas — returns 10 rows by default, not all 349
curl ".../v1/areas"

# Page through the full set (perPage is capped by your tier)
curl ".../v1/areas?perPage=500&page=1"

# Only level-2 areas
curl ".../v1/areas?level=2"

# Direct children of a borough (e.g. Brooklyn's neighborhoods)
curl ".../v1/areas?parentId=300"

# Search areas by name
curl ".../v1/areas?q=williamsburg"
```

## Popular Manhattan neighborhoods

| Name               | ID  | Parent                    |
| ------------------ | --- | ------------------------- |
| Upper East Side    | 140 | All Upper East Side (139) |
| Upper West Side    | 137 | All Upper West Side (135) |
| Midtown            | 120 | All Midtown (119)         |
| Chelsea            | 115 | All Downtown (102)        |
| Greenwich Village  | 116 | All Downtown (102)        |
| East Village       | 117 | All Downtown (102)        |
| SoHo               | 107 | All Downtown (102)        |
| Tribeca            | 105 | All Downtown (102)        |
| Financial District | 104 | All Downtown (102)        |

## Popular Brooklyn neighborhoods

| Name               | ID  | Parent         |
| ------------------ | --- | -------------- |
| Williamsburg       | 302 | Brooklyn (300) |
| Park Slope         | 319 | Brooklyn (300) |
| DUMBO              | 307 | Brooklyn (300) |
| Brooklyn Heights   | 305 | Brooklyn (300) |
| Bushwick           | 313 | Brooklyn (300) |
| Greenpoint         | 301 | Brooklyn (300) |
| Bedford-Stuyvesant | 310 | Brooklyn (300) |
| Crown Heights      | 325 | Brooklyn (300) |

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](#dataset-composition) for what the 349 rows
contain.