LogoLogo
Buy SoftwareBuy HardwareOpen a ticket
Rekor Scout®
Rekor Scout®
  • 🌟Getting Started
    • Overview
    • Additional ALPR and Vehicle Recognition Products
    • Countries and Regions Supported
    • Vehicle Characteristics Supported
    • Create an Account
    • Subscriptions and Licensing
  • 🧠Agent
    • System Requirements
    • Benchmarking
    • Installation
    • License Registration
    • Set Data Destination
    • Connect to Cameras
    • Configuration
      • Agent Properties
      • Camera Streams
      • NVIDIA GPU Acceleration
      • Restarting the Agent
  • 📹Camera Configuration
    • Camera Placement Guide
    • Lighting
    • Camera Positioning
    • Pixels on Target
    • Camera Image Settings
  • 🕸️Web Server
    • Overview
    • Cloud
    • Self-Hosted
    • Configuring Agents
    • REST API
  • 🖥️Dashboard
    • Overview
    • Account Settings
    • Quick Search
    • Quick View Panels
    • Latest Reads (“Most Recent Plate Groups”)
    • Alerts List
    • Top Sites of the Week
    • Dispatch Map
    • Video Review
    • Statistics
    • Analytic Reports
    • Advanced Search
    • Rekor CarCheck®
    • Search Audit
    • Guides and Support
    • Billing and Subscriptions
      • Change Your Plan
      • Update Billing Address
      • Update Payment Method
      • Review Billing History
      • Cancel Your Subscription
    • Configuration
      • Alerts
      • Agents
      • Licensed Agents
      • WebHooks
      • User Management
      • Integrations
  • 🔗Application Integration
    • Overview
    • Integrating with the Agent
    • Receiving HTTP POSTs
    • Pulling from the Queue
    • JSON Plate Results
    • JSON Group Results
    • JSON Heartbeat
    • Local Image Retrieval
Powered by GitBook
LogoLogo

Platforms

  • Rekor Discover® for Urban Mobility
  • Rekor Command® for Transportation
  • Rekor Scout® for Public Safety

Systems

  • Rekor Edge Flex™ (Classificaiton)
  • Rekor Edge Max™ (Classification)
  • Rekor Edge Pro (ALPR)
  • Rekor Edge Max™ (ALPR)

Developers

  • Vehicle Recognition SDK
  • Rekor CarCheck®
  • Rekor AutoNotice™

Resources

  • About Us
  • Customer Stories
  • Newsroom
  • Help Center

© 2025 Rekor Systems, Inc. All Rights Reserved.

On this page

Was this helpful?

  1. Web Server

REST API

PreviousConfiguring AgentsNextOverview

Last updated 1 year ago

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.

🕸️
get

Search for ALPR plate results

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

sitestringOptional

unique ID for the site

cameranumberOptional

unique camera number

startstringOptional

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

endstringOptional

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

platestringOptional

Plate Number to search for

topnnumberOptional

Maximum number of results to return

orderstringOptional

Order can be either desc or asc

Responses
200
OK
application/json
400
Bad input provided. Adjust the query parameters and try again. The text accompanying the error will provide more detail about which query parameters are incorrect.
401
Unauthorized. You must either provide a valid api_key or have a logged in session
get
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
    }
  }
]
get

Search among all possible candidate plate numbers

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

sitestringOptional

unique ID for the site

cameranumberOptional

unique camera number

startstringOptional

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

endstringOptional

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

platestringOptional

Plate Number to search for

topnnumberOptional

Maximum number of results to return

orderstringOptional

Order can be either desc or asc

Responses
200
OK
application/json
400
Bad input provided. Adjust the query parameters and try again. The text accompanying the error will provide more detail about which query parameters are incorrect.
401
Unauthorized. You must either provide a valid api_key or have a logged in session
get
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
    }
  }
]
get

Search for ALPR plate results

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

sitestringOptional

unique ID for the site

cameranumberOptional

unique camera number

startstringOptional

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

endstringOptional

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

platestringOptional

Plate Number to search for

topnnumberOptional

Maximum number of results to return

orderstringOptional

Order can be either desc or asc

Responses
200
OK
application/json
400
Bad input provided. Adjust the query parameters and try again. The text accompanying the error will provide more detail about which query parameters are incorrect.
401
Unauthorized. You must either provide a valid api_key or have a logged in session
get
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

Get detailed results for a plate record from a plate candidate

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
200
OK
application/json
401
Unauthorized. You must either provide a valid api_key or have a logged in session
404
The requested ID was not found
get
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
  }
}
get

List the agents registered with the webserver

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
200
OK
401
Unauthorized. You must either provide a valid api_key or have a logged in session
404
The requested ID was not found
get
GET /api/agents/ HTTP/1.1
Host: cloud.openalpr.com
Accept: */*

No content

get

List the cameras registered with the webserver

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
200
OK
401
Unauthorized. You must either provide a valid api_key or have a logged in session
404
The requested ID was not found
get
GET /api/cameras/ HTTP/1.1
Host: cloud.openalpr.com
Accept: */*

No content

get

List the alert lists that are configured

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
200
OK
401
Unauthorized. You must either provide a valid api_key or have a logged in session
404
The requested ID was not found
get
GET /api/alert-lists/ HTTP/1.1
Host: cloud.openalpr.com
Accept: */*

No content

get

List the users that are associated with this account

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
200
OK
401
Unauthorized. You must either provide a valid api_key or have a logged in session
404
The requested ID was not found
get
GET /api/users/ HTTP/1.1
Host: cloud.openalpr.com
Accept: */*

No content

get

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

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

xstringOptional

X coordinate for cropping.

ystringOptional

y coordinate for cropping.

widthstringOptional

width coordinate for cropping.

heightstringOptional

height coordinate for cropping.

max_widthstringOptional

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

Responses
200
OK
404
not found
get
GET /img/{agent_uid}/{image_uuid} HTTP/1.1
Host: cloud.openalpr.com
Accept: */*

No content

get

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

Path parameters
image_uuidstringRequired
Query parameters
xstringOptional

X coordinate for cropping.

ystringOptional

y coordinate for cropping.

widthstringOptional

width coordinate for cropping.

heightstringOptional

height coordinate for cropping.

max_widthstringOptional

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

Responses
200
OK
404
not found
get
GET /img/{image_uuid}.jpg HTTP/1.1
Host: cloud.openalpr.com
Accept: */*

No content

  • GET/api/search/plate
  • GET/api/search/platecandidate
  • GET/api/search/alert
  • GET/api/detail/platecandidate/{group_id}
  • GET/api/agents/
  • GET/api/cameras/
  • GET/api/alert-lists/
  • GET/api/users/
  • GET/img/{agent_uid}/{image_uuid}
  • GET/img/{image_uuid}.jpg