Addresses

GET /v1/map/addresses

Retrieves detailed metadata for a specific address, including the building polygon, entrance locations, parking zones, and elevation access points.

Requires an API key sent as a Bearer token in the Authorization header.

Request

Query Parameters

Parameter	Type	Required?	Description
address	string	Yes	The full address string to query. Example: 550 W 54th St, New York, NY, 10019

Example Request

curl "https://api.core.doorstep.ai/v1/map/addresses?address=550 W 54th St, New York, NY, 10019" \
  -H "Authorization: Bearer $API_KEY"

Response

200

Metadata for the requested address.

Response Body

Field	Type	Description
_id	string	Unique identifier for the address.
address	object	The resolved address.
address.normalized	string	The base address after it has been cleaned up and standardized.
address.unit	string or null	The unit, if one was found.
polygon	GeoJSON Polygon	The building footprint.
entrances	array of GeoJSON Point Features	The building's entrances. Each entrance may set primary (the building's main entry) and preferred (the best entry for this address).
parking	GeoJSON Feature	Parking zone linked to the preferred entrance.
parking.properties.streets	GeoJSON Polygon	The parking area along the street.
parking.properties.center	GeoJSON Point	Center point of the parking zone.
parking.properties.covered	boolean	Whether the parking is covered.
elevations	array of GeoJSON Point Features	Elevation access points linked to the preferred entrance. Each sets method, either elevator or staircase.

Coordinate arrays in the example below are shortened for readability.

Example Response

{
  "_id": "69351bf670ca5a2ce091b288",
  "address": {
    "normalized": "550 W 54th St, New York, NY, 10019",
    "unit": null
  },
  "polygon": {
    "type": "Polygon",
    "coordinates": [
      [
        [-73.9927208, 40.7682455],
        [-73.9927968, 40.7681424],
        [-73.9930703, 40.7677714],
        [-73.9927208, 40.7682455]
      ]
    ]
  },
  "entrances": [
    {
      "type": "Feature",
      "properties": {
        "_id": "e7fbbb63-0f48-4cb1-9371-918c7a83010b"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-73.99268101925855, 40.767606822432576]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "_id": "3bada372-45da-4257-8e88-28d8ca857145",
        "primary": true,
        "preferred": true
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-73.99158151537485, 40.76776374185844]
      }
    }
  ],
  "parking": {
    "type": "Feature",
    "properties": {
      "_id": "0eb8af9c-70e2-4200-9c8f-c5dc8d4a0eba",
      "streets": {
        "type": "Polygon",
        "coordinates": [
          [
            [-73.99119735960485, 40.767741205467516],
            [-73.99121305166163, 40.76772180985146],
            [-73.99119735960485, 40.767741205467516]
          ]
        ]
      },
      "center": {
        "type": "Point",
        "coordinates": [-73.99147619492871, 40.76785816458687]
      },
      "covered": false
    },
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [-73.99115967045111, 40.767850265478216],
          [-73.99116148392595, 40.76782753606264],
          [-73.99115967045111, 40.767850265478216]
        ]
      ]
    }
  },
  "elevations": [
    {
      "type": "Feature",
      "properties": {
        "_id": "1d219d20-0749-4122-b3c2-f4147b7afbaa",
        "method": "elevator"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-73.99199627495157, 40.767693999789486]
      }
    }
  ]
}

400

A required parameter is missing or invalid. For example, address was not provided.

{
  "status": 400,
  "code": "bad_request",
  "message": "Address is required"
}

401

The API key is missing or invalid.

{
  "status": 401,
  "code": "unauthorized",
  "message": "Token Invalid"
}

404

No building was found for the requested address.

{
  "status": 404,
  "code": "not_found",
  "message": "Building with the given address was not found"
}

500

Something went wrong on our end. Try the request again later.

{
  "status": 500,
  "code": "internal_server_error",
  "message": "Internal Server Error"
}