Skip to main content
POST
/
v1
/
crash-data
/
aggregate
{
  "latitude": 37.7749,
  "longitude": -104.9903,
  "start_date": "2020-01-01",
  "end_date": "2021-12-31",
  "radius_km": 50,
  "total_crashes": 110,
  "total_injuries": 10,
  "total_fatalities": 1,
  "incomplete_coverage": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
location
object
required

Address or GPS coordinates to center the aggregation on.

​
start_date
string<date-time>
required

Start date of the aggregation period.

Examples:

"2020-01-01"

​
end_date
string<date-time>
required

End date of the aggregation period.

Examples:

"2021-12-31"

​
radius_km
number
required

Distance in kilometers from the location for aggregation (1-500 km).

Required range: 1 < x <= 500
Examples:

50

Response

Successful Response

​
latitude
number
required

Latitude of the central location.

Examples:

37.7749

​
longitude
number
required

Longitude of the central location.

Examples:

-104.9903

​
start_date
string<date-time>
required

Start date of the aggregation.

Examples:

"2020-01-01"

​
end_date
string<date-time>
required

End date of the aggregation.

Examples:

"2021-12-31"

​
radius_km
number
required

Distance in kilometers from the central location.

Examples:

50

​
total_crashes
integer
required

Total number of crashes.

Examples:

110

​
total_injuries
integer
required

Total number of injuries.

Examples:

10

​
total_fatalities
integer
required

Total number of fatalities.

Examples:

1

​
incomplete_coverage
boolean
required

A warning if any states without available data are within the provided radius.