Skip to main content
POST
/
v1
/
crash-data
/
aggregate
Get Aggregated Crash Data
curl --request POST \
  --url https://api.example.com/v1/crash-data/aggregate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location": {
    "latitude": 36.890333,
    "longitude": -95.967285
  },
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "radius_km": 123
}
'
{
  "latitude": 123,
  "longitude": 123,
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "radius_km": 123,
  "total_crashes": 123,
  "total_injuries": 123,
  "total_fatalities": 123,
  "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
GPS Coordinates · object
required

Address or GPS coordinates to center the aggregation on.

​
start_date
string<date-time>
required

Start date of the aggregation period.

Example:

"2020-01-01"

​
end_date
string<date-time>
required

End date of the aggregation period.

Example:

"2021-12-31"

​
radius_km
number
required

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

Required range: x <= 500
Example:

50

Response

Successful Response

​
latitude
number
required

Latitude of the central location.

Example:

37.7749

​
longitude
number
required

Longitude of the central location.

Example:

-104.9903

​
start_date
string<date-time>
required

Start date of the aggregation.

Example:

"2020-01-01"

​
end_date
string<date-time>
required

End date of the aggregation.

Example:

"2021-12-31"

​
radius_km
number
required

Distance in kilometers from the central location.

Example:

50

​
total_crashes
integer
required

Total number of crashes.

Example:

110

​
total_injuries
integer
required

Total number of injuries.

Example:

10

​
total_fatalities
integer
required

Total number of fatalities.

Example:

1

​
incomplete_coverage
boolean
required

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