Name: FleetSheet API: Batch VIN Decoder for Fleets
Brand: visionwell
SKU: api-visionwell-fleetsheet
Availability: InStock
Author: API Market

binbin7418-dotcom

# FleetSheet Batch VIN Decoder API

## Overview

The FleetSheet API decodes a list of VINs into a fleet sheet. Send up to 25 VINs and get one vehicle profile per VIN, with make, model, model year, trim, body class, engine, transmission and fuel type, plus a summary of how many decoded cleanly, which looked wrong, and a breakdown by make, body class and fuel type.

It is built for fleet managers, leasing companies, auction houses and dealers who handle many vehicles at once. The data comes from the U.S. NHTSA vPIC database and is credited in every response. A single VIN endpoint is included for one-off lookups.

## Features

*   **3 endpoints**: batch decode, single decode and health check.
*   **Up to 25 VINs**: per batch call.
*   **Fleet summary**: decoded, sparse, failed and checksum-suspect counts.
*   **Breakdowns**: counts by make, body class and fuel type.
*   **Source**: NHTSA vPIC.
*   **Rate limit**: up to 10 requests per second on every plan.

## Use Cases

*   **Fleet management**: build a vehicle register from VINs.
*   **Leasing**: check vehicle details for a contract batch.
*   **Auctions**: fill lot details for a list of cars.
*   **Insurance**: rate a commercial fleet.

## API Documentation

### Base URL

All requests go through the API.market proxy at this base URL:

```
https://prod.api.market/api/v1/visionwell/fleetsheet
```

### Authentication

Every request must include your API.market key in the `x-api-market-key` header:

```
x-api-market-key: YOUR_API_KEY
```

Replace `YOUR_API_KEY` with your actual API key.

### Endpoints

#### 1. Decode a batch of VINs

Decodes each VIN and returns a fleet summary.

**Method:** `POST`

**Endpoint:** `/decode/batch`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| vins | body | VINs to decode | array of strings | Yes | - | 25 |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/visionwell/fleetsheet/decode/batch' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "vins": [
    "1HGCM82633A004352",
    "1FTFW1ET5DFC10312",
    "1HGCM"
  ]
}'
```

**Example Response (200 OK):**

```json
{
  "count": 3,
  "summary": {
    "total": 3,
    "decoded": 2,
    "sparse": 1,
    "failed": 0,
    "checksumSuspect": 1,
    "fieldCoverage": {
      "make": 3,
      "model": 2,
      "modelYear": 2,
      "bodyClass": 2,
      "fuelTypePrimary": 2
    },
    "breakdown": {
      "byMake": {
        "HONDA": 2,
        "FORD": 1
      },
      "byBodyClass": {
        "Coupe": 1,
        "Pickup": 1
      },
      "byFuelTypePrimary": {
        "Gasoline": 2
      }
    }
  },
  "results": [
    {
      "vin": "1HGCM82633A004352",
      "ok": true,
      "vehicle": {
        "vin": "1HGCM82633A004352",
        "make": "HONDA",
        "model": "Accord",
        "modelYear": "2003",
        "trim": "EX-V6",
        "series": null,
        "bodyClass": "Coupe",
        "vehicleType": "PASSENGER CAR",
        "manufacturer": "AMERICAN HONDA MOTOR CO., INC.",
        "driveType": null,
        "transmissionStyle": "Automatic",
        "transmissionSpeeds": "5",
        "fuelTypePrimary": "Gasoline",
        "fuelTypeSecondary": null,
        "engineCylinders": "6",
        "engineHP": "240",
        "displacementL": "2.998832712",
        "doors": "2",
        "plantCity": "MARYSVILLE",
        "plantState": "OHIO",
        "plantCountry": "UNITED STATES (USA)",
        "errorCode": "0",
        "errorText": "0 - VIN decoded clean. Check Digit (9th position) is correct"
      }
    },
    {
      "vin": "1FTFW1ET5DFC10312",
      "ok": true,
      "vehicle": {
        "vin": "1FTFW1ET5DFC10312",
        "make": "FORD",
        "model": "F-150",
        "modelYear": "2013",
        "trim": null,
        "series": null,
        "bodyClass": "Pickup",
        "vehicleType": "TRUCK",
        "manufacturer": "FORD MOTOR COMPANY",
        "driveType": "4WD/4-Wheel Drive/4x4",
        "transmissionStyle": null,
        "transmissionSpeeds": null,
        "fuelTypePrimary": "Gasoline",
        "fuelTypeSecondary": null,
        "engineCylinders": "6",
        "engineHP": "365",
        "displacementL": "3.5",
        "doors": null,
        "plantCity": "DEARBORN",
        "plantState": "MICHIGAN",
        "plantCountry": "UNITED STATES (USA)",
        "errorCode": "1",
        "errorText": "1 - Check Digit (9th position) does not calculate properly"
      }
    }
  ],
  "sources": [
    "NHTSA vPIC"
  ],
  "_attribution": "Data from the U.S. National Highway Traffic Safety Administration (NHTSA) Vehicle Product Information Catalog (vPIC), https://vpic.nhtsa.dot.gov. Reference data only; not a substitute for manufacturer or title records."
}
```

#### 2. Decode one VIN

Decodes a single VIN into a vehicle profile.

**Method:** `GET`

**Endpoint:** `/decode`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| vin | query | The 17-character Vehicle Identification Number | string | Yes | - | - |

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/visionwell/fleetsheet/decode?vin=1HGCM82633A004352' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "vehicle": {
    "vin": "1HGCM82633A004352",
    "make": "HONDA",
    "model": "Accord",
    "modelYear": "2003",
    "trim": "EX-V6",
    "series": null,
    "bodyClass": "Coupe",
    "vehicleType": "PASSENGER CAR",
    "manufacturer": "AMERICAN HONDA MOTOR CO., INC.",
    "driveType": null,
    "transmissionStyle": "Automatic",
    "transmissionSpeeds": "5",
    "fuelTypePrimary": "Gasoline",
    "fuelTypeSecondary": null,
    "engineCylinders": "6",
    "engineHP": "240",
    "displacementL": "2.998832712",
    "doors": "2",
    "plantCity": "MARYSVILLE",
    "plantState": "OHIO",
    "plantCountry": "UNITED STATES (USA)",
    "errorCode": "0",
    "errorText": "0 - VIN decoded clean. Check Digit (9th position) is correct"
  },
  "sources": [
    "NHTSA vPIC"
  ],
  "_attribution": "Data from the U.S. National Highway Traffic Safety Administration (NHTSA) Vehicle Product Information Catalog (vPIC), https://vpic.nhtsa.dot.gov. Reference data only; not a substitute for manufacturer or title records."
}
```

