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

get

/api/search/plate

Query parameters

api_keystringrequired

API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver

sitestring

unique ID for the site

cameranumber

unique camera number

startstring

Start time in ISO 8601 format. At least start or end must be defined.

endstring

End time in ISO 8601 format. At least start or end must be defined.

platestring

Plate Number to search for

topnnumber

Maximum number of results to return

orderstring

Order can be either desc or asc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/api/search/plate?api_key=text'

200

400

401

200

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

OK

Search among all possible candidate plate numbers

get

/api/search/platecandidate

Query parameters

api_keystringrequired

API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver

sitestring

unique ID for the site

cameranumber

unique camera number

startstring

Start time in ISO 8601 format. At least start or end must be defined.

endstring

End time in ISO 8601 format. At least start or end must be defined.

platestring

Plate Number to search for

topnnumber

Maximum number of results to return

orderstring

Order can be either desc or asc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/api/search/platecandidate?api_key=text'

200

400

401

200

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

OK

Search for ALPR plate results

get

/api/search/alert

Query parameters

api_keystringrequired

API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver

sitestring

unique ID for the site

cameranumber

unique camera number

startstring

Start time in ISO 8601 format. At least start or end must be defined.

endstring

End time in ISO 8601 format. At least start or end must be defined.

platestring

Plate Number to search for

topnnumber

Maximum number of results to return

orderstring

Order can be either desc or asc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/api/search/alert?api_key=text'

200

400

401

200

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

OK

Get detailed results for a plate record from a plate candidate

get

/api/detail/platecandidate/{group_id}

Path parameters

group_idstringrequired

Query parameters

api_keystringrequired

API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/api/detail/platecandidate/{group_id}?api_key=text'

200

401

404

200

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

OK

List the agents registered with the webserver

get

/api/agents/

Query parameters

api_keystringrequired

API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/api/agents/?api_key=text'

200

401

404

200

No body

OK

List the cameras registered with the webserver

get

/api/cameras/

Query parameters

api_keystringrequired

API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/api/cameras/?api_key=text'

200

401

404

200

No body

OK

List the alert lists that are configured

get

/api/alert-lists/

Query parameters

api_keystringrequired

API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/api/alert-lists/?api_key=text'

200

401

404

200

No body

OK

List the users that are associated with this account

get

/api/users/

Query parameters

api_keystringrequired

API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/api/users/?api_key=text'

200

401

404

200

No body

OK

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

get

/img/{agent_uid}//{image_uuid}

Path parameters

agent_uidstringrequired

image_uuidstringrequired

Query parameters

api_keystringrequired

API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver

xstring

X coordinate for cropping.

ystring

y coordinate for cropping.

widthstring

width coordinate for cropping.

heightstring

height coordinate for cropping.

max_widthstring

Resizes the image on the agent to a maximum width (in pixels) before transmitting

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/img/{agent_uid}/{image_uuid}?api_key=text'

200

404

200

No body

OK

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

get

/img/{image_uuid}.jpg

Path parameters

image_uuidstringrequired

Query parameters

xstring

X coordinate for cropping.

ystring

y coordinate for cropping.

widthstring

width coordinate for cropping.

heightstring

height coordinate for cropping.

max_widthstring

Resizes the image on the agent to a maximum size before transmitting

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud.openalpr.com/img/{image_uuid}.jpg'

200

404

200

No body

OK