REST API (Pull)

API Version: 1.0

Invoke REST API requests to our Incident Detection API endpoint and retrieve Incident Data according to your Rekor Command™ data consumption lifecycle.

The data includes a list of active incidents customized based on user preferences.

Credentials

To access the API, obtain a unique client_id and client_secret via registration. These credentials serve as the key authentication mechanism, establishing a secure and authorized connection between the client application and the Incidents API.

Base URL

All API requests should be made to the following base URL:

https://api.command.rekor.one

Authentication

To access the Incidents API, you need to authenticate using a Bearer Token.

Obtain the token by making a POST request using the obtained client_id and client_secret to the following endpoint:

Used to get an Authentication Token

POST https://api.command.rekor.one/v1/token

Use the obtained access_token in the Authorization header for subsequent requests.

An access_token is valid for 24 hours.

Request Body

Name	Type	Description
client_id*	String	The Unique identifier of the Client
client_secret*	String	The Secret of the Client

200: OK Success

{ 
   "access_token": "string", "token_type": "string" 
}

401: Unauthorized Invalid client_id and/or client_secret

500: Internal Server Error An Unknown Error has occurred

Get Incidents

The API responds with a list of active incident information, customized based on user preferences. We also provide detailed JSON Schema, if necessary.

Include the token obtained from the request in the authorization header using the "Bearer" scheme.

Used to get Incident information

GET https://api.command.rekor.one/v1/incidents

The API responds with a list of active incident information.

Headers

Name	Type	Description
Authorization*	String	Bearer your_access_token

200: OK Success

[
    {
        "id": String,
        "incidentType": String,
        "incidentSubType": String,
        "atmsId": String,
        "createdBy": String,
        "reportedBy": String,
        "confirmedBy": String,
        "updatedBy": String,
        "clearedBy": String,
        "clearedReason": String,
        "location": {
            "long": Double,
            "lat": Double
        },
        "state": String,
        "county": String,
        "city": String,
        "roadType": String,
        "corridor": String,
        "direction": String,
        "orientation": String,
        "crossroad": String,
        "mileMarker": String,
        "startTime": String,
        "confirmedTime": String,
        "updateTime": String,
        "endTime": String,
        "affectedLanes": [
            {
                "laneNumber": Int,
                "laneType": String,
                "isClosed": Boolean,
                "updatedTime": String
            }
        ],
        "isFullClosure": Boolean,
        "injuries": Int,
        "fatalities": Int,
        "estimatedEndTime": String,
        "estimatedDurationMin": Int,
        "involvedVehicles": [
            {
                "id": String,
                "state": String,
                "color": String,
                "make": String,
                "model": String,
                "type": String,
                "licensePlate": String
            }
        ],
        "notes": [
            {
                "note": String,
                "updateTime": String,
                "updateBy": String
            }
        ],
        "unitResponse": [
            {
                "respondedBy": String,
                 "unitType": String,
                 "unitId": String,
                 "status": String,
                 "updateTime": String,
                 "mitigationStartTime": String,
                 "mitigationEndTime": String,
                 "mitigationReasons": [String]
            }
        ],
        "involvedVehiclesCount": Int,
        "severity": String,
        "impact": Object
    }
]

500: Internal Server Error An Unknown Error has occurred

For the full Incident schema specification, including the supported types and properties, review the Schema Structure page.

Error Handling

In case of errors, the API will return appropriate HTTP status codes along with error details in the response body.