#### 3. Health check

Returns the service status. It is a quick way to check that your key and the FleetSheet service are working.

**Method:** `GET`

**Endpoint:** `/health`

**Parameters:** None.

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/visionwell/fleetsheet/health' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "ok": true,
  "service": "VinScope"
}
```

## Status Codes

| Code | Status | Description |
|---|---|---|
| 200 | OK | The request succeeded and the response body holds the result. |
| 400 | Bad Request | A required parameter is missing or a value is invalid. Check the parameter table for the endpoint. |
| 401 | Unauthorized | The `x-api-market-key` header is missing or the key is not valid. |
| 403 | Forbidden | Your key is valid but your subscription does not allow this request, for example an endpoint outside your plan. |
| 404 | Not Found | The path does not exist, or the resource you asked for was not found. |
| 429 | Too Many Requests | You sent more than 10 requests per second. Slow down and retry, honouring the `Retry-After` header. |
| 500 | Internal Server Error | Something went wrong while processing the request. Retry after a short wait. |
| 503 | Service Unavailable | The service or its upstream data source is temporarily unavailable. Retry with backoff. |

## Rate Limits

Every plan allows up to 10 requests per second. Subscription plans also have a monthly call quota shown on the pricing page. Sending more than 10 requests per second returns `429 Too Many Requests`. Throttle your client to stay under 10 requests per second, back off and retry when you get a 429, and honour the `Retry-After` header when it is present.

## FAQ

*   **What does checksumSuspect mean?**

    The VIN's check digit does not match, so it may be mistyped. It is still decoded as far as possible.

*   **What is a sparse result?**

    NHTSA could read only part of the VIN, for example the manufacturer but not the model. Check the VIN for typos.

*   **How is this different from VinScope?**

    FleetSheet adds batch decoding and a fleet summary. VinScope adds make, model and variable lists.

## Contact Us

If you have any questions or need assistance, you can reach out to us through the embedded chat on the bottom right corner of the page or send an email to hello@magicapi.com.


Decode up to 25 VINs per call into vehicle profiles with a fleet summary and breakdowns by make, body class and fuel type.

FleetSheet API: Batch VIN Decoder for Fleets