Skip to main content
GET
/
areas
List areas and neighborhoods
curl --request GET \
  --url https://borough.qwady.app/v1/areas \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "level": 123,
      "parentId": 123,
      "slug": "<string>",
      "encodedBoundary": "<string>"
    }
  ],
  "meta": {
    "dataAge": "2023-11-07T05:31:56Z",
    "source": "cached",
    "freshnessThreshold": 123,
    "refreshTriggered": true,
    "total": 123,
    "page": 123,
    "perPage": 123,
    "links": {
      "self": "<string>",
      "first": "<string>",
      "last": "<string>",
      "prev": "<string>",
      "next": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
level
enum<integer>

Filter by hierarchy level: 0=borough, 1=sub-borough, 2=neighborhood

Available options:
0,
1,
2
​
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