← Back to Documentations

Vehicles API

Browse vehicle brands, models, and versions from the Data API catalog.

V1

/api/v1

First stable version for vehicle data lookups.

GET /api/v1/vehicles/brands Auth Required
List Vehicle Brands

Returns all vehicle brands ordered by name.

Authentication
X-Api-Key: your_api_key
Response Example
{
    "success": true,
    "message": "Vehicle brands fetched successfully.",
    "data": {
        "brands": [
            {
                "id": 1,
                "name": "Toyota",
                "slug": "toyota",
                "model_count": 2,
                "version_count": 4
            }
        ],
        "count": 1
    }
}
Error Response
{
    "success": false,
    "message": "Invalid API key.",
    "error_code": "INVALID_API_KEY"
}
GET /api/v1/vehicles/brands/{slug} Auth Required
Get Vehicle Brand

Returns one vehicle brand and all related models.

Authentication
X-Api-Key: your_api_key
Path Parameters
Name Type Required Example Description
slug string required toyota Vehicle brand slug.
Response Example
{
    "success": true,
    "message": "Vehicle brand fetched successfully.",
    "data": {
        "id": 1,
        "name": "Toyota",
        "slug": "toyota",
        "models": [
            {
                "id": 10,
                "name": "Corolla",
                "slug": "corolla",
                "version_count": 3
            }
        ],
        "model_count": 1
    }
}
Error Response
{
    "success": false,
    "message": "Vehicle brand not found.",
    "error_code": "VEHICLE_BRAND_NOT_FOUND"
}
GET /api/v1/vehicles/models/{slug} Auth Required
Get Vehicle Model

Returns one vehicle model with its active versions.

Authentication
X-Api-Key: your_api_key
Path Parameters
Name Type Required Example Description
slug string required corolla Vehicle model slug.
Response Example
{
    "success": true,
    "message": "Vehicle model fetched successfully.",
    "data": {
        "id": 10,
        "name": "Corolla",
        "slug": "corolla",
        "brand": {
            "id": 1,
            "name": "Toyota",
            "slug": "toyota"
        },
        "versions": [
            {
                "id": 100,
                "name": "1.8 Hybrid e-CVT",
                "slug": "1-8-hybrid-e-cvt",
                "full_version_name": "Toyota Corolla 1.8 Hybrid e-CVT Flame X-Pack",
                "generation_start_year": 2022,
                "generation_end_year": null,
                "fuel_type": "Hybrid",
                "transmission": "e-CVT",
                "horsepower": 140,
                "is_active": true
            }
        ],
        "version_count": 1
    }
}
Error Response
{
    "success": false,
    "message": "Vehicle model not found.",
    "error_code": "VEHICLE_MODEL_NOT_FOUND"
}
GET /api/v1/vehicles/versions/{slug} Auth Required
Get Vehicle Version

Returns one vehicle version with brand and model details.

Authentication
X-Api-Key: your_api_key
Path Parameters
Name Type Required Example Description
slug string required 1-8-hybrid-e-cvt Vehicle version slug.
Response Example
{
    "success": true,
    "message": "Vehicle version fetched successfully.",
    "data": {
        "id": 100,
        "name": "1.8 Hybrid e-CVT",
        "slug": "1-8-hybrid-e-cvt",
        "full_version_name": "Toyota Corolla 1.8 Hybrid e-CVT Flame X-Pack",
        "trim": "Flame X-Pack",
        "engine_name": "2ZR-FXE",
        "engine_volume": 1.8,
        "horsepower": 140,
        "fuel_type": "Hybrid",
        "transmission": "e-CVT",
        "generation_start_year": 2022,
        "generation_end_year": null,
        "is_active": true,
        "brand": {
            "id": 1,
            "name": "Toyota",
            "slug": "toyota"
        },
        "model": {
            "id": 10,
            "name": "Corolla",
            "slug": "corolla"
        }
    }
}
Error Response
{
    "success": false,
    "message": "Vehicle version not found.",
    "error_code": "VEHICLE_VERSION_NOT_FOUND"
}