Skip to main content
GET
/
areas
List areas and neighborhoods
curl --request GET \
  --url https://borough.qwady.com/v1/areas \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "level": 123,
      "parentId": 123,
      "slug": "<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

Polar.sh license key. Format: BOROUGH_<uuid>

Query Parameters

​
level
enum<integer>

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

Available options:
0,
1,
2
​
borough
integer

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

Response

200 - application/json

List of areas

​
data
object[]
​
meta
object