Buildings

GET /v1/analytics/buildings

Returns building-level analytics and reference data for a specific address, including delivery counts, building characteristics, and time metrics.

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

Request

Query Parameters

Parameter	Type	Required?	Description
address	string	Yes	The building to analyze. Example: 123 Main St, San Francisco, CA 94105

Example Request

curl "https://api.core.doorstep.ai/v1/analytics/buildings?address=123 Main St, San Francisco, CA 94105" \
  -H "Authorization: Bearer $API_KEY"

Response

200

Building-level analytics for the requested address.

Response Body

Field	Type	Description
deliveryCount	integer	Total number of deliveries to the building.
elevationMethod	string	How floors are reached. One of: elevator, stairs, both, none.
deliveryTypes	object	Map of delivery type to delivery count.
timeMetrics	object	Median time metrics for the building, in seconds. See Time Metrics for each field.

All time values are in seconds.

Example Response

{
  "deliveryCount": 1842,
  "elevationMethod": "elevator",
  "deliveryTypes": {
    "doorstep": 1204,
    "threshold": 638
  },
  "timeMetrics": {
    "handoverTime": 180,
    "inBuildingTime": 95,
    "activeTime": 210,
    "walkingTime": 140
  }
}

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"
}

Common Applications

• Adjust stop time estimates based on address complexity
• Validate expected delivery type when reviewing disputes