Doorstep API

Programmatic access to delivery analytics, geospatial map data, and Doorstep Go links: volumes, timing metrics, building and address details, and signed delivery links.

QuickstartMake your first request →Pull total delivery volume for an address in a single authenticated call.

Base URL

https://api.core.doorstep.ai

Getting Started

1. Get an API key. Reach out to your Doorstep account team to have a key issued for your organization.
2. Authenticate. Send the key as a Bearer token on every request:

   Authorization: Bearer <YOUR_TOKEN>

3. Make a request. Call an endpoint and read the JSON response:

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

What You Can Do

VolumeTotal delivery counts for an address.Delivery TimeTiming metrics for a building, such as handover and walking time.Building AnalyticsBuilding-level reference data and delivery metrics.AddressesBuilding polygons, entrances, parking zones, and elevation access points.Link GenerationSecure, signed links to the Doorstep Go application for a delivery location.

---

Reference

Timestamps

All from / to parameters and response timestamps use epoch seconds (Unix time, not milliseconds).

Comma-Separated Filters

Parameters that accept multiple values are passed as comma-separated strings:

deliveryType=doorstep,threshold

Delivery Types

Value	Description
doorstep	Delivered to the door
threshold	Left at the building entrance
curbside	Curbside delivery
vehicle_handoff	Handed off at the vehicle

timeFrame Values

Value	Covers
day	Last 24 hours
week	Last 7 days
month	Last 30 days
3m	Last 3 months
ytd	Year to date
year	Last 365 days
all	All time

from / to (epoch seconds) override timeFrame when provided.

Time Metrics

Returned by the Delivery Time and Building Analytics endpoints. All values are in seconds.

Metric	Description
handoverTime	Time from geofence entry to drop-off
totalTime	Time from geofence entry to geofence exit
activeTime	Time from parking to drop-off
walkingTime	Time from parking to car return
inBuildingTime	Time spent inside the building

Doorstep Go Link Parameters

Optional query parameters you can append to a generated Doorstep Go link to control which waypoints and map controls are shown. By default every waypoint is shown and the map opens in light mode.

Waypoints

All waypoints are enabled by default. Disable one by setting it to false.

Parameter	Default	Description
parking	true	parking=false hides the parking waypoint and its zone.
elevation	true	elevation=false hides both the elevator and staircase icons.

The entrance waypoint cannot be disabled.

Base Map

Sets the default base map. Each accepts the bare flag (e.g. dark) or =true.

Parameter	Description
light	Light base map. Used by default when no base-map parameter is passed.
dark	Dark base map. Pass dark or dark=true.
satellite	Satellite base map. Pass satellite or satellite=true.

If multiple base-map parameters are passed, satellite takes precedence.

Map Styles Control

Parameter	Default	Description
styles	true	styles=false hides the map layers icon. This only hides the control and does not change the base map — e.g. dark=true&styles=false shows dark mode with the layers icon hidden.

Need Help?

Need help? Reach out to your Doorstep account team for access, questions, or integration support.