Websites API | Hoodkit Developers

Authentication

Every request must send the partner token in the WEBSITES_API_TOKEN header. Missing or invalid tokens return 401 Unauthorized with an empty body.

This API is intended for server-to-server use. Contact the Hoodkit team to provision or rotate a token.

GET /api/v1/websites/buildings.json?limit=100&offset=0

Returns a paginated building feed with optional inventory and geographic filters.

Query parameters

Name	Type	Required	Description
`with_available_listings`	boolean	No	Only buildings joined to available listings.
`uuids[]`	array	No	Fetch specific building UUIDs. Bypasses limit and offset.
`limit`	integer	No	Page size, from 1 to 200. Defaults to 100.
`offset`	integer	No	Record offset. Defaults to 0.
`neighborhood_uuids[]`	array	No	Filter by neighborhoods.
`district_uuids[]`	array	No	Filter by districts.
`city_uuids[]`	array	No	Filter by cities.

Example request

curl --get 'https://hoodsdk.com/api/v1/websites/buildings.json?limit=100&offset=0' \
  --header 'WEBSITES_API_TOKEN: YOUR_TOKEN'

Example response 200 OK

{
  "limit": 100,
  "offset": 0,
  "total_count": 1,
  "buildings": [
    {
      "id": 101,
      "uuid": "building-uuid",
      "latitude": 40.7241,
      "longitude": -73.9501,
      "full_address": "123 Example Street, Brooklyn, NY 11222",
      "address_line_one": "123 Example Street",
      "zip_code": "11222",
      "scr_building_token": "building-token",
      "unified_address_id": "100001",
      "neighborhood": {"name": "Greenpoint", "uuid": "neighborhood-uuid"},
      "district": {"name": "Brooklyn", "uuid": "district-uuid"},
      "city": {"name": "New York", "uuid": "city-uuid"}
    }
  ]
}

GET /api/v1/websites/listings.json?price_from=3000&beds=2&sort_by=price_asc

Returns a filtered and paginated listing feed with building and matched unit floor-plan data.

Query parameters

Name	Type	Required	Description
`limit`	integer	No	Page size, from 1 to 200. Defaults to 100.
`offset`	integer	No	Record offset. Defaults to 0.
`building_uuids[]`	array	No	Filter by buildings.
`neighborhood_uuids[] / district_uuids[] / city_uuids[]`	array	No	Filter by geography.
`price_from / price_to`	number	No	Inclusive price range.
`beds`	number	No	Exact bedroom count.
`baths`	number	No	Exact full bathroom count.
`amenities[]`	array	No	Require all supplied amenities.
`sort_by`	string	No	price_asc, price_desc, or unit. Default ordering diversifies inventory.

Example request

curl --get 'https://hoodsdk.com/api/v1/websites/listings.json?price_from=3000&beds=2&sort_by=price_asc' \
  --header 'WEBSITES_API_TOKEN: YOUR_TOKEN'

Example response 200 OK

{
  "limit": 100,
  "offset": 0,
  "total_count": 1,
  "listings": [
    {
      "id": 501,
      "unit": "2A",
      "price": 4200,
      "beds": 2,
      "full_baths": 1,
      "address_line_one": "123 Example Street",
      "unified_address_id": "100001",
      "amenities": {"Apartment": ["Dishwasher"], "Building": ["Laundry"]},
      "floor_plan": "https://cdn.example.com/floor-plan.jpg"
    }
  ]
}

GET /api/v1/websites/listings/501/similar.json?limit=10

Finds inventory similar to a source listing.

Query parameters

Name	Type	Required	Description
`building_uuids[]`	array	No	Restrict candidates by building UUID.
`building_ids[]`	array	No	Alternative internal building IDs.
`strict_neighborhood`	boolean	No	Require the same neighborhood. Defaults to true.
`limit`	integer	No	Maximum matches. Defaults to 10, maximum 200.

Example request

curl --get 'https://hoodsdk.com/api/v1/websites/listings/501/similar.json?limit=10' \
  --header 'WEBSITES_API_TOKEN: YOUR_TOKEN'

Example response 200 OK

{
  "listings": [
    {
      "id": 502,
      "unit": "3B",
      "price": 4300,
      "beds": 2,
      "full_baths": 1,
      "address_line_one": "123 Example Street",
      "unified_address_id": "100001"
    }
  ]
}

GET /api/v1/websites/listings/filters.json?building_uuids[]=building-uuid

Returns available price bounds and amenities for all listings or a selected building set.

Query parameters

Name	Type	Required	Description
`building_uuids[]`	array	No	Restrict filter values by building UUID.
`building_ids[]`	array	No	Alternative internal building IDs.

Example request

curl --get 'https://hoodsdk.com/api/v1/websites/listings/filters.json?building_uuids[]=building-uuid' \
  --header 'WEBSITES_API_TOKEN: YOUR_TOKEN'

Example response 200 OK

{
  "filters": {
    "price": {"min": 2200, "max": 9500},
    "amenities": {
      "Apartment": ["Dishwasher"],
      "Building": ["Doorman", "Laundry"]
    }
  }
}