> ## Documentation Index
> Fetch the complete documentation index at: https://docs.remapdb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Look up a UK registration

> UK registrations only. The `uk` path segment selects the country-specific lookup; unsupported countries are not routed to UK lookup.

Requires a valid API key with `vdb_read`. Staff-designated test registrations are available on every plan, including API trials, exclusively from saved data and without consuming lookup credits. All other registrations require an active API or MAX full API subscription and UK VRM entitlement. Supply the API key as `Authorization: Bearer <API_KEY>`.

Successful external lookups consume one included unit, then one nonexpiring credit. Cached results consume nothing. Identical concurrent misses are coalesced across accounts.

Every retry rechecks account access, test designation and catalog visibility. Test records with missing or invalidated saved data return `503 test_registration_unavailable`; they never trigger a provider call. An `Idempotency-Key` is scoped to the account and normalized plate; reusing it for a different plate returns `409`. Failed or not-found requests stay final for that key: a deliberately new attempt after cooldown needs a new key.

The `engine` object follows the engine-details layout: use `engine.performance` for OEM data and `engine.tuning.stages` for tuned data. A matched engine includes the full account-visible catalog details and customisations.

Without a reliable match, known registration specifications fill the same fields, `engine.id` is `null`, and tuning stages are explicitly estimated. Unknown facts remain null or empty; reliable combustion performance can include illustrative template-generated dyno curves. Ambiguous hybrid component data is withheld. Estimated stages are explicitly labeled and never published into the catalog.

Broad registration attributes remain under `vehicle.details`. Power is metric horsepower (PS), torque is Nm.



## OpenAPI

````yaml /openapi-v2.json post /vrm/uk/lookup
openapi: 3.0.0
info:
  title: Remapdb API v2
  description: >-
    Vehicle Tuning Database API - For Tuning services and Tuners.


    Access comprehensive vehicle details, including types, manufacturers,
    models, engines, ECU and TCU info, tuning tools, dyno charts, and available
    tuning or remap stages with their performance gains.



    REST v2 uses the same Bearer API keys as v1. Account customizations apply
    only when the subscription has Customizations access. Cache catalog
    responses by API version, account, language and catalog profile, never by
    entity ID alone. IDs and cursors remain numeric and can exceed 32-bit
    integers; support integers through 9007199254740991. Identify stages by id,
    not stage_number. Manufacturer logos may be null; custom logos and
    generation photos use durable CDN object URLs. See
    https://docs.remapdb.com/api/migrate-to-v2.


    Private catalog slugs use rdb-brand-{id}, rdb-make-{id}, rdb-gen-{id}, and
    rdb-engine-{id}. Legacy rdb-private-{entity}-{id} links continue to resolve.


    Create and name up to 10 active key/secret pairs in API > API keys. All
    pairs share the same subscription and entitlements. Use only the key as the
    bearer token; this header does not require the secret. Rotation or
    revocation invalidates the selected key on subsequent requests, including
    existing MCP sessions. Other keys remain valid.


    Account activity is available in the Remapdb app under API > API usage.
    Request logging records account/key identifiers, normalized endpoint, status
    and duration; new logs exclude credential values and request payloads. See
    https://docs.remapdb.com/api/usage-and-monitoring.
  termsOfService: https://remapdb.com/terms
  contact:
    name: Remapdb.com
    url: https://remapdb.com
  version: 2.0.0
  x-logo:
    url: https://cdn.remapdb.com/logos/remapdb-logo-default-full-light.svg
    altText: Remapdb REST API Documentation
servers:
  - url: https://api.remapdb.com/v2
security:
  - bearerAuth: []
