> ## 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.

# Get account UK VRM allowance and credits

> One shared account balance covers every widget, REST API key and MCP client. Included allowance resets at the monthly UTC subscription anniversary; purchased credits never expire. Requires vdb_read, an active API or MAX full API subscription and UK VRM entitlement. Trial API access never grants access to this endpoint. Published allowance revisions apply immediately at their effective date, including during an existing period. The current plan determines the included limit; used and reserved lookups and purchased credits are preserved. A limit below existing consumption leaves zero included lookups remaining. Purchased units remain after cancellation and can be used through widgets on Free, with no included allowance. REST and MCP still require active API or MAX full API access. Retail purchase prices are published independently of provider contract costs.



## OpenAPI

````yaml /openapi-v2.json get /vrm/uk/usage
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/usage:
    get:
      tags:
        - VRM lookup
      summary: Get account UK VRM allowance and credits
      description: >-
        One shared account balance covers every widget, REST API key and MCP
        client. Included allowance resets at the monthly UTC subscription
        anniversary; purchased credits never expire. Requires vdb_read, an
        active API or MAX full API subscription and UK VRM entitlement. Trial
        API access never grants access to this endpoint. Published allowance
        revisions apply immediately at their effective date, including during an
        existing period. The current plan determines the included limit; used
        and reserved lookups and purchased credits are preserved. A limit below
        existing consumption leaves zero included lookups remaining. Purchased
        units remain after cancellation and can be used through widgets on Free,
        with no included allowance. REST and MCP still require active API or MAX
        full API access. Retail purchase prices are published independently of
        provider contract costs.
      operationId: get_uk_vrm_usage
      responses:
        '200':
          description: Current allowance, reservations, credit balance and next reset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vrm_usage'
              examples:
                Included allowance and top-ups:
                  description: >-
                    Matches the active subscription example: uk_vrm_limit is 600
                    + 100 = 700; uk_vrm_remaining is 594 + 100 = 694.
                  value:
                    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'
        '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'
        '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: >-
            Lookup disabled, provider failure, uncertain outcome, or lookup
            still in progress. No automatic provider retry.
          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_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'
    vrm_error:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/error'
    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
  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.