REST API
Last updated
Was this helpful?
Rekor Scout®
Last updated
Was this helpful?
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
API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver
unique ID for the site
unique camera number
Start time in ISO 8601 format. At least start or end must be defined.
End time in ISO 8601 format. At least start or end must be defined.
Plate Number to search for
Maximum number of results to return
Order can be either desc or asc
GET /api/search/plate HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
[
{
"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
}
}
]Search among all possible candidate plate numbers
API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver
unique ID for the site
unique camera number
Start time in ISO 8601 format. At least start or end must be defined.
End time in ISO 8601 format. At least start or end must be defined.
Plate Number to search for
Maximum number of results to return
Order can be either desc or asc
GET /api/search/platecandidate HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
[
{
"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
}
}
]Search for ALPR plate results
API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver
unique ID for the site
unique camera number
Start time in ISO 8601 format. At least start or end must be defined.
End time in ISO 8601 format. At least start or end must be defined.
Plate Number to search for
Maximum number of results to return
Order can be either desc or asc
GET /api/search/alert HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
[
{
"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
}
}
]Get detailed results for a plate record from a plate candidate
API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver
GET /api/detail/platecandidate/{group_id} HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
{
"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
}
}List the agents registered with the webserver
API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver
GET /api/agents/ HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
No content
List the cameras registered with the webserver
API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver
GET /api/cameras/ HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
No content
List the alert lists that are configured
API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver
GET /api/alert-lists/ HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
No content
List the users that are associated with this account
API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver
GET /api/users/ HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
No content
Get an image for the requested agent and UUID. This will proxy the request to the remote agent.
API Key used for authentication. This can be generated for each user by going to /account/my_account on the webserver
X coordinate for cropping.
y coordinate for cropping.
width coordinate for cropping.
height coordinate for cropping.
Resizes the image on the agent to a maximum width (in pixels) before transmitting
GET /img/{agent_uid}/{image_uuid} HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
No content
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
X coordinate for cropping.
y coordinate for cropping.
width coordinate for cropping.
height coordinate for cropping.
Resizes the image on the agent to a maximum size before transmitting
GET /img/{image_uuid}.jpg HTTP/1.1
Host: cloud.openalpr.com
Accept: */*
No content