tags:
  - name: Response and Errors
    description: >-
      - API will always respond with json, content type: **application/json**.

      - Successfull response will return HTTP **2XX** ***(Success)*** response
      code.

      - Error response will return either HTTP **4XX** ***(Client Error)*** or
      HTTP **5XX** ***(Server Error)***.


      On error, API will return error object. It will contain the appropriate
      error **code** *(integer)* and a **message** *(string)*.

      The HTTP response code will be the same as the error code.


      Error Schema:

      ```json json_schema

      {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        }
      }

      ```


      Error Example:

      ```json http

      {
        "code": 404,
        "message": "Method doesnt exist."
      }

      ```



      DTC and ECU endpoints instead use a structured `{error: {code: string,
      message: string}}` envelope; see their operation schemas.
    x-traitTag: true
  - name: Language
    description: >-
      All API methods accept custom language. It can be set via the
      **"Accept-Language"** header. Content of the header should be the code of
      the language you are requesting.


      #### Available languages:

      Code | Name

      ---------|----------
       `bg` | Bulgarian
       `da` | Danish
       `de` | German
       `en` | English **(default)**
       `es` | Spanish
       `et` | Estonian
       `fi` | Finnish
       `fr` | French
       `hr` | Croatian
       `hu` | Hungarian
       `it` | Italian
       `lt` | Lithuanian
       `lv` | Latvian
       `nb` | Norwegian Bokmål
       `nl` | Dutch
       `nn` | Norwegian Nynorsk
       `pt` | Portuguese
       `ru` | Russian
       `sv` | Swedish
       `tr` | Turkish
       `zs` | Chinese

      If no "accept-language" header is set, the API will use the default
      language - English.


      Following example shows how to set the language to Dutch (`nl`) using
      curl:

      ```json http

      curl 'https://api.remapdb.com/v1/search?query=audi' \

      --header 'Accept-Language: nl'

      ```



      DTC dictionary descriptions are returned as stored and are not translated.
    x-traitTag: true
  - name: Rate Limits
    description: >-
      All active API keys on an account share one request allowance across REST
      v1, REST v2 and MCP. The standard allowance is 120 requests per minute.
      Creating or rotating keys does not reset it. API v2 returns HTTP 429 when
      the limit is reached; retry after the current minute window. UK lookup
      credits and ECU job/storage quotas are also shared by the account.
    x-traitTag: true
  - name: Client SDKs
    description: >
      Remapdb offers OpenAPI v3 specification which can be used with any
      OpenAPI/Swagger client generator to generate your own client SDK.

      Download OpenAPI specification:
      [https://docs.remapdb.com/openapi.json](https://docs.remapdb.com/openapi.json).



      Following SDK's are automatically generated:

      Language | Link

      ----------|----------

      PHP |
      [https://github.com/remapdb-api/remapdb-php-sdk](https://github.com/remapdb-api/remapdb-php-sdk)

      JavaScript |
      [https://github.com/remapdb-api/remapdb-js-sdk](https://github.com/remapdb-api/remapdb-js-sdk)
    x-traitTag: true
  - name: Subscription
    description: >
      Most of the API methods require an active API subscription. The following
      method allows you to obtain information about your current API
      subscription.


      More info about Remapdb's API subscription can be found here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)
    x-displayName: API Subscription
  - name: Types
    description: >
      Obtain information about the vehicle types. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**
    x-displayName: Vehicle Types
  - name: Manufacturers
    description: >
      Obtain information about vehicle manufacturers. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**
  - name: Models
    description: >
      Obtain information about vehicle models. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**
  - name: Generations
    description: >
      Obtain information about model generations. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**      
  - name: Engines
    description: >
      Obtain information about vehicle engines. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**     
  - name: Search
    description: >
      Searches through manufacturers, models, generations and engines. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**
  - name: VRM lookup
    description: >-
      Ordinary UK VRM lookup requires an active API or MAX full API
      subscription, vdb_read scope and VRM entitlement. Designated saved test
      registrations are free through REST on every plan with a valid scoped API
      key, including trials. Widgets have separate access: Free accounts can use
      purchased credits with zero included allowance.
  - name: ECU observation
    description: >-
      Controlled-access, observation-only binary analysis under /ecu/. Jobs are
      asynchronous; reports are concise and account-scoped.
  - name: DTC lookup
    description: >-
      Synchronous diagnostic-code dictionary lookup included with every active
      API or MAX full API subscription. Requires vdb_read. No worker, lookup
      credits or ECU rollout access required. Descriptions are stored reference
      text, not diagnosis or verified vehicle applicability; not translated by
      Accept-Language.
paths:
  /vrm/uk/lookup:
    post:
      tags:
        - VRM lookup
      summary: Look up a UK registration
      description: >-
        UK registrations only. The `uk` path segment selects the
        country-specific lookup; unsupported countries are not routed to UK
        lookup.


        Requires a valid API key with `vdb_read`. Staff-designated test
        registrations are available on every plan, including API trials,
        exclusively from saved data and without consuming lookup credits. All
        other registrations require an active API or MAX full API subscription
        and UK VRM entitlement. Supply the API key as `Authorization: Bearer
        <API_KEY>`.


        Successful external lookups consume one included unit, then one
        nonexpiring credit. Cached results consume nothing. Identical concurrent
        misses are coalesced across accounts.


        Every retry rechecks account access, test designation and catalog
        visibility. Test records with missing or invalidated saved data return
        `503 test_registration_unavailable`; they never trigger a provider call.
        An `Idempotency-Key` is scoped to the account and normalized plate;
        reusing it for a different plate returns `409`. Failed or not-found
        requests stay final for that key: a deliberately new attempt after
        cooldown needs a new key.


        The `engine` object follows the engine-details layout: use
        `engine.performance` for OEM data and `engine.tuning.stages` for tuned
        data. A matched engine includes the full account-visible catalog details
        and customisations.


        Without a reliable match, known registration specifications fill the
        same fields, `engine.id` is `null`, and tuning stages are explicitly
        estimated. Unknown facts remain null or empty; reliable combustion
        performance can include illustrative template-generated dyno curves.
        Ambiguous hybrid component data is withheld. Estimated stages are
        explicitly labeled and never published into the catalog.


        Broad registration attributes remain under `vehicle.details`. Power is
        metric horsepower (PS), torque is Nm.
      operationId: lookup_uk_vrm
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 8
            maxLength: 128
            pattern: ^[A-Za-z0-9._:-]+$
          description: Unique key shared by retries of this lookup, such as a UUID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                vrm:
                  type: string
                  minLength: 2
                  maxLength: 32
                  example: SA22NNB
              required:
                - vrm
      responses:
        '200':
          description: >-
            Matched, estimated, unavailable or vehicle_not_found result. A
            successful vehicle observation is billable even when matching or
            estimates are unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vrm_result'
        '400':
          description: Invalid registration, body or Idempotency-Key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vrm_error'
        '401':
          description: >-
            Missing vdb_read scope, API access entitlement, or active
            subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vrm_error'
        '403':
          description: >-
            Missing or invalid API key, or VRM access denied (including Free
            accounts).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vrm_error'
        '409':
          description: >-
            Idempotency-Key reused for a different plate, or its observation has
            been invalidated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vrm_error'
        '415':
          description: 'Lookup requires Content-Type: application/json.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vrm_error'
        '429':
          description: >-
            Rate limit or included allowance and credit balance exhausted. Cache
            hits remain available to entitled API or MAX accounts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vrm_error'
          headers:
            Retry-After:
              description: >-
                Seconds until a retry may be attempted when supplied. Reuse the
                same Idempotency-Key to avoid repeating a provider call.
              schema:
                type: integer
        '503':
          description: >-
            Service unavailable, provider unavailable, or
            test_registration_unavailable (missing or invalidated test data; no
            provider fallback).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vrm_error'
          headers:
            Retry-After:
              description: >-
                Seconds until a retry may be attempted when supplied. Reuse the
                same Idempotency-Key to avoid repeating a provider call.
              schema:
                type: integer
      security:
        - bearerAuth: []
components:
  schemas:
    vrm_result:
      type: object
      additionalProperties: false
      properties:
        lookup_id:
          type: integer
          format: int64
          minimum: 0
          maximum: 9007199254740991
        status:
          type: string
          enum:
            - matched
            - estimated
            - unavailable
            - vehicle_not_found
        reason:
          type: string
          nullable: true
          description: >-
            Resolution or estimation reason. combustion_performance_unattributed
            means hybrid combustion power/torque are not separately identified;
            combustion_data_conflicting means component measurements or fuel
            disagree. Such results withhold tuning stages and curves.
        vehicle:
          $ref: '#/components/schemas/vrm_vehicle'
        engine:
          $ref: '#/components/schemas/vrm_engine'
        match:
          $ref: '#/components/schemas/vrm_match'
        provisional_id:
          type: integer
          format: int64
          minimum: 0
          maximum: 9007199254740991
          nullable: true
          description: A separate staging reference, never a catalog engine ID.
        stages:
          type: array
          items:
            $ref: '#/components/schemas/vrm_stage'
          description: >-
            Compact stages retained for compatibility. New engine-style widgets
            can use engine.performance and engine.tuning.stages; both stage
            representations describe the same result.
        cache:
          type: object
          additionalProperties: false
          properties:
            hit:
              type: boolean
            observed_at:
              type: string
              format: date-time
          required:
            - hit
            - observed_at
          nullable: true
        consumption:
          type: string
          enum:
            - none
            - included
            - credits
          description: >-
            Consumption by this request execution. Cached and idempotent replays
            consume none.
        usage:
          oneOf:
            - $ref: '#/components/schemas/vrm_usage'
            - type: object
              nullable: true
              enum:
                - null
          description: >-
            Current usage when normal VRM access is authorized; null for
            test-only access. Test-only access does not create an allowance
            period.
        is_test:
          type: boolean
          description: >-
            True for a staff-designated saved test registration. These lookups
            never consume included or purchased credits.
      required:
        - lookup_id
        - status
        - vehicle
        - engine
        - match
        - provisional_id
        - stages
        - cache
        - consumption
        - usage
        - is_test
    vrm_error:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/error'
    vrm_vehicle:
      type: object
      additionalProperties: false
      properties:
        make:
          type: string
          nullable: true
        model:
          type: string
          nullable: true
        derivative:
          type: string
          nullable: true
        series:
          type: string
          nullable: true
        fuel:
          type: string
          nullable: true
        powertrain:
          type: string
          nullable: true
        aspiration:
          type: string
          nullable: true
        engine_code:
          type: string
          nullable: true
        engine_code_source:
          type: string
          nullable: true
          description: >-
            Engine-code provenance: vehicle_codes, engine_description, or
            smmt_engine_description. Description-derived codes must be
            code-shaped and agree across available description fields; serial
            numbers and registration echoes are excluded. Upstream tool-match
            suggestions do not establish ECU/TCU identity.
        derivative_id:
          type: string
          nullable: true
        vrm:
          type: string
        vehicle_type:
          type: integer
          nullable: true
        year:
          type: integer
          nullable: true
        capacity_cc:
          type: number
          nullable: true
        power_kw:
          type: number
          nullable: true
        power_ps:
          type: number
          nullable: true
        power_bhp:
          type: number
          nullable: true
        torque_nm:
          type: number
          nullable: true
        reported_power:
          type: object
          additionalProperties: false
          properties:
            kw:
              type: number
              nullable: true
            ps:
              type: number
              nullable: true
            bhp:
              type: number
              nullable: true
        details:
          $ref: '#/components/schemas/vrm_vehicle_details'
        combustion_fuel:
          type: string
          nullable: true
          enum:
            - petrol
            - diesel
            - null
        powertrain_type:
          type: string
          nullable: true
          description: >-
            Reported powertrain subtype, for example PHEV, HEV, MHEV, ICE or
            BEV.
        performance_version:
          type: integer
        performance_components:
          $ref: '#/components/schemas/vrm_performance_components'
      required:
        - make
        - model
        - derivative
        - series
        - fuel
        - powertrain
        - aspiration
        - engine_code
        - engine_code_source
        - derivative_id
        - vrm
        - vehicle_type
        - year
        - capacity_cc
        - power_kw
        - power_ps
        - power_bhp
        - torque_nm
        - reported_power
        - details
      nullable: true
      description: >-
        Normalized vehicle observation and comprehensive registration-specific
        details. Power is converted with distinct PS and BHP factors;
        reported_power preserves received values. Full VINs remain internal.
        Null means evidence is missing. Service identity, credentials, billing
        and request metadata are never returned. Hybrid top-level power and
        torque are null; use performance_components with its explicit
        attribution. Original generic values remain in reported_power and
        details and must not be treated as combustion specifications.
    vrm_engine:
      type: object
      additionalProperties: false
      description: >-
        Engine-details layout, matching GET /engines/{engine_id}, plus lookup
        provenance. Matched engines include the visible catalog details and
        account customisations. Unmatched vehicles include known registration
        specifications and available estimated stages; catalog IDs and unknown
        facts are null, unsupported equipment is empty; illustrative combustion
        curves are generated only with reliable component power/torque, known
        fuel/aspiration and a valid unique template. The whole object is null
        for a missing vehicle or a catalog visibility restriction. An
        unavailable estimate may still return known engine details.
      properties:
        capacity:
          description: Engine capacity in cubic cm.
          example: 1800
          nullable: true
          type: integer
        cylinders:
          description: Number of cylinders.
          example: 4
          nullable: true
          type: integer
        ecus:
          description: List of ECU's used in this engine.
          items:
            $ref: '#/components/schemas/engine_ecu'
          maxItems: 1000
          type: array
        engine_code:
          description: Engine code.
          example: XYZ
          maxLength: 2048
          nullable: true
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
        engine_type:
          description: Engine type.
          example: Petrol
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
          nullable: true
        fuel:
          description: Name of the fuel.
          example: Petrol
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
          nullable: true
        id:
          description: >-
            Catalog engine ID when matched; null for registration-derived data.
            provisional_id is a separate review reference and must never be used
            with /engines/{engine_id}.
          example: 1234
          type: integer
          format: int64
          minimum: 1
          maximum: 9007199254740991
          nullable: true
        name:
          description: >-
            Customised catalog name when matched; otherwise a description
            assembled from the registration make and derivative/model.
          example: 1.8i 125hp 170Nm
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
          nullable: true
        performance:
          $ref: '#/components/schemas/vrm_engine_performance'
        slug:
          description: URL-friendly name (slug).
          example: 1-8i-125hp-170nm
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
          nullable: true
        tcus:
          description: List of TCU's used in this engine.
          items:
            $ref: '#/components/schemas/engine_tcu'
          maxItems: 1000
          type: array
        tuning:
          $ref: '#/components/schemas/vrm_engine_tuning'
        year:
          description: Year of manufacture.
          example: 2018
          nullable: true
          type: integer
        origin:
          type: string
          enum:
            - shared
            - private
            - null
          description: Catalog origin when matched; null for registration-derived data.
          nullable: true
        source:
          type: string
          enum:
            - catalog
            - registration
          description: >-
            Whether the engine details come from the account-visible catalog or
            registration observations. Tuning stages carry their own source.
        generation_id:
          type: integer
          format: int64
          minimum: 1
          maximum: 9007199254740991
          nullable: true
          description: Matched catalog placement; null without a reliable catalog match.
        oem_power_ps:
          type: number
          nullable: true
          description: >-
            Compatibility field for OEM metric horsepower (PS). Prefer
            performance.power for engine-details rendering.
        oem_torque_nm:
          type: number
          nullable: true
          description: >-
            Compatibility field for OEM torque in Nm. Prefer performance.torque
            for engine-details rendering.
        powertrain:
          type: string
          nullable: true
        combustion_fuel:
          type: string
          nullable: true
        performance_scope:
          type: string
          enum:
            - combustion
            - unspecified
          description: >-
            Scope of registration-derived power/torque and curves. Matched
            catalog records retain existing catalog semantics.
        estimation_reason:
          type: string
          nullable: true
          enum:
            - combustion_performance_unattributed
            - combustion_data_conflicting
            - estimation_unavailable
            - null
      required:
        - capacity
        - cylinders
        - ecus
        - engine_code
        - engine_type
        - fuel
        - id
        - name
        - performance
        - slug
        - tcus
        - tuning
        - year
        - origin
        - source
        - generation_id
        - oem_power_ps
        - oem_torque_nm
      nullable: true
    vrm_match:
      type: object
      additionalProperties: false
      properties:
        score:
          type: integer
          minimum: 0
          maximum: 100
          description: >-
            Evidence score, not a probability. Names use normalized exact values
            or reviewed aliases. Automatic selection also requires the
            configured evidence checks and an unambiguous engine and generation;
            a high score alone does not guarantee a match. Missing evidence in
            alternative candidates cannot justify selecting one candidate over
            another.
        checks:
          type: object
          additionalProperties:
            type: object
            additionalProperties: false
            properties:
              points:
                type: integer
                format: int64
                minimum: 0
              maximum:
                type: integer
                format: int64
                minimum: 0
              check:
                type: string
                enum:
                  - missing
                  - match
                  - mismatch
            required:
              - points
              - maximum
              - check
        contradictions:
          type: array
          items:
            type: string
        method:
          type: string
          enum:
            - scored
            - reviewed_mapping
      required:
        - score
        - checks
        - contradictions
      nullable: true
    vrm_stage:
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
          format: int64
          minimum: 0
          maximum: 9007199254740991
        origin:
          type: string
          enum:
            - shared
            - private
        stage_number:
          type: integer
        source:
          type: string
          enum:
            - catalog
            - estimated
        formula_version:
          type: integer
          format: int64
          minimum: 0
        power_ps:
          type: number
        power_kw:
          type: number
        torque_nm:
          type: number
        performance_scope:
          type: string
          enum:
            - combustion
          description: >-
            Estimated gains apply to the combustion engine only. Electric and
            combined-system outputs are not estimated.
      required:
        - stage_number
        - source
        - power_ps
        - power_kw
        - torque_nm
      description: >-
        Catalog stages include id and origin. Estimated stages include
        formula_version and have no catalog ID. The current default estimation
        policy returns only Stage 1 and Stage 2, rounding power to whole PS and
        kW and torque to whole Nm. Stage enablement and rounding are versioned
        policy settings; OEM vehicle values retain their original precision.
    vrm_usage:
      type: object
      additionalProperties: false
      properties:
        included_limit:
          type: integer
          format: int64
          minimum: 0
        included_used:
          type: integer
          format: int64
          minimum: 0
        included_reserved:
          type: integer
          format: int64
          minimum: 0
        included_remaining:
          type: integer
          format: int64
          minimum: 0
        credit_balance:
          type: integer
          format: int64
          minimum: 0
        credit_reserved:
          type: integer
          format: int64
          minimum: 0
        credits_available:
          type: integer
          format: int64
          minimum: 0
        resets_at:
          type: string
          format: date-time
          description: Next monthly anniversary in UTC, including for annual subscriptions.
      required:
        - included_limit
        - included_used
        - included_reserved
        - included_remaining
        - credit_balance
        - credit_reserved
        - credits_available
        - resets_at
      example:
        included_limit: 600
        included_used: 6
        included_reserved: 0
        included_remaining: 594
        credit_balance: 100
        credit_reserved: 0
        credits_available: 100
        resets_at: '2026-11-08T11:53:00Z'
    error:
      additionalProperties: false
      description: Error object
      properties:
        code:
          description: >-
            Error code. Typically it will be the same as the returtned HTTP
            response code.
          example: 404
          type: integer
        message:
          description: Error message.
          example: Not found
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
          x-stoplight:
            id: iaxsxsm0kqi9n
      title: Error
      type: object
      x-examples:
        Bad Request:
          code: 400
          message: Bad request / Malformed parameter
        Internal Server Error:
          code: 500
          message: Internal Server Error
        Invalid API key:
          code: 403
          message: Invalid API key
        Method Not Found:
          code: 404
          message: Method not found
        No API Access:
          code: 401
          message: API access is not enabled for this subscription
        No active subscription:
          code: 401
          message: This method requires an active subscription.
        No permissions:
          code: 401
          message: This API key does not have enough permissions
    vrm_vehicle_details:
      type: object
      additionalProperties: true
      description: >-
        Available vehicle-specific attributes in snake_case, grouped
        independently of the upstream response envelope. Values, explicit nulls,
        booleans, lists and units are preserved. Missing sections are omitted,
        and additional vehicle fields may appear. Credentials, service
        identity/provenance, billing, request diagnostics and full VINs are
        excluded. Cached observations supply these details without another
        external lookup.
      properties:
        identification:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Registration, registration dates, manufacture dates, engine serial
            number, VIN suffix and licensing attributes. Full VINs remain
            internal.
        status:
          type: object
          nullable: true
          additionalProperties: true
          description: Import/export/scrap status and vehicle excise duty details.
        history:
          type: object
          nullable: true
          additionalProperties: true
          description: Colour history, keeper changes, plate changes and V5C issue dates.
        technical:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Recorded technical attributes including seats, mass, towing limits
            and capacity.
        model:
          type: object
          nullable: true
          additionalProperties: true
          description: Make, range, model, derivative, series and model production dates.
        classification:
          type: object
          nullable: true
          additionalProperties: true
          description: Vehicle class, taxation class and type approval.
        vehicle_codes:
          type: object
          nullable: true
          additionalProperties: true
          description: Engine code and derivative reference, when supplied.
        powertrain:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Combustion engine, EV/hybrid, battery, charging and transmission
            attributes.
        body_details:
          type: object
          nullable: true
          additionalProperties: true
          description: Body configuration, doors and other body attributes.
        dimensions:
          type: object
          nullable: true
          additionalProperties: true
          description: Dimensions in the units indicated by the field names.
        weights:
          type: object
          nullable: true
          additionalProperties: true
          description: Vehicle and towing weights in the indicated units.
        performance:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Original power, torque, acceleration, top speed and fuel economy
            values and units.
        emissions:
          type: object
          nullable: true
          additionalProperties: true
          description: Emissions standards, CO2 and sound levels.
        safety:
          type: object
          nullable: true
          additionalProperties: true
          description: Safety and crash-test ratings.
        additional_information:
          type: object
          nullable: true
          additionalProperties: true
          description: Warranty and other vehicle attributes.
      example:
        identification:
          vrm: SA22NNB
          date_first_registered: '2022-03-01T00:00:00'
          year_of_manufacture: 2022
        history:
          colour_details:
            current_colour: BLUE
            number_of_colour_changes: 0
        status:
          is_imported: false
          is_scrapped: false
        powertrain:
          transmission:
            transmission_type: Automatic
            number_of_gears: 8
        performance:
          power:
            kw: 131
            ps: 178.2
            bhp: 175.7
          torque:
            nm: 280
    vrm_performance_components:
      type: object
      additionalProperties: false
      properties:
        combustion:
          $ref: '#/components/schemas/vrm_combustion_performance'
        electric_motors:
          type: array
          items:
            $ref: '#/components/schemas/vrm_component_performance'
        combined:
          $ref: '#/components/schemas/vrm_component_performance'
        unattributed:
          $ref: '#/components/schemas/vrm_component_performance'
      required:
        - combustion
        - electric_motors
        - combined
        - unattributed
      description: >-
        Component-specific maxima. Combustion values require explicit engine
        attribution for hybrids. Electric motors are separate entries, never
        summed. Combined values require explicit system attribution and are
        never calculated. Generic hybrid ModelDetails performance is
        unattributed: it may describe the whole vehicle, a component, or mixed
        figures and is not a tuning baseline. Conflicting measurements are null
        with issues. No component attribution is inferred from numerical
        agreement.
    engine_ecu:
      additionalProperties: false
      description: ECU object
      properties:
        manufacturer:
          description: Manufacturer.
          example: Bosch
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
          x-stoplight:
            id: ego5g0wgjbx5z
        name:
          description: Name.
          example: EDC17CP54
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
        id:
          type: integer
          format: int64
          minimum: 1
          maximum: 9007199254740991
          description: >-
            Stable catalogue ID. Private IDs start at 4294967296; all IDs are
            exact JavaScript-safe integers.
        origin:
          type: string
          enum:
            - shared
            - private
          description: >-
            Shared catalogue record or an addition owned by the authenticated
            customer.
        code:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        model:
          type: string
          description: Equipment model; retained for existing API clients.
      title: ECU
      type: object
      x-examples:
        Bosch EDC17:
          manufacturer: Bosch
          name: EDC17CP54
    vrm_engine_performance:
      type: object
      additionalProperties: false
      description: >-
        OEM engine-details layout. Matched catalog behavior is unchanged.
        Registration combustion power/torque are component-specific; generic
        hybrid and electric-motor figures never fill missing combustion maxima.
        Speed and acceleration, if present, remain vehicle-level observations.
        Dyno curves are illustrative template output, never measurements;
        missing or conflicting component inputs or unavailable templates leave
        arrays empty.
      properties:
        power:
          type: number
          nullable: true
          description: >-
            Metric horsepower (PS). OEM registration values retain their
            accuracy; estimated stage outputs use policy rounding.
        power_kw:
          type: number
          nullable: true
          description: >-
            Power in kW, provided for registration-derived OEM and
            estimated-stage performance.
        power_bhp:
          type: number
          nullable: true
          description: >-
            Brake horsepower, provided for registration-derived OEM performance
            when known; distinct from PS.
        torque:
          type: number
          nullable: true
          description: Torque in Nm.
        top_speed:
          type: number
          nullable: true
          description: >-
            Maximum speed in km/h when known. Estimates do not predict this
            value.
        zero_to_hundred:
          type: number
          nullable: true
          description: >-
            0-100 km/h acceleration in seconds when known. Estimates do not
            predict this value.
        dyno_values:
          $ref: '#/components/schemas/engine_performance_dyno'
        dyno_source:
          type: string
          nullable: true
          enum:
            - illustrative
            - null
          description: >-
            Registration-only curve provenance. Null when no curve can be
            generated. Matched catalog responses omit this field.
      required:
        - power
        - torque
        - dyno_values
    engine_tcu:
      additionalProperties: false
      description: TCU object
      properties:
        manufacturer:
          description: Manufacturer.
          example: ZF
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
        name:
          description: Name.
          example: 8HP
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
        id:
          type: integer
          format: int64
          minimum: 1
          maximum: 9007199254740991
          description: >-
            Stable catalogue ID. Private IDs start at 4294967296; all IDs are
            exact JavaScript-safe integers.
        origin:
          type: string
          enum:
            - shared
            - private
          description: >-
            Shared catalogue record or an addition owned by the authenticated
            customer.
        code:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        model:
          type: string
          description: Equipment model; retained for existing API clients.
      title: TCU
      type: object
      x-examples:
        ZF 8HP:
          manufacturer: ZF
          name: 8HP
    vrm_engine_tuning:
      type: object
      additionalProperties: false
      description: >-
        Account-visible tuning data for a matched engine; otherwise empty
        equipment/options lists and available estimated stages.
      properties:
        options:
          description: Available remap options for this engine.
          items:
            $ref: '#/components/schemas/tuning_option'
          maxItems: 1000
          type: array
        read_tools:
          description: List with the tuning tools which can be used to read this engine.
          items:
            $ref: '#/components/schemas/read_tool'
          maxItems: 1000
          type: array
          x-stoplight:
            id: lb5q8g6onza8o
        stages:
          description: List with Remap/Tuning Stages.
          items:
            $ref: '#/components/schemas/vrm_engine_stage'
          maxItems: 1000
          type: array
          x-stoplight:
            id: i6vvnixufrwnf
        work_methods:
          description: List with the methods to use when reading this engine.
          items:
            $ref: '#/components/schemas/work_method'
          maxItems: 1000
          type: array
          x-stoplight:
            id: ppvk2wt69dhp4
      required:
        - options
        - read_tools
        - stages
        - work_methods
    vrm_combustion_performance:
      type: object
      additionalProperties: false
      properties:
        power_kw:
          type: number
          nullable: true
        power_ps:
          type: number
          nullable: true
        power_bhp:
          type: number
          nullable: true
        torque_nm:
          type: number
          nullable: true
        issues:
          type: array
          items:
            type: string
            enum:
              - conflicting_power
              - conflicting_torque
              - conflicting_combustion_fuel
        fuel:
          type: string
          nullable: true
          enum:
            - petrol
            - diesel
            - null
        aspiration:
          type: string
          nullable: true
          enum:
            - turbo
            - na
            - null
      required:
        - power_kw
        - power_ps
        - power_bhp
        - torque_nm
        - issues
    vrm_component_performance:
      type: object
      additionalProperties: false
      properties:
        power_kw:
          type: number
          nullable: true
        power_ps:
          type: number
          nullable: true
        power_bhp:
          type: number
          nullable: true
        torque_nm:
          type: number
          nullable: true
        issues:
          type: array
          items:
            type: string
            enum:
              - conflicting_power
              - conflicting_torque
              - conflicting_combustion_fuel
      required:
        - power_kw
        - power_ps
        - power_bhp
        - torque_nm
        - issues
    engine_performance_dyno:
      additionalProperties: false
      description: Dyno object
      nullable: true
      properties:
        hp:
          description: HP values for plotting a dyno chart.
          items:
            type: integer
            x-stoplight:
              id: p93ihoykl0ya1
          maxItems: 1000
          type: array
          x-stoplight:
            id: vd6hysqxr0wx8
        nm:
          description: Nm values for plotting a dyno chart.
          items:
            type: integer
            x-stoplight:
              id: 6fkv9wbg7h04g
          maxItems: 1000
          type: array
          x-stoplight:
            id: 4jpbgqaf9x9yh
        rpm:
          description: RPM values for plotting a dyno chart.
          items:
            type: integer
            x-stoplight:
              id: wlvp55ibfn59e
          maxItems: 1000
          type: array
      title: Dyno metadata
      type: object
      x-examples:
        Example 1:
          hp:
            - 0
            - 49
            - 87
            - 112
            - 135
            - 140
            - 112
            - 0
            - 0
          nm:
            - 0
            - 238
            - 243
            - 238
            - 233
            - 205
            - 150
            - 0
            - 0
          rpm:
            - 1000
            - 2000
            - 3000
            - 4000
            - 5000
            - 6000
            - 7000
            - 8000
            - 9000
    tuning_option:
      additionalProperties: false
      description: Tuning option object
      properties:
        description:
          type: string
          nullable: true
        name:
          description: Name.
          example: EGR
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
        id:
          type: integer
          format: int64
          minimum: 1
          maximum: 9007199254740991
          description: >-
            Stable catalogue ID. Private IDs start at 4294967296; all IDs are
            exact JavaScript-safe integers.
        origin:
          type: string
          enum:
            - shared
            - private
          description: >-
            Shared catalogue record or an addition owned by the authenticated
            customer.
        code:
          type: string
          nullable: true
      title: Option
      type: object
      x-examples:
        EGR:
          description: Removal of EGR
          name: EGR
    read_tool:
      additionalProperties: false
      description: Read Tool object
      properties:
        manufacturer:
          description: Manufacturer.
          example: Alientech
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
          x-stoplight:
            id: ene9p2f5occpc
        name:
          description: Name.
          example: KESS3
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
        id:
          type: integer
          format: int64
          minimum: 1
          maximum: 9007199254740991
          description: >-
            Stable catalogue ID. Private IDs start at 4294967296; all IDs are
            exact JavaScript-safe integers.
        origin:
          type: string
          enum:
            - shared
            - private
          description: >-
            Shared catalogue record or an addition owned by the authenticated
            customer.
        code:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
      title: Read Tool
      type: object
      x-examples:
        Alientech KESS3:
          manufacturer: Alientech
          name: KESS3
    vrm_engine_stage:
      type: object
      additionalProperties: false
      description: >-
        Tuning stage in the engine-details layout with explicit provenance.
        Estimates currently include Stage 1 and Stage 2, rounded to whole PS, kW
        and Nm. Estimates have null catalog IDs, no inferred modifications, no
        speed/acceleration predictions and optional illustrative combustion-only
        curves.
      properties:
        modifications_required:
          description: Modifications needed.
          example: Aftermarket intercooler and exhaust required.
          maxLength: 2048
          nullable: true
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
          x-stoplight:
            id: nxjtpmqu6xw08
        performance:
          $ref: '#/components/schemas/vrm_engine_stage_performance'
        stage_number:
          description: >-
            Stage display number. Catalog stages have IDs; estimated stages use
            stage_number and formula_version.
          example: 1
          type: integer
        id:
          type: integer
          format: int64
          minimum: 1
          maximum: 9007199254740991
          description: Catalog stage ID, or null for an estimate.
          nullable: true
        origin:
          type: string
          enum:
            - shared
            - private
            - null
          description: Catalog stage origin, or null for an estimate.
          nullable: true
        source:
          type: string
          enum:
            - catalog
            - estimated
        formula_version:
          type: integer
          minimum: 1
          description: >-
            Included only for estimated stages; identifies the calculation
            policy.
        performance_scope:
          type: string
          enum:
            - combustion
          description: >-
            Estimated gains apply to the combustion engine only. Electric and
            combined-system outputs are not estimated.
      required:
        - modifications_required
        - performance
        - stage_number
        - id
        - origin
        - source
    work_method:
      additionalProperties: false
      description: Work method object
      properties:
        name:
          description: Name.
          example: OBD
          maxLength: 2048
          pattern: ^[^\u0000-\u001F\u007F]*$
          type: string
        id:
          type: integer
          format: int64
          minimum: 1
          maximum: 9007199254740991
          description: >-
            Stable catalogue ID. Private IDs start at 4294967296; all IDs are
            exact JavaScript-safe integers.
        origin:
          type: string
          enum:
            - shared
            - private
          description: >-
            Shared catalogue record or an addition owned by the authenticated
            customer.
        code:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        manufacturer:
          type: string
      title: Work method
      type: object
      x-examples:
        OBD:
          name: OBD
    vrm_engine_stage_performance:
      type: object
      additionalProperties: false
      description: >-
        Catalog or estimated stage performance. Calculated values are not
        measured dyno data.
      properties:
        power:
          type: number
          nullable: true
          description: >-
            Metric horsepower (PS). OEM registration values retain their
            accuracy; estimated stage outputs use policy rounding.
        power_kw:
          type: number
          nullable: true
          description: >-
            Power in kW, provided for registration-derived OEM and
            estimated-stage performance.
        torque:
          type: number
          nullable: true
          description: Torque in Nm.
        top_speed:
          type: number
          nullable: true
          description: >-
            Maximum speed in km/h when known. Estimates do not predict this
            value.
        zero_to_hundred:
          type: number
          nullable: true
          description: >-
            0-100 km/h acceleration in seconds when known. Estimates do not
            predict this value.
        dyno_values:
          $ref: '#/components/schemas/engine_performance_dyno'
        dyno_source:
          type: string
          nullable: true
          enum:
            - illustrative
            - null
          description: >-
            Registration-only curve provenance. Null when no curve can be
            generated. Matched catalog responses omit this field.
      required:
        - power
        - torque
        - top_speed
        - zero_to_hundred
        - dyno_values
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |-
        All API methods require Bearer authentication.
        Use your existing API key as the bearer token.

        Authorization header format: `Authorization: Bearer YOUR_API_KEY`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.