esc
Loading...
to navigate
to select
API reference

Properties

Search normalized New York City addresses, retrieve BOBA property records, and list known building units.

GET /api/v1/property_addresses/unified_address_id.json?address=123%20example

Compatibility alias for property address search. It returns the same list and accepts the same parameters.

Query parameters

Name Type Required Description
address string Yes Partial street address.
limit integer No Maximum matches. Defaults to 10.

Example request

curl --get 'https://hoodsdk.com/api/v1/property_addresses/unified_address_id.json?address=123%20example'

Example response 200 OK

[
  {
    "address": "123 EXAMPLE STREET, BROOKLYN",
    "unified_address_id": "100001"
  }
]
GET /api/v1/property_addresses/exact_search.json?address=123%20EXAMPLE%20STREET

Looks up one exact normalized address. A miss returns 200 with an empty response body.

Query parameters

Name Type Required Description
address string Yes Complete address to match.

Example request

curl --get 'https://hoodsdk.com/api/v1/property_addresses/exact_search.json?address=123%20EXAMPLE%20STREET'

Example response 200 OK

{
  "address": "123 EXAMPLE STREET, BROOKLYN",
  "unified_address_id": "100001"
}
GET /api/v1/properties/autocomplete.json?q=123%20example

Returns up to ten property suggestions. Queries shorter than two characters return an empty results array.

Query parameters

Name Type Required Description
q string Yes Address query of at least two characters.

Example request

curl --get 'https://hoodsdk.com/api/v1/properties/autocomplete.json?q=123%20example'

Example response 200 OK

{
  "results": [
    {
      "address": "123 EXAMPLE STREET, BROOKLYN",
      "borough": "Brooklyn",
      "zipcode": "11222",
      "block": "2500",
      "lot": "15",
      "unified_address_id": "100001",
      "url": "/property/properties/boba:100001"
    }
  ]
}
GET /api/v1/properties/boba:100001.json

Retrieves a property by a typed identifier. Currently the supported format is boba: followed by a unified address ID.

Returns 400 for an unsupported identifier type and 404 when the BOBA record is not found.

Example request

curl --get 'https://hoodsdk.com/api/v1/properties/boba:100001.json'

Example response 200 OK

{
  "id": 7,
  "address": "123 EXAMPLE STREET, BROOKLYN",
  "borough": "Brooklyn",
  "zipcode": "11222",
  "block": "2500",
  "lot": "15",
  "unified_address_id": "100001",
  "search_addresses": ["123 EXAMPLE ST"],
  "pluto_address": "123 EXAMPLE STREET",
  "latitude": 40.7241,
  "longitude": -73.9501
}
GET /api/v1/building_units.json?unified_address_id=100001

Lists units for a building resolved by unified address ID or address line.

Returns 400 when neither lookup parameter is supplied and 404 when no building is found.

Query parameters

Name Type Required Description
unified_address_id string No Preferred building lookup key.
address_line_one string No Fallback exact building address. One lookup key is required.

Example request

curl --get 'https://hoodsdk.com/api/v1/building_units.json?unified_address_id=100001'

Example response 200 OK

[
  {
    "beds": 2,
    "full_baths": 1,
    "half_baths": 0,
    "square_feet": 850,
    "images": [],
    "floor_plan": "https://cdn.example.com/floor-plan.jpg",
    "available_for_rent": true,
    "amenities": ["Dishwasher"],
    "apartment": "2A",
    "price": 4200,
    "lease_options": ["12 months"]
  }
]