This API is deprecated and will be removed in the future. Please use the [Plate Decoder V2
API](/docs/v2/plate-decoder) instead.
The Vehicle Plate Decoder API looks up the vehicle through the database for matches and returns the VIN, make, model and year among other attributes. It can be coupled with other APIs to become even more powerful. The state is a two letter abbreviation of one of the 50 states, or DC (District of Columbia), GU (Guam), PR (Puerto Rico) or VI (Virgin Islands).
International support includes the following countries: Australia, Brazil, United Kingdom, Ireland, Italy, Spain, India, Mexico and New Zealand.
---
This endpoint allows you to retrieve vehicle information based on license plates and registration numbers.
## Required attributes
Your CarsXE API key.
The vehicle registration number or license plate number.
The two letter state code (US) such as `CA` or `NY`, Australian state (see FAQ) or Brazil `BR`, United Kingdom `UK`, Ireland `IR`, Italy `IT`, Spain `ES`, India `IND`, Mexico `MX` and New Zealand `NZ`.
Australia `AU`
Optional for `US`.
## Optional attributes
The format of the response. One of `json` or `xml`. Defaults to `json`.
---
## Response attributes
The vehicle identification number.
Whether the plate decoder data has been retrieved.
A stock photo of that general vehicle. (Use [Images API](/docs/v1/images) for more control)
Where the vehicle was assembled.
Vehicle description of make, model and trim.
Year of the vehicle's registration.
The vehicle make.
The model of the vehicle.
The specific vehicle body style.
The vehicle's engine size.
You may be use the following plate for test:},{question: "How can I search Australian vehicle registrations?", answer: <>For Australia use country=AU&state=NSW. The list of possible Australian states are:NSW (New South Wales),VIC (Victoria),QLD (Queensland incl. North Queensland),SA (South Australia),ACT (Canberra),NT (Northern Territory),TAS (Tasmania),WA (Western Australia),
},{question: "Is the Vehicle Plate Decoder API included in the free trial?", answer: <>No, The Vehicle Plate Decoder API is not included in the 7-day free trial. For more information visit our pricing page.}]} hidePadding />
```bash
curl -G https://api.carsxe.com/platedecoder \
-d key=CARSXE_API_KEY \
-d plate=7XER187 \
-d state=CA
```
```js
import { CarsXE } from "carsxe-api";
const carsxe = new CarsXE("CARSXE_API_KEY");
const plate = "7XER187";
const state = "CA";
try {
const plateDecoder = await carsxe.plateDecoder({ plate, state });
console.log(plateDecoder);
} catch (error) {
console.error(error);
}
```
```python
import asyncio
from carsxe_api import CarsXE
carsxe = CarsXE('CARSXE_API_KEY')
plate = '7XER187'
state = 'CA'
try:
plate_decoder = asyncio.run(carsxe.plate_decoder({"plate": plate, "state": state}))
print(plate_decoder)
except Exception as e:
print(f"Error: {e}")
```
```php
plateDecoder(['plate' => $plate, 'state' => $state]);
print_r($plateDecoder);
} catch (Exception $error) {
echo "Error: " . $error->getMessage();
}
```
```ruby
require 'carsxe'
API_KEY = 'CARSXE_API_KEY'
carsxe = Carsxe::CarsXE.new(api_key: API_KEY)
plate = '7XER187'
state = 'CA'
begin
plate_decoder = carsxe.plate_decoder('plate' => plate, 'state' => state)
puts plate_decoder
rescue StandardError => error
puts "Error: #{error.message}"
end
```
```go
package main
import (
"fmt"
"github.com/carsxe/carsxe-go-package"
)
func main() {
client := carsxe.New("CARSXE_API_KEY")
plate := "7XER187"
state := "CA"
plateDecoder := client.PlateDecoder(map[string]string{"plate": plate, "state": state})
fmt.Println(plateDecoder)
}
```
```java
import io.github.carsxe.CarsXE;
import java.util.Map;
import java.util.HashMap;
public class Main {
public static void main(String[] args) {
CarsXE carsxe = new CarsXE("CARSXE_API_KEY");
Map params = new HashMap<>();
params.put("plate", "7XER187");
params.put("state", "CA");
try {
Map plateDecoder = carsxe.platedecoder(params);
System.out.println(plateDecoder);
} catch (Exception e) {
System.err.println("Error: " + e.getMessage());
}
}
}
```
```swift
import carsxe
let carsxe = CarsXE(apiKey: "CARSXE_API_KEY")
let plate = "7XER187"
let state = "CA"
do {
let plateDecoder = try carsxe.plateDecoder(["plate": plate, "state": state])
print(plateDecoder)
} catch {
print("Error: \(error)")
}
```
```csharp
using carsxe;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
class Program
{
static async Task Main(string[] args)
{
string API_KEY = "CARSXE_API_KEY";
CarsXE carsxe = new CarsXE(API_KEY);
string plate = "7XER187";
string state = "CA";
try
{
var plateDecoder = await carsxe.PlateDecoder(new Dictionary { { "plate", plate }, { "state", state } });
Console.WriteLine(plateDecoder);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
```
```json showLineNumbers {{ title: 'Response' }}
{
"success": true,
"input": {
"plate": "7XER187",
"state": "CA",
"country": "US"
},
"vin": "3KPFK4A78HE103497",
"assembly": "Mexico",
"Description": "Kia Forte LX",
"BodyStyle": "Sedan",
"RegistrationYear": "2017",
"EngineSize": "2.0L I4 MPI",
"CarMake": "Kia",
"CarModel": "Forte"
}
```