RapidAPI logo

OpenALPR

FREEMIUM
By matthill5
Updated 4 months ago
Visual Recognition
-/10
Popularity Score
-
Latency
-
Success Rate

OpenALPR API Documentation

The OpenALPR Cloud API is a web-based service that analyzes images for license plates as well as vehicle information such as make, model, and color. The Cloud API service is easy to integrate into your application via a web-based REST service. When you send image data to the OpenALPR API, we process that data and return JSON data describing the license plate and vehicle.

View API Details
POSTRecognize URL
POSTRecognize Bytes
GETConfig
POSTRecognize
POSTRecognize URL

Send an image for OpenALPR to analyze and provide metadata back The image is sent as a URL. The OpenALPR service will download the image and process it

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
image_urlSTRING
REQUIREDA URL to an image that you wish to analyze
countrySTRING
REQUIREDDefines the training data used by OpenALPR. “us” analyzes North-American style plates. “eu” analyzes European-style plates.
Optional Parameters
prewarpSTRING
OPTIONALPrewarp configuration is used to calibrate the analyses for the angle of a particular camera. More information is available here http://doc.openalpr.com/accuracy_improvements.html#calibration
recognize_vehicleNUMBER
OPTIONALIf set to 1, the vehicle will also be recognized in the image This requires an additional credit per request
return_imageNUMBER
OPTIONALIf set to 1, the image you uploaded will be encoded in base64 and sent back along with the response
stateSTRING
OPTIONALCorresponds to a US state or EU country code used by OpenALPR pattern recognition. For example, using “md” matches US plates against the Maryland plate patterns. Using “fr” matches European plates against the French plate patterns.
topnNUMBER
OPTIONALThe number of results you would like to be returned for plate candidates and vehicle classifications
Code Snippet
unirest.post("https://openalpr.p.rapidapi.com/recognize_url")
.header("X-RapidAPI-Host", "openalpr.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.send("image_url=<required>")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://openalpr.p.rapidapi.com/recognize_url
Request Method: POST
Response Headers
Response Body
Log inSign up

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://openalpr.p.rapidapi.com/recognize_url")
.header("X-RapidAPI-Host", "openalpr.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.send("image_url=<required>")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication