NAV Navbar
shell ruby python javascript csharp php java cpp

Introduction

Welcome to the Plate Recognizer API! You can use our API to access our API endpoints, which can read license plates from images. For detailed instructions on how to install the SDK, go here.

We have multiple language bindings. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

Plate Recognizer API is only available to registered users. You first have to register and get an API key. It has to be included in all API calls. The HTTP headers must contain:

Authorization: Token API_TOKEN

License Plate Recognition

Read Number Plates from an Image

# gem install multipart-post
require 'net/http/post/multipart'

url = URI.parse('https://api.platerecognizer.com/v1/plate-reader/')
path = '/path/to/car.jpg'
File.open(path) do |jpg|
  req = Net::HTTP::Post::Multipart.new url.path,
    "upload" => UploadIO.new(jpg, "image/jpeg", path)
  req['Authorization'] = 'Token API_TOKEN'
  res = Net::HTTP.start(url.host, url.port, use_ssl: true) do |http|
    http.request(req)
  end
end
<?php
// CREATE FILE READY TO UPLOAD WITH CURL
$file = realpath('example.jpg');
if (function_exists('curl_file_create')) { // php 5.5+
  $cFile = curl_file_create($file);
} else {
  $cFile = '@' . realpath($file);
}

//ADD PARAMETER IN REQUEST LIKE regions
$data = array(
    'upload' => $cFile,
    'regions' => 'fr' // Optional
);

// Prepare new cURL resource
$ch = curl_init('https://api.platerecognizer.com/v1/plate-reader/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

// Set HTTP Header for POST request
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "Authorization: Token API_TOKEN"  //API KEY
    )
);

// Submit the POST request and close cURL session handle
$result = curl_exec($ch);
print_r($result);exit;
curl_close($ch);
?>
# pip install requests
import requests
from pprint import pprint
regions = ['gb', 'it'] # Change to your country
with open('/path/to/car.jpg', 'rb') as fp:
    response = requests.post(
        'https://api.platerecognizer.com/v1/plate-reader/',
        data=dict(regions=regions),  # Optional
        files=dict(upload=fp),
        headers={'Authorization': 'Token API_TOKEN'})
pprint(response.json())

curl -F 'upload=@/path/to/car.jpg' \
  -F regions=fr \
  -F regions=gb \
  -H 'Authorization: Token API_TOKEN' \
  https://api.platerecognizer.com/v1/plate-reader/

// Using Node-RED?
// Check https://github.com/parkpow/node-red-contrib-plate-recognizer

const fetch = require('node-fetch');
const FormData = require('form-data');
const fs = require('fs');

let image_path = '/path/to/car.jpg'
let body = new FormData();
body.append('upload', fs.createReadStream(image_path));
// Or body.append('upload', base64Image);
body.append('regions', 'gb'); // Change to your country
fetch("https://api.platerecognizer.com/v1/plate-reader/", {
        method: 'POST',
        headers: {
            "Authorization": "Token API_TOKEN"
        },
        body: body
    }).then(res => res.json())
    .then(json => console.log(json))
    .catch((err) => {
        console.log(err);
    });
// Complete Example:

// https://github.com/marcbelmont/deep-license-plate-recognition/tree/master/csharp/PlateRecognizer

// Function calling the API:

// https://github.com/marcbelmont/deep-license-plate-recognition/blob/master/csharp/PlateRecognizer/PlateReader.cs#L23

// Complete Example:

// https://github.com/marcbelmont/deep-license-plate-recognition/tree/master/java/PlateRecognizer

// Function calling the API:

// https://github.com/marcbelmont/deep-license-plate-recognition/blob/master/java/PlateRecognizer/src/main/java/com/mycompany/numberplate/recognize.java#L17    

// Complete Android App Example:

// https://github.com/parkpow/alpr-anpr-android/
// Complete Example (Windows or Linux):

// https://github.com/marcbelmont/deep-license-plate-recognition/tree/master/java/PlateRecognizer

// Function calling the API:

// https://github.com/marcbelmont/deep-license-plate-recognition/blob/master/cpp/linux/numberPlate.cpp#L25
// https://github.com/marcbelmont/deep-license-plate-recognition/blob/master/cpp/windows/ConsoleApplication2/ConsoleApplication2.cpp#L29

Return value

{
   "processing_time":78.569,
   "results":[
      {
         "box":{
            "ymin":478,
            "xmin":148,
            "ymax":579,
            "xmax":288
         },
         "plate":"nhk552",
         "region":{
            "score":0.948,
            "code":"gb"
         },
         "vehicle":{
            "score":0.842,
            "type":"Car"
         },
         "score":0.896,
         "candidates":[
            {
               "score":0.896,
               "plate":"nhk552"
            }
         ],
         "dscore":0.74
      }
   ],
   "filename":"15_54_bcar_586jvjP.jpg",
   "version":1,
   "camera_id":null,
   "timestamp":"2019-12-03T15:54:49.093210Z"
}

