The OpenALPR CarCheck API lets you submit an image—by file upload, base64‑encoded bytes, or a remote URL—to a cloud service that extracts license‑plate data and, optionally, vehicle make/model information, returning the results in JSON. It also offers a GET /config endpoint to retrieve the list of supported recognition result types and configurable parameters such as country, top‑N results, and inclusion of the original image.
Get a list of available results for plate and vehicle recognition
POST
/recognize
Send an image for OpenALPR to analyze and provide metadata back The image is sent as a file using a form data POST
secret_key(query, required) — The secret key used to authenticate your account. You can view your secret key by visiting https://cloud.openalpr.com/
recognize_vehicle(query) — If set to 1, the vehicle will also be recognized in the image This requires an additional credit per request
country(query, required) — Defines the training data used by OpenALPR. "us" analyzes North-American style plates. "eu" analyzes European-style plates. This field is required if using the "plate" task
return_image(query) — If set to 1, the image you uploaded will be encoded in base64 and sent back along with the response
topn(query) — The number of results you would like to be returned for plate candidates and vehicle classifications
is_cropped(query) — When providing a plate or vehicle that is already cropped, this performs a recognition against the full crop and does not attempt to localize the plate/vehicle
POST
/recognize_bytes
Send an image for OpenALPR to analyze and provide metadata back The image is sent as base64 encoded bytes.
secret_key(query, required) — The secret key used to authenticate your account. You can view your secret key by visiting https://cloud.openalpr.com/
recognize_vehicle(query) — If set to 1, the vehicle will also be recognized in the image This requires an additional credit per request
country(query, required) — Defines the training data used by OpenALPR. "us" analyzes North-American style plates. "eu" analyzes European-style plates. This field is required if using the "plate" task
return_image(query) — If set to 1, the image you uploaded will be encoded in base64 and sent back along with the response
topn(query) — The number of results you would like to be returned for plate candidates and vehicle classifications
POST
/recognize_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
image_url(query, required) — A URL to an image that you wish to analyze
secret_key(query, required) — The secret key used to authenticate your account. You can view your secret key by visiting https://cloud.openalpr.com/
recognize_vehicle(query) — If set to 1, the vehicle will also be recognized in the image This requires an additional credit per request
country(query, required) — Defines the training data used by OpenALPR. "us" analyzes North-American style plates. "eu" analyzes European-style plates. This field is required if using the "plate" task
return_image(query) — If set to 1, the image you uploaded will be encoded in base64 and sent back along with the response
topn(query) — The number of results you would like to be returned for plate candidates and vehicle classifications
4 endpoints auto-detected
curl -X GET \
"https://api.openalpr.com/v3/config"
