REST API

The Rekor Scout® API can be used to search for license plate data programmatically from any Scout web server (both cloud and self-hosted). Using this API you can search for plate groups, individual reads, and alerts. You can also retrieve the plate images directly from the agent. The endpoints for the Rekor Scout API are described below.

Search for ALPR plate results

GEThttps://cloud.openalpr.com/api/search/plate

Query parameters

Response

200400401

OK

Body

application/json

pkinteger

Unique integer ID for this plate

modelstring

Name of the data type

fieldsobject

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/api/search/plate?api_key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "pk": 0,
    "model": "text",
    "fields": {
      "agent_uid": "text",
      "best_confidence": 0,
      "best_plate": "text",
      "best_index": 0,
      "best_uuid": "text",
      "epoch_time_start": "text",
      "epoch_time_end": "text",
      "camera": 0,
      "camera_id": 0,
      "company": 0,
      "site": "text",
      "site_id": 0,
      "img_width": 0,
      "img_height": 0,
      "plate_x1": 0,
      "plate_y1": 0,
      "plate_x2": 0,
      "plate_y2": 0,
      "plate_x3": 0,
      "plate_y3": 0,
      "plate_x4": 0,
      "plate_y4": 0,
      "processing_time_ms": 0
    }
  }
]

Search among all possible candidate plate numbers

GEThttps://cloud.openalpr.com/api/search/platecandidate

Query parameters

Response

200400401

OK

Body

application/json

pkinteger

Unique integer ID for this plate

modelstring

Name of the data type

fieldsobject

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/api/search/platecandidate?api_key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "pk": 0,
    "model": "text",
    "fields": {
      "agent_uid": "text",
      "confidence": 0,
      "group": 0,
      "plate_number": "text",
      "uuid": "text",
      "epoch_time": "text",
      "camera": 0,
      "camera_id": 0,
      "company": 0,
      "site": "text",
      "site_id": 0,
      "plate_index": 0
    }
  }
]

Search for ALPR plate results

GEThttps://cloud.openalpr.com/api/search/alert

Query parameters

Response

200400401

OK

Body

application/json

pkinteger

Unique integer ID for this alert

modelstring

Name of the data type

fieldsobject

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/api/search/alert?api_key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "pk": 0,
    "model": "text",
    "fields": {
      "agent_uid": "text",
      "confidence": 0,
      "plate_group": 0,
      "plate_number": "text",
      "description": "text",
      "epoch_time": "text",
      "alert_group_name": 0,
      "alert_group": 0,
      "company": 0,
      "site": "text",
      "site_id": 0
    }
  }
]

Get detailed results for a plate record from a plate candidate

GEThttps://cloud.openalpr.com/api/detail/platecandidate/{group_id}

Path parameters

group_id*string

Query parameters

Response

200401404

OK

Body

application/json

pkinteger

Unique integer ID for this plate

modelstring

Name of the data type

fieldsobject

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/api/detail/platecandidate/{group_id}?api_key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "pk": 0,
  "model": "text",
  "fields": {
    "agent_uid": "text",
    "best_confidence": 0,
    "best_plate": "text",
    "best_index": 0,
    "best_uuid": "text",
    "epoch_time_start": "text",
    "epoch_time_end": "text",
    "camera": 0,
    "camera_id": 0,
    "company": 0,
    "site": "text",
    "site_id": 0,
    "img_width": 0,
    "img_height": 0,
    "plate_x1": 0,
    "plate_y1": 0,
    "plate_x2": 0,
    "plate_y2": 0,
    "plate_x3": 0,
    "plate_y3": 0,
    "plate_x4": 0,
    "plate_y4": 0,
    "processing_time_ms": 0
  }
}

List the agents registered with the webserver

GEThttps://cloud.openalpr.com/api/agents/

Query parameters

Response

200401404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/api/agents/?api_key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List the cameras registered with the webserver

GEThttps://cloud.openalpr.com/api/cameras/

Query parameters

Response

200401404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/api/cameras/?api_key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List the alert lists that are configured

GEThttps://cloud.openalpr.com/api/alert-lists/

Query parameters

Response

200401404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/api/alert-lists/?api_key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List the users that are associated with this account

GEThttps://cloud.openalpr.com/api/users/

Query parameters

Response

200401404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/api/users/?api_key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get an image for the requested agent and UUID. This will proxy the request to the remote agent.

GEThttps://cloud.openalpr.com/img/{agent_uid}/{image_uuid}

Path parameters

agent_uid*string

image_uuid*string

Query parameters

Response

200404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/img/{agent_uid}/{image_uuid}?api_key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get an image for the requested plate. This web service is served locally on the agent on port 8355. By default the local agent webservice is disabled, so you must first enable it in alprd.conf

GEThttps://cloud.openalpr.com/img/{image_uuid}.jpg

Path parameters

image_uuid*string

Query parameters

Response

200404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://cloud.openalpr.com/img/{image_uuid}.jpg', {
    method: 'GET',
    headers: {},
});
const data = await response.json();