Loading...
API reference

Geography

Navigate Hoodkit’s city, district, neighborhood, and geospatial area hierarchy.

GET /api/v1/cities.json

Lists all supported cities.

Example request

curl --get 'https://hoodsdk.com/api/v1/cities.json'

Example response 200 OK

[
  {
    "uuid": "city-uuid",
    "name": "New York",
    "description": "The five boroughs of New York City.",
    "slug": "new-york",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z",
    "primary_image": {"small": "https://cdn.example.com/small.jpg", "large": "https://cdn.example.com/large.jpg"}
  }
]
GET /api/v1/districts.json?with_neighborhoods=true

Lists districts, optionally embedding their neighborhoods.

Query parameters

Name Type Required Description
with_neighborhoods boolean No Include neighborhoods for each district.
city_uuids[] / city_names[] array No Filter by cities. Unknown cities return 404.

Example request

curl --get 'https://hoodsdk.com/api/v1/districts.json?with_neighborhoods=true'

Example response 200 OK

[
  {
    "id": 2,
    "uuid": "district-uuid",
    "name": "Brooklyn",
    "slug": "brooklyn",
    "city": {"uuid": "city-uuid", "name": "New York"},
    "neighborhoods": [{"uuid": "neighborhood-uuid", "name": "Greenpoint"}]
  }
]