License Plate Recognition API

Our plate recognition API provides accurate recognition of license plates from images. The API is trained on license plates from over 100 countries and states.

You can use this in conjunction with the Vehicle Plate Decoder API to first decipher the plate number from an image and then retrieve the vehicle's specifications.


POST/platerecognition

License Plate Recognition

This endpoint allows you to retrieve a vehicle's license plate number or registration number from an image of the plate.

Required attributes

  • Name
    key
    Type
    string
    Description

    Your CarsXE API key.

  • Name
    body
    Type
    string
    Description

    POST body that's a URL to an image of a vehicle's license plate.

  • Name
    upload_url
    Type
    string
    Description

    Vehicle image URL. The image must be a direct link to the image of the vehicle including a license plate.


Response attributes

  • Name
    success
    Type
    boolean
    Description

    Whether the algorithm has been able to successfully analyze the image.

  • Name
    results
    Type
    array
    Description

    A list (array) of "plate" elements or objects, each of which contain the box of where the plate is in the image, a list of candidates with the relative confidence scores, the region and more info.

    The confidence score is a probability that the plate in the image matches the values returned

  • Name
    message
    Type
    string
    Description

    String detailing error if any.

  • Name
    processing_time
    Type
    string
    Description

    How much time it took to process the image.

FAQ

  • Title
    Is the License Plate Recognition API included in the free trial?

    Yes! The Vehicle Plate Recognition API is included in the 7-day free trial. For more information visit our pricing page.

Request

POST
/platerecognition
curl --location 'https://api.carsxe.com/platerecognition?key=CARSXE_API_KEY' \
--header 'Content-Type: text/plain' \
--data 'https://api.carsxe.com/img/apis/plate_recognition.JPG'

Response

{
  "success": true,
  "message": "",
  "camera_id": null,
  "filename": "04_40_btmpUZGp0s.jpg",
  "processing_time": 226.906,
  "results": [{
    "box": {
        "xmax": 324,
        "xmin": 168,
        "ymax": 707,
        "ymin": 624
    },
    "candidates": [
        {
            "plate": "fd1307",
            "score": 0.906
        },
        {
            "plate": "fd13o7",
            "score": 0.904
        },
        {
            "plate": "fdi307",
            "score": 0.767
        },
        {
            "plate": "fdi3o7",
            "score": 0.765
        }
    ],
    "dscore": 0.697,
    "plate": "fd1307",
    "region": {
        "code": "us",
        "score": 0.436
    },
    "score": 0.906,
    "vehicle": {
        "score": 0.858,
        "type": "Car"
    }
  },{...}],
}