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
}
'
import requests

url = "https://api.example.com/v1/crash-data/aggregate"

payload = {
"location": {
"latitude": 36.890333,
"longitude": -95.967285
},
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"radius_km": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
location: {latitude: 36.890333, longitude: -95.967285},
start_date: '2023-11-07T05:31:56Z',
end_date: '2023-11-07T05:31:56Z',
radius_km: 123
})
};

fetch('https://api.example.com/v1/crash-data/aggregate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/crash-data/aggregate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'location' => [
'latitude' => 36.890333,
'longitude' => -95.967285
],
'start_date' => '2023-11-07T05:31:56Z',
'end_date' => '2023-11-07T05:31:56Z',
'radius_km' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/crash-data/aggregate"

payload := strings.NewReader("{\n \"location\": {\n \"latitude\": 36.890333,\n \"longitude\": -95.967285\n },\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"radius_km\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/crash-data/aggregate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"location\": {\n \"latitude\": 36.890333,\n \"longitude\": -95.967285\n },\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"radius_km\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/crash-data/aggregate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"location\": {\n \"latitude\": 36.890333,\n \"longitude\": -95.967285\n },\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"radius_km\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "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
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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.