VRTMe API Documentation 0.1.1 beta

[ Base URL: https://api.vrtme.ie]

Get a free test API key

VRTMe API

Powered by 4+ data sources, the VRTMe API is capable of delivering instant vrt calculations. The API comes with multiple endpoints, each serving a different use case. Endpoint functionalities include getting a basic vehicle report based on it's UK registration number, provide an estimate of vrt based on vehicle information.

Throughout this documentation you will learn about API structure, methods, potential errors and code examples. In case there any question is left unanswered, please make sure to contact us and our team will be happy to help out.

SSL Connection
All paid subscription plans available on VRTMe.ie come with 256-bit SSL encryption. To connect to the API via SSL, simply use the https protocol instead of standard http.

GET
/api/v1/vehicle-makes

Description

Get a list of vehicle makes available for VRT calculations. This list of vehicles will be updated accordingly when new vehicles become available.

Request

URL

https://api.vrtme.ie/api/v1/vehicle-makes

Method

GET

Response

200

Success

429

You have exceeded your request limit

Success-200:Example
  [
    "ABARTH",
    "ALFA ROMEO",
    "ASIA",
    "AUDI",
    "AUSTIN",
    "BMW",
    "CADILLAC",
    "CARBODIES",
    "CHEVROLET",
    "CHRYSLER",
    "CITROEN",
    "DACIA",
    "DAEWOO",
    "DAIHATSU",
    "DATSUN",
    "DODGE",
    "DS",
    ...
  ]
GET
/api/v1/vehicle-models/<MAKE>

Description

Get the available models for any of the vehicles returned from the /api/v1/vehicle-makes endpoint.
The required vehicle make is case insensitive

Request

URL

https://api.vrtme.ie/api/v1/vehicle-models/<MAKE>

Method

GET

Example
  • /api/v1/vehicle-models/AUDI
  • /api/v1/vehicle-models/audi
  • /api/v1/vehicle-models/alfa%20romeo

Response

200

Success

400

Request data is invalid

429

You have exceeded your daily request limit

Success-200:Example
  [
    "A4 2.7 TDI",
    "A4 2.8",
    "A4 3.0",
    "A4 3.2",
    "A4 CABRIOLET",
    "A5 1.8 TFSI",
    "A5 2.0 TDI",
    "A5 2.0 TFSI",
    "A5 2.7 TDI",
    "A5 3.0 TDI",
    "A5 CABRIOLET",
    "A6 1.8",
    "A6 1.9 TDI",
    "A6 2.0",
    "A6 2.0 TDI",
    ...
  ]
Error-400:Example
  {
   "message": "Vehicle make not found."
  }
POST
/api/v1/vrt-vehicle
Authentication is required

Description

Get VRT(Vehicle Registration Tax), Road Tax & Currency Conversion(GBP to EUR) of a single Vehicle by passing in a Vehicle JSON. This is a bit of information about this endpoint

Request

URL

https://api.vrtme.ie/api/v1/vrt-vehicle

Method

POST

Headers
Body

This is a bit of information about this endpoint

Example
   {
    requestorId: '1234567',
    organisation: 'autotrader',
    vehicle: {
      title: 'Vauxhall Corsa Hatchback Special E 1.4 [75] ecoFLEX Sting 3dr',
      price: '£6,400',
      vehicle_id: '201803285004523',
      year: '2016',
      body_type: 'HATCHBACK',
      odometer: '12,506 MILES',
      transmission: 'MANUAL',
      engine_capacity: '1.4',
      bhp: '74BHP',
      fuel_type: 'PETROL',
      number_of_doors: '3dr'
    }
  }

Response

200

Success

400

Request data is invalid

401

Unrecognised "access_token"

429

You have exceeded your daily request limit

498

Invalid API token "access_token"

Success-200:Example
  {
    requestorId: '1234567',
    organisation: 'autotrader',
    vehicle: {
      _id: 111111,
      body_type: 'COUPE',
      co2: 126,
      currentOMSPEUR: 88888,
      engine_liters: '2.0',
      fuel_type: 'DIESEL',
      irishRoadTax: { oneYear: 888, sixMonths: 888, threeMonths: 88 },
      make: 'AUDI',
      mileageDiscount: 888,
      model: 'A5',
      number_of_doors: 3,
      rating: 0.5038230238238,
      transmission: 'AUTOMATIC',
      variant: '2.0TDI',
      vrtRate: 8888
    }
  }
Error-400:Example
  {
    requestorId: '1234567',
    organisation: 'autotrader',
    error: {
      message: 'ValidationError',
      missing: ['"number_of_doors" is required', '"odometer" must be a string']
    }
    vehicle: {
      title: 'Vauxhall Corsa Hatchback Special E 1.4 [75] ecoFLEX Sting 3dr',
      price: '£6,400',
      vehicle_id: '201803285004523',
      year: '2016',
      body_type: 'HATCHBACK',
      odometer: '12,506 MILES',
      transmission: 'MANUAL',
      engine_capacity: '1.4',
      bhp: '74BHP',
      fuel_type: 'PETROL',
      number_of_doors: '3dr',
      error: {
        message: 'ValidationError',
        missing: ['"number_of_doors" is required', '"odometer" must be a string']
      }
    }
  }
POST
/api/v1/vrt-reg
Authentication is required

Description

Get VRT(Vehicle Registration Tax), Road Tax & Currency Conversion(GBP to EUR) of a single Vehicle by passing in a Vehicle JSON. This is a bit of information about this endpoint

Request

URL

https://api.vrtme.ie/api/v1/vrt-vehicle

Method

POST

Headers
Body

This is a bit of information about this endpoint

Example
   {
    requestorId: '1234567',
    organisation: 'autotrader',
    vehicle: {
      title: 'Vauxhall Corsa Hatchback Special E 1.4 [75] ecoFLEX Sting 3dr',
      price: '£6,400',
      vehicle_id: '201803285004523',
      year: '2016',
      body_type: 'HATCHBACK',
      odometer: '12,506 MILES',
      transmission: 'MANUAL',
      engine_capacity: '1.4',
      bhp: '74BHP',
      fuel_type: 'PETROL',
      number_of_doors: '3dr'
    }
  }

Response

200

Success

400

Request data is invalid

401

Unrecognised "access_token"

429

You have exceeded your daily request limit

498

Invalid API token "access_token"

Success-200:Example
  {
    vehicle: {
      _id: 111111,
      body_type: 'COUPE',
      co2: 126,
      currentOMSPEUR: 88888,
      engine_liters: '2.0',
      fuel_type: 'DIESEL',
      irishRoadTax: { oneYear: 888, sixMonths: 888, threeMonths: 88 },
      make: 'AUDI',
      mileageDiscount: 888,
      model: 'A5',
      number_of_doors: 3,
      rating: 0.5038230238238,
      transmission: 'AUTOMATIC',
      variant: '2.0TDI',
      vrtRate: 8888
    }
  }
Error-400:Example
  {
    requestorId: '1234567',
    organisation: 'autotrader',
    error: {
      message: 'ValidationError',
      missing: ['"number_of_doors" is required', '"odometer" must be a string']
    }
    vehicle: {
      title: 'Vauxhall Corsa Hatchback Special E 1.4 [75] ecoFLEX Sting 3dr',
      price: '£6,400',
      vehicle_id: '201803285004523',
      year: '2016',
      body_type: 'HATCHBACK',
      odometer: '12,506 MILES',
      transmission: 'MANUAL',
      engine_capacity: '1.4',
      bhp: '74BHP',
      fuel_type: 'PETROL',
      number_of_doors: '3dr',
      error: {
        message: 'ValidationError',
        missing: ['"number_of_doors" is required', '"odometer" must be a string']
      }
    }
  }
POST
/api/v1/vehicle-reg
Authentication is required

Description

Get VRT(Vehicle Registration Tax), Road Tax & Currency Conversion(GBP to EUR) of a single Vehicle by passing in a Vehicle JSON. This is a bit of information about this endpoint

Request

URL

https://api.vrtme.ie/api/v1/vrt-vehicle

Method

POST

Headers
Body

This is a bit of information about this endpoint

Example
   {
    requestorId: '1234567',
    organisation: 'autotrader',
    vehicle: {
      title: 'Vauxhall Corsa Hatchback Special E 1.4 [75] ecoFLEX Sting 3dr',
      price: '£6,400',
      vehicle_id: '201803285004523',
      year: '2016',
      body_type: 'HATCHBACK',
      odometer: '12,506 MILES',
      transmission: 'MANUAL',
      engine_capacity: '1.4',
      bhp: '74BHP',
      fuel_type: 'PETROL',
      number_of_doors: '3dr'
    }
  }

Response

200

Success

400

Request data is invalid

401

Unrecognised "access_token"

429

You have exceeded your daily request limit

498

Invalid API token "access_token"

Success-200:Example
  {
    vehicle: {
      _id: 111111,
      body_type: 'COUPE',
      co2: 126,
      currentOMSPEUR: 88888,
      engine_liters: '2.0',
      fuel_type: 'DIESEL',
      irishRoadTax: { oneYear: 888, sixMonths: 888, threeMonths: 88 },
      make: 'AUDI',
      mileageDiscount: 888,
      model: 'A5',
      number_of_doors: 3,
      rating: 0.5038230238238,
      transmission: 'AUTOMATIC',
      variant: '2.0TDI',
      vrtRate: 8888
    }
  }
Error-400:Example
  {
    requestorId: '1234567',
    organisation: 'autotrader',
    error: {
      message: 'ValidationError',
      missing: ['"number_of_doors" is required', '"odometer" must be a string']
    }
    vehicle: {
      title: 'Vauxhall Corsa Hatchback Special E 1.4 [75] ecoFLEX Sting 3dr',
      price: '£6,400',
      vehicle_id: '201803285004523',
      year: '2016',
      body_type: 'HATCHBACK',
      odometer: '12,506 MILES',
      transmission: 'MANUAL',
      engine_capacity: '1.4',
      bhp: '74BHP',
      fuel_type: 'PETROL',
      number_of_doors: '3dr',
      error: {
        message: 'ValidationError',
        missing: ['"number_of_doors" is required', '"odometer" must be a string']
      }
    }
  }