Vehicle OBD Codes API Documentation

V1

/api/v1

First stable version for OBD-II fault code lookups.

GET /api/v1/vehicles/obd-codes Auth Required

List Vehicle OBD Codes

Searches the OBD-II fault code catalog with filters such as code, type, manufacturer, keyword, and generic/manufacturer-specific mode.

Authentication

X-Api-Key: your_api_key

Query Parameters

Name	Type	Required	Example	Description
`code`	string	optional	`P0420`	Exact OBD fault code filter.
`code_type`	string	optional	`P`	Code family filter: P, B, C, or U.
`manufacturer`	string	optional	`FORD`	Manufacturer filter, for example FORD, BMW, or GENERIC.
`is_generic`	boolean	optional	`1`	Filter only generic or manufacturer-specific definitions.
`q`	string	optional	`catalyst`	Keyword search in code, description, and manufacturer.
`per_page`	integer	optional	`10`	Page size between 1 and 100.

Request Example

GET /api/v1/vehicles/obd-codes?code_type=P&q=catalyst&per_page=10

Response Example

{
    "success": true,
    "message": "Vehicle OBD codes fetched successfully.",
    "data": {
        "items": [
            {
                "id": 1,
                "code": "P0420",
                "code_type": "P",
                "system_name": "Powertrain",
                "manufacturer": "GENERIC",
                "description": "Catalyst System Efficiency Below Threshold (Bank 1)",
                "is_generic": true,
                "locale": "en"
            }
        ],
        "count": 1,
        "total": 1,
        "current_page": 1,
        "last_page": 1,
        "per_page": 10,
        "filters": {
            "code": null,
            "code_type": "P",
            "manufacturer": null,
            "is_generic": null,
            "q": "catalyst"
        }
    }
}

Error Response

{
    "success": false,
    "message": "Invalid API key.",
    "error_code": "INVALID_API_KEY"
}

GET /api/v1/vehicles/obd-codes/{code} Auth Required

Get Vehicle OBD Code

Returns the generic definition for one OBD fault code plus any matching manufacturer-specific definitions.

Authentication

X-Api-Key: your_api_key

Path Parameters

Name	Type	Required	Example	Description
`code`	string	required	`P0420`	Exact OBD fault code.

Query Parameters

Name	Type	Required	Example	Description
`manufacturer`	string	optional	`FORD`	Optional manufacturer filter for manufacturer-specific definitions.

Request Example

GET /api/v1/vehicles/obd-codes/P0420?manufacturer=FORD

Response Example

{
    "success": true,
    "message": "Vehicle OBD code fetched successfully.",
    "data": {
        "code": "P0420",
        "code_type": "P",
        "system_name": "Powertrain",
        "requested_manufacturer": "FORD",
        "generic_definition": {
            "id": 1,
            "code": "P0420",
            "code_type": "P",
            "system_name": "Powertrain",
            "manufacturer": "GENERIC",
            "description": "Catalyst System Efficiency Below Threshold (Bank 1)",
            "is_generic": true,
            "locale": "en"
        },
        "manufacturer_specific_definitions": [
            {
                "id": 2,
                "code": "P0420",
                "code_type": "P",
                "system_name": "Powertrain",
                "manufacturer": "FORD",
                "description": "Warm Up Catalyst Efficiency Below Threshold Bank 1",
                "is_generic": false,
                "locale": "en"
            }
        ],
        "manufacturer_specific_count": 1,
        "total_definition_count": 2
    }
}

Error Response

{
    "success": false,
    "message": "OBD fault code not found.",
    "error_code": "OBD_CODE_NOT_FOUND"
}