Hoodkit Developer Platform

Build with neighborhood data

Use Hoodkit’s read-only JSON API to find places, understand geographic areas, locate transport, and retrieve property data.

Make your first request Browse Places API

Quickstart

All endpoints are under the versioned /api/v1 path and return JSON. Public endpoints require no authentication.

curl --get 'https://hoodsdk.com/api/v1/places/search.json?search_phrase=coffee&limit=5'

Conventions

JSON responses

Append .json or send Accept: application/json. Examples below use the suffix for clarity.

Cross-origin access

Requests to /api/* support CORS from any origin.

City filters

Supported endpoints accept city_uuids[] and city_names[]. Singular aliases are normalized too.

Errors

Validation and lookup failures use HTTP status codes. JSON errors generally have the shape {"error":"Message"}.

Authentication

Places, geography, transport, and property endpoints are public. The partner Websites API requires a token in the WEBSITES_API_TOKEN request header. Contact the Hoodkit team to request access.

Keep partner tokens on your server. Never expose them in browser JavaScript or public repositories.

GET /api/v1/launcher/search.json?q=coffee

Searches navigation and geographic records for command-palette style experiences. Searches data when q has at least two characters.

Query parameters

Name	Type	Required	Description
`q`	string	No	Search text. Data results begin at two characters.

Example request

curl --get 'https://hoodsdk.com/api/v1/launcher/search.json?q=coffee'

Example response 200 OK

{
  "navigation": [{"title": "Places", "url": "/places/all"}],
  "places": [{"id": 42, "name": "Example Cafe", "url": "/places/42"}],
  "neighborhoods": [],
  "districts": [],
  "cities": []
}

GET /api/v1/overview/show.json?latitude=40.7306&longitude=-73.9352

Returns the containing area, nearby places, and nearby transport stops in one request.

Query parameters

Name	Type	Required	Description
`latitude`	number	Yes	Latitude of the point.
`longitude`	number	Yes	Longitude of the point.
`radius`	integer	No	Search radius in miles. Defaults to 1.
`limit`	integer	No	Maximum nearby records. Defaults to 30.

Example request

curl --get 'https://hoodsdk.com/api/v1/overview/show.json?latitude=40.7306&longitude=-73.9352'

Example response 200 OK

{
  "area": {"id": 12, "name": "Greenpoint", "area_type": "Neighborhood"},
  "places": [{"id": 42, "name": "Example Cafe", "distance": 0.2}],
  "stops": [{"id": 9, "name": "Greenpoint Av", "transport_type": "subway"}]
}