Skip to main content

Snapshot API Reference

Welcome to the Plate Recognizer Snapshot API! You can use our API to access our API endpoints, which can read license plates from images.

Interactive API Reference

Browse endpoints, parameters, and schemas in our interactive API Reference. Generated directly from the API, it always reflects current behavior.

For detailed instructions on how to install the Snapshot SDK, go here.

Other use cases:

Snapshot Cloud API​

Snapshot Cloud reads license plates from images through our hosted API. Every Cloud endpoint is documented in the interactive API reference, which is generated directly from the API and always up to date. It covers:

  • Authentication and API tokens
  • Reading number plates from an image, with all request parameters and code samples
  • Engine configuration (config) options
  • Response schema and attributes
  • Usage statistics
  • Error codes

Open the interactive API reference to explore requests and responses, or get your API token from your Snapshot Cloud dashboard.

Snapshot On-Premise API​

Our service is also available on-premises. Get started with the SDK. It has a similar interface as the Snapshot Cloud recognition API and it is hosted locally. See differences below.

info

Are you using the on-premise API from a different device? Make sure that your firewall allows it. For example, you can disable the Windows Defender firewall to check if it is blocking the API calls.

Recognition API​

HTTP Request​

POST http://localhost:8080/v1/plate-reader/

The CORS policy of this endpoint allows requests from all origins. This endpoint has no maximum calls per second contrary to our Cloud API.

Parameters​

All the parameters from the Snapshot Cloud recognition API.

#On Linux
#Calling the API with just the image
curl -o car.jpg https://app.platerecognizer.com/static/demo.jpg ## Get an image
curl -F "[email protected]" \
  http://localhost:8080/v1/plate-reader/

#Sending the image in base64
curl -F "upload=$(base64 'image.jpg')" http://localhost:8080/v1/plate-reader/

#Calling with API with optional parameters config and mmc
#The region is set to Mexico and California
curl -F "upload=@/path/to/car.jpg" \
  -F regions=`mx` \
  -F regions=us-ca \
  -F mmc=true \
  -F config="{\"mode\":\"fast\"}" \
  http://localhost:8080/v1/plate-reader/

JSON Response​

{
  "usage": {
    "max_calls": 1000,
    "calls": 44
  },
  "results": [
    // Same as cloud API example above.
  ],
  "camera_id": "null",
  "timestamp": "2020-01-16 17:00:00",
  "filename": "car.jpg"
}

SDK Version​

Show version, webhooks and usage information.

HTTP Request​

GET http://localhost:8080/info/

JSON Response​

Returns the SDK version, license key and webhooks.

{
  "version": "1.3.8",
  "license_key": "XXX",
  "total_calls": 2500,
  "usage": { "calls": 10 },
  "webhooks": []
}

Detection Zones​

Detection Zones exclude overlay texts, street signs or other objects.

Countries​

Check the countries codes for regions parameter.