This endpoint reads all license plates from an image.

HTTP Request

POST https://api.platerecognizer.com/v1/plate-reader/

POST Parameters

Parameter Required Description
upload Yes The file to be uploaded. The parameter can either be the file bytes (using Content-Type multipart/form-data) OR a base64 encoded image.
regions No Match the license plate pattern of a specific region or regions. This parameter can be used multiple times to specify more than one region. *
camera_id No Unique camera identifier.
timestamp No ISO 8601 timestamp. For example, 2019-08-19T13:11:25. The timestamp has to be in UTC.
mmc No Predict vehicle make and model. This feature is only available upon request. Possible values are "true" or "false".

* The regions parameter is used as a guide and the template will be ignored if the prediction differs too much from it. It works this way because we want to still be able to read plates from foreign vehicles. The system may sometimes mistake a local vehicle for a foreign one.

JSON Response

The response is a list of all the license plates found in the image. Each license plate has the following elements:

Attribute Description
results/plate Text of the license plate.
results/box Bounding box for the license plate. Coordinates in pixel of the top left and bottom right corners of the plate.
results/dscore Confidence level for plate detection.
results/score Confidence level for reading the license plate text.
results/vehicle/type Vehicle type: Ambulance, Bus, Car, Limousine, Motorcycle, Taxi, Truck, Van, Unknown.
results/vehicle/score Confidence level for vehicle prediction.
results/region/code Region of license plate. Returns a code from the country list.
results/region/score Confidence level for license plate region.
results/candidates List of predictions for the license plate value. The first element is the top prediction (same as results/plate).

Regions supported

The regions parameter can take one of the following codes. In addition to country, you can also provide a states to select more specific license plate patterns. States are only supported for USA and Australia.

The column Prediction indicates if the region is supported by our region classification predictor (field results/region/code).

Country Region code Prediction
Albania al
Andorra ad
Angola ao
Argentina ar Yes
Armenia am Yes
Australia au Yes
Austria at Yes
Azerbaijan az Yes
Belarus by Yes
Belgium be Yes
Belize bz
Bolivia bo
Bosnia and Herzegovina ba
Brazil br Yes
Brunei bn
Bulgaria bg Yes
Canada ca Yes
Chile cl Yes
Columbia co Yes
Costa Rica cr Yes
Croatia hr Yes
Cyprus cy
Czechia cz Yes
Denmark dk
Ecuador ec
El Salvador sv
Estonia ee Yes
Finland fi Yes
France fr Yes
French Guiana gf
Georgia ge Yes
Germany de Yes
Gibraltar gi
Greece gr Yes
Guatamala gp
Guyana gy
Holy See va
Honduras hn
Hungary hu Yes
Iceland is
Israel il Yes
India in Yes
Indonesia id Yes
Ireland ie
Italy it Yes
Jordan jo
Kazakhstan kz Yes
Kenya ke
Korea, Republic of kr
Latvia lv Yes
Lebanon lb
Liechtenstein li
Lithuania lt Yes
Luxembourg lu Yes
Malaysia my
Maldives mv
Malta mt
Mexico mx
Moldova, Republic of md Yes
Monaco mc Yes
Montenegro me Yes
Nepal np
Netherlands nl Yes
New Zealand nz Yes
Nicaragua ni
Nigeria ng
North Macedonia mk
Norway no Yes
Panama pa
Paraguay py
Peru pe
Philippines ph
Poland pl Yes
Portugal pt Yes
Qatar qa
Romania ro Yes
Russian Federation ru
San Marino sm
Serbia rs Yes
Singapore sg
Slovakia sk Yes
Slovenia si
South Africa za Yes
Spain es Yes
Suriname sr
Sweden se Yes
Switzerland ch Yes
Tanzania tz
Turkey tr Yes
Ukraine ua Yes
United Arab Emirates ae Yes
United Kingdom of Great Britain gb Yes
United States of America us Yes
Uraguay uy
Uzbekistan uz Yes
Venezuela ve
Vietnam vn Yes
Zambia zm

States

Australian states:

State Region code
New South Wales au-nsw
Queensland au-qld
South Australia au-sa
Tasmania au-tas
Victoria au-vic
Western Australia au-wa

United States of America states:

State Region code
Alabama us-al
Alaska us-ak
Arizona us-az
Arkansas us-ar
California us-ca
Colorado us-co
Connecticut us-ct
Delaware us-de
District of Columbia us-dc
Florida us-fl
Georgia us-ga
Hawaii us-hi
Idaho us-id
Illinois us-il
Indiana us-in
Iowa us-ia
Kansas us-ks
Kentucky us-ky
Louisiana us-la
Maine us-me
Maryland us-md
Massachusetts us-ma
Michigan us-mi
Minnesota us-mn
Mississippi us-ms
Missouri us-mo
Montana us-mt
Nebraska us-ne
Nevada us-nv
New Hampshire us-nh
New Jersey us-nj
New Mexico us-nm
New York us-ny
North Carolina us-nc
North Dakota us-nd
Ohio us-oh
Oklahoma us-ok
Oregon us-or
Pennsylvania us-pa
Rhode Island us-ri
South Carolina us-sc
South Dakota us-sd
Tennessee us-tn
Texas us-tx
Utah us-ut
Vermont us-vt
Virginia us-va
Washington us-wa
West Virginia us-wv
Wisconsin us-wi
Wyoming us-wy

Brazilian states:

State Region Code
Acre br-ac
Alagoas br-al
Amapá br-ap
Amazonas br-am
Bahia br-ba
Ceará br-ce
Distrito Federal br-df
Espírito Santo br-es
Goiás br-go
Manias Gerais br-mg
Maranhão br-ma
Mato Grosso do Sul br-ms
Mato Grosso br-mt
Pernambuco br-pe
Pará br-pa
Paraíba br-pb
Paraná br-pr
Piauí br-pi
Rio de Janeiro br-rj
Rio Grande do Norte br-rn
Rio Grande do Sul br-rs
Rondônia br-ro
Roraima br-rr
São Paulo br-sp
Sergipe br-se
Santa Catarina br_sc
Tocantins br-to

SDK

Recognition API

Return value

{
  "usage":{
    "max_calls":1000,
    "calls":44
  },
  "results":[
    ...
  ],
  "camera_id": "null",
  "timestamp": "2020-01-16 17:00:00",
  "filename":"car.jpg"
}

Our service is also available on-premises. Get started with the SDK. It has the same interface as the recognition API and it is hosted locally.

HTTP Request

POST http://localhost:8080/alpr

POST Parameters

Parameter Required Description
- - All the parameters from recognition API.
config No Additional engine configuration. See below.

config is a JSON value to change the engine configuration. It can take the following values:

JSON Response

Returns the same parameters as the recognition API. In addition to that, it returns the number of calls used.

SDK version

Return value

{
    "version": "1.3.8",
    "license_key": "XXX",
    "webhooks": []
}

HTTP Request

GET http://localhost:8080/info/

JSON Response

Returns the SDK version, license key and webhooks.

WebHooks

Example of POST payload

{
  "hook": {
    "target": "http://localhost:8081/",
    "id": 2,
    "event": "image.done"
  },
  "data": {
    "processing_time": 0.186,
    "timestamp": "2019-08-31T14:22:06.983Z",
    "results": [
      {
        "box": {
          "xmin": 563,
          "ymin": 530,
          "ymax": 579,
          "xmax": 702
        },
        "plate": "765410",
        "score": 0.9131534678711563,
        "dscore": 0.4084282568529709
      },
      {
        "box": {
          "xmin": 563,
          "ymin": 530,
          "ymax": 579,
          "xmax": 702
        },
        "plate": "830265",
        "score": 0.7700640306685624,
        "dscore": 0.8493143507578083
      }
    ],
    "filename": "14_22_test.jpeg",
    "version": 1,
    "camera_id": null
  }
}

Our service also supports webhooks. It allows you to receive a HTTP POST request to a target URL of your choosing. Go to webhooks settings page to manage your webhooks or add a new webhook target.

To quickly test out this feature, you can use http://webhook.site. It generates a unique target URL and displays all the requests made to that URL.

HTTP Request

POST target_url

target_url should return a valid HTTP status code (200). If the target_url consistently returns an error code, the hook will be removed and an email will be sent to the account owner.

The request body contains the same data as the standard recognition API.

Statistics

Get number of recognition calls done during the current month.

HTTP Request

GET https://api.platerecognizer.com/v1/statistics/

curl -H 'Authorization: Token API_TOKEN' \
  https://api.platerecognizer.com/v1/statistics/

Return value

{
  "usage": {
    "month": 1,
    "calls": 128,
    "year": 2019
  },
  "total_calls": 2500
}

JSON Response

Attribute Description
calls Number of API calls made during the current period.
month Month of the current period.
year Year of the current period.
total_calls Maximum number of API calls you can make during the period. Need more? Upgrade.

Errors

Error Code Meaning
403 Forbidden -- Your API key is wrong.
413 Payload Too Large response status code indicates that the request entity is larger than limits defined by our server. See upload limits.
429 Indicates the user has sent too many requests in a given amount of time. Upgrade for higher number of calls per second.

FAQ

Can't make it work? We may have answers on our FAQ.