Introduction

Welcome to CarMD API V3 developer documentation.

These APIs primarily function on vehicles sold in the US since 1996 and have coverage for similar vehicles sold in other countries. To get started, please register first.

Authentication

Before being able to use the CarMD APIs, you must register. On registration you will have 2 pieces of information which must be submitted as part of your requests.

  • Partner Token
  • Authorization Key
Note: Please submit this information through your header. It will not work if submitted as parameters.

API Reference

You will need to use this on every call to the CarMD APIs.

REQUEST HEADER
{
  "content-type":"application/json",
  "authorization":"your_auth_key_here",
  "partner-token":"your_partner_token_here"
}                           

Requests

All requests and responses are application/json content type and follow standard HTTP reponse status codes for success and failure.

Status Codes
200 Successful Request
400 Bad Request – Invalid request format
401 Unauthorized – Invalid API Key
402 Request Failed
403 Forbidden – You do not have access to the requested resource
404 Not Found
409 Conflict
429 Too Many Requests
500, 502, 503, 504 Internal Server Error

CarMD API users have 2 options for using the CarMD API services detailed below.

Credits

For those who:

  • Want to start with low upfront costs.
  • Want to use a narrow service set and don't want to be charged for all the services.
  • Have unknown and/or variable usage.

CarMD APIs offers credit model that charges per request. Every request with have a different credit fee, with some being very low compared to other endpoints.

Users may purchase as many or as few credits as they wish to load up their account.

Subscriptions

For those who:

  • Have a known and consistent number of vehicle access / month.
  • Use a large number of services and want to avoid per request charges.

Users may subscribe to a set number of vehicles per month. These vehicles have an grace period of one billing cycle where they may access an unlimited number of services without additional per-request fees. This grace period ends at the user's monthly billing cycle.

At the end of the billing cycle. Any unused subscription vehicles are converted into credits. These credits may be used to handle overflows in instances where vehicles requested by the user's applications exceeds subscription limits.

Use Case:

  • Jon purchases a set of 10 vehicle subscriptions on Jan 01.
  • Jon makes a request on Jan 01 to the GET TSB endpoint with vinA.
  • vinA counts as the first vehicle in their 10 vehicle subscription, leaving him with only 9 remaining open subscriptions.
  • Jon uses vinA to make 5 more requests to different services on Jan 15
  • Jon does not incur any additional charges as this is a subscribed vehicle
  • The month ends on Jan 31st
  • The 9 unused subscriptions are converted into credits.
  • Feb 01, Jon has 10 open subscriptions.
  • Jon makes a request on Feb 02 with vinB.
  • Jon now only has 9 more open subscriptions for the month of Feb.

Response Formatting

Every request response comes with a message and data object. The data object contains the endpoint specific response.

MESSAGE OBJECT
  • code

    Error message code.

  • message

    ok or failed

  • credentials

    valid or invalid

  • version

    v3.0.0

  • endpoint

    Endpoint used for this response

  • count

    Counter for all requests. Increments by one for every request made.

Response Format
{
  "message":{
    "code":0,
    "message":"ok",
    "credentials":"valid",
    "version":"v3.0.0",
    "endpoint":"tsb",
    "counter":101
  }
  "data":{}
}
Codes
0 Successful Request

GET Available Fields

Provides a list of data sets available for a specific vehicle.

With just basic vehicle identification by VIN or YMM, the only fields that will be valid are:

  • Decode
  • Port
  • TSB
  • Maintenance List
  • Recall
  • Warranty
For data on repair or diagnostics, submission of the mileage and dtcs are needed in addition to the vehicle information.

To check the maintenance and upcoming fields, mileage information is required. For clarity maintenance is strictly maintenance at a certain mileage, while maintenance list is the all the maintenance items for that vehicle. Maintenance requires mileage, while Maintenance List does not.

Special note regarding repair and diagnostics: These fields will only work with VIN parameter and will not work with YMM parameters.

HTTP REQUEST
GET /fields?vin=<vin>
GET /fields?vin=<vin>&mileage=<mileage>
GET /fields?vin=<vin>&mileage=<mileage>&dtc=<dtc>

GET /fields?year=<year>&make=<make>&model=<model>
GET /fields?year=<year>&make=<make>&model=<model>&mileage=<mileage>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/fields?vin=<vin>
GET http://api.carmd.com/v3.0/fields?year=<year>&make=<make>&model=<model>

Year, Make, Model, Engine parameter information is provided from GET Year, Make, Model, Engine endpoints.

PARAMETERS (option 1)
  • vin

    Vehicle identification number

  • mileage optional

    The odometer of this vehicle. Needed for maintenence, repair, and diagnostics fields.

  • dtc optional

    The code of this vehicle. Needed for repair and diagnostics fields.

PARAMETERS (option 2)
  • year

    Vehicle year

  • make

    Vehicle make

  • model

    Vehicle model

  • mileage optional

    The odometer of this vehicle. Needed for maintenence, repair, and diagnostics fields.

API Reference
ENDPOINT
http://api.carmd.com/v3.0/fields?vin=1GNALDEK9FZ108495
http://api.carmd.com/v3.0/fields?year=2015&make=CHEVROLET&model=EQUINOX
REQUEST
{
  "vin":"1GNALDEK9FZ108495"
}
{
  "year":"2015",
  "make":"CHEVROLET",
  "model":"EQUINOX"
}
RESPONSE
{
  "message":{...},
  "data":{
    "decode":true,
    "port":true,
    "maint":false,
    "maintlist":true,
    "repair":false,
    "diag":false,
    "upcoming":false,
    "tsb":true,
    "recall":true,
    "warranty":false
  }
}
API Reference
ENDPOINT
http://api.carmd.com/v3.0/fields?vin=19XFA1F87AE030552&mileage=50000&dtc=P0102
REQUEST
{
  "vin":"19XFA1F87AE030552",
  "mileage":50000,
  "dtc":"P0102"
}
RESPONSE
{
  "message":{...},
  "data":{
    "decode":true,
    "port":true,
    "maint":true,
    "maintlist":true,
    "repair":true,
    "diag":true,
    "upcoming":true,
    "tsb":true,
    "recall":true,
    "warranty":true
  }
}

GET VIN Decode

Decodes a VIN to its year, make, model, and engine. Covers vehicles from 1981 to current year.

This endpoint provides the following data:

  • Year
  • Make
  • Model
  • Manufacturer
  • Engine
  • Trim
  • Transmission

HTTP REQUEST
GET /decode?vin=<vin>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/decode?vin=<vin>

PARAMETERS (option 1)
  • vin

    Vehicle identification number

API Reference
ENDPOINT
http://api.carmd.com/v3.0/decode?vin=1GNALDEK9FZ108495
REQUEST
{
  "vin":"1GNALDEK9FZ108495"
}
RESPONSE
{
  "message":{...},
  "data":{
    "year":2015,
    "make":"CHEVROLET",
    "model":"EQUINOX",
    "manufacturer": "GENERAL MOTORS",
    "engine":" L4, 2.4L; DOHC; 16V; DI; FFV",
    "trim": "LTZ",
    "transmission": "AUTOMATIC"
  }
}

GET VIN Decode Enhanced

Coming soon! This endpoint is not yet available but will be an enhanced version of VIN decode.

Decodes a VIN to its year, make, model, engine, and additional data.

This endpoint provides the following data:

  • Year
  • Make
  • Model
  • Engine

HTTP REQUEST
GET /decode_enh?vin=<vin>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/decode_enh?vin=<vin>

PARAMETERS (option 1)
  • vin

    Vehicle identification number

API Reference
ENDPOINT
http://api.carmd.com/v3.0/decode_enh?vin=1GNALDEK9FZ108495
REQUEST
{
  "vin":"1GNALDEK9FZ108495"
}
RESPONSE
{
  "message":{...},
  "data":{
    "year":2015,
    "make":"CHEVROLET",
    "model":"EQUINOX",
    "engine":"L4,2.4L;DOHC;16V;DI;FFV"
  }
}

GET OBD2 Port Location

Provides the OBD2 port location where one would plug in a dongle into their vehicle. This API provides an image location for the general area of the plugin location as well as a detailed real-life image of the plug itself.

View this API in action, https://www.carmd.com/wp/locating-the-obd2-port-or-dlc-locator/

This endpoint provides the following data:

  • Url to image containing location of port
  • Number value to location of port
  • Url to image of real life image of port
  • Access notes mentioning if the port is covered or uncovered, if special access is necessary, etc

HTTP REQUEST
GET /port?vin=<vin>
GET /port?year=<year>&make=<make>&model=<model>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/port?vin=<vin>
GET http://api.carmd.com/v3.0/port?year=<year>&make=<make>&model=<model>

Year, Make, Model, Engine parameter information is provided from GET Year, Make, Model, Engine endpoints.

PARAMETERS (option 1)
  • vin

    Vehicle identification number

PARAMETERS (option 2)
  • year

    Vehicle year

  • make

    Vehicle make

  • model

    Vehicle model

API Reference
ENDPOINT
http://api.carmd.com/v3.0/port?vin=1GNALDEK9FZ108495
http://api.carmd.com/v3.0/port?year=2015&make=CHEVROLET&model=EQUINOX
REQUEST
{
  "vin":"1GNALDEK9FZ108495"
}
{
  "year":"2015",
  "make":"CHEVROLET",
  "model":"EQUINOX"
}
RESPONSE
{
  "message":{...},
  "data":{
    "location_img": "http://api2.carmd.com/v2.0/Content/dlc/position/2.jpg"
    "location_value":2,
    "access_img":"https://secure-downloads.innova.com/dlc-location-images-wm/chevrolet/equinox/equinox-2-cmd.jpg?Expires=1529947955&Signature=YdnADor-AWZ6cIydvBLJNWuAc9Wi4axsmx1kmmgc3Wb~OZafjgRPpO7X1w0rbZm-BSh4a3byoAOmucKIVbrZoClcHrV0QZ6b58hum9w005Q-0YbUwcfentrcOkrT5VXM1sL-xe3~s-egf18TUciCX8oZBGh5RyLa9SFprEb74vfu9fpLpBxzqAN4n6mV2~z0WTfVjTVWPEVjoNEro2ro4EMP7LjpkKRf8KCGsTexCNkVh1P3MzvZcpDUV9TE9dfbltanvv9fVt9g12qU7GfoCTEZTCOnlkfUzaFTAcHOdnrQCDEp5m8ZVlAFrh104X4xHqWMZ3HnDySWoArAbnvpyA__&Key-Pair-Id=APKAJVI4C2YLKAQ7KO6A",
    "access_notes":"uncovered",
    "notes":"Driver Side - Under Lower Left Side of Dashboard"
  }
}

GET Maintenance

Gets a vehicle's maintenance information within +-10,000 miles of the submitted mileage. The maintenance is both OEM scheduled maintenance and additional maintenance items that may not be part of an OEM's regular schedule. Can use VIN or year, make, mile to fetch the data.

This endpoint provides the following data:

  • Name of item
  • Due mileage
  • Cost of repair
  • Parts needed for repair

HTTP REQUEST
GET /maint?vin=<vin>&mileage=<mileage>
GET /maint?year=<year>&make=<make>&model=<model>&mileage=<mileage>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/maint?vin=<vin>&mileage=<mileage>
GET http://api.carmd.com/v3.0/maint?year=<year>&make=<make>&model=<model>&mileage=<mileage>

Year, Make, Model, Engine parameter information is provided from GET Year, Make, Model, Engine endpoints.

PARAMETERS (option 1)
  • vin

    Vehicle identification number

  • mileage

    Miles driven by this vehicle.

PARAMETERS (option 2)
  • year

    Vehicle year

  • make

    Vehicle make

  • model

    Vehicle model

  • mileage

    Miles driven by this vehicle.

API Reference
ENDPOINT
http://api.carmd.com/v3.0/maint?vin=1GNALDEK9FZ108495&mileage=51000
http://api.carmd.com/v3.0/maint?year=2015&make=CHEVROLET&model=EQUINOX&mileage=51000
REQUEST
{
  "vin":"1GNALDEK9FZ108495",
  "mileage":51000
}
{
  "year":"2015",
  "make":"CHEVROLET",
  "model":"EQUINOX",
  "mileage":51000
}
RESPONSE
{
  "message":{...},
  "data":[{
    "desc":"Inspect For Fluid Leaks",
    "due_mileage":52500,
    "is_oem":True,
    "repair":{
      "repair_difficulty":2,
      "repair_hours":0.0,
      "labor_rate_per_hour":106.38,
      "part_cost":6.15,
      "labor_cost":0.0,      
      "misc_cost":0.0,
      "total_cost":6.15
    },
    "parts":[{
      "desc":"Engine Oil",
      "manufacturer":"",
      "price":"6.15",
      "qty":"1"
    }]
  },
  {...}]
}

GET Maintenance List

Get the entire maintenace schedule of a vehicle. The maintenance is both OEM scheduled maintenance and additional maintenance items that may not be part of an OEM's regular schedule. Can use VIN or year to fetch the data.

This endpoint provides the following data:

  • Name of item
  • Due mileage
  • Miles between each recurrance
  • Cost of repair
  • Parts needed for repair

HTTP REQUEST
GET /maint?vin=<vin>
GET /maint?year=<year>&make=<make>&model=<model>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/maint?vin=<vin>
GET http://api.carmd.com/v3.0/maint?year=<year>&make=<make>&model=<model>

Year, Make, Model, Engine parameter information is provided from GET Year, Make, Model, Engine endpoints.

PARAMETERS (option 1)
  • vin

    Vehicle identification number

PARAMETERS (option 2)
  • year

    Vehicle year

  • make

    Vehicle make

  • model

    Vehicle model

RESPONSE
  • is_oem

    If true, this item is part of the OEM's recommended scheduled maintenance. Your user would be able to find this item in their vehicle handbook.

    If false, this item is not part of the OEM's recommended scheduled maintenance. It is an item that is predicted to fail and need regular maintenance. This item is not the same as Upcoming Repairs.

  • is_cycle

    If true, this item has a regular mileage interval of maintenance.

    If false, this item is a one off maintenance item or has an irregular maintenance schedule.

  • cycle_mileage

    If is_cycle is true, this will provide this item's recurrence in miles.

    If is_cycle is false, this value will be -1

API Reference
ENDPOINT
http://api.carmd.com/v3.0/maintlist?vin=1GNALDEK9FZ108495
http://api.carmd.com/v3.0/maintlist?year=2015&make=CHEVROLET&model=EQUINOX
REQUEST
{
  "vin":"1GNALDEK9FZ108495"
}
{
  "year":"2015",
  "make":"CHEVROLET",
  "model":"EQUINOX"
}
RESPONSE
{
  "message":{...},
  "data":[{
    "desc": "Inspect Steering & Suspension Components",
    "due_mileage": 7500,
    "is_oem": true,
    "is_cycle": true,
    "cycle_mileage": 7500,
    "repair": {
      "repair_difficulty": 2,
      "repair_hours": 0,
      "labor_rate_per_hour": 101.44,
      "part_cost": 166.51,
      "labor_cost": 0,
      "misc_cost": 0,
      "total_cost": 166.51
    },
    "parts": [{
      "desc": "Steering Tie Rod End",
      "manufacturer": "",
      "price": 108.03,
      "qty": 1
    },{
      "desc": "Steering Tie Rod End",
      "manufacturer": "",
      "price": 58.48,
      "qty": 1
    }]
  },
  {...}]
}

GET Repair

Get a vehicle's repair information based on its check engine light data. This service covers SAE public standard codes and OEM non-standard codes.

This system uses a form of intelligent analysis to derive repairs and understands that a code is not tied to a specific part but may be a symptom of another underlying issue.

As a result, it will often respond with a single repair that it is 99% certain. In cases where the system is not as certain, it will respond with a few options. These options are ordered from most likely to least likely.

This endpoint provides the following data:

  • Name and urgency of repair
  • Cost of repair
  • Difficulty of repair (1=anyone can do, 5=requires technical expertise)
  • Parts needed for repair
  • TSB associated with repair

HTTP REQUEST
GET /repair?vin=<vin>&mileage=<mileage>&dtc=<dtc>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/repair?vin=<vin>&mileage=<mileage>&dtc=<dtc>

PARAMETERS
  • vin

    Vehicle identification number

  • mileage

    Miles driven by this vehicle.

  • dtc

    The required DTC code must be the primary code presented by the vehicle. This code is part of the dataset containing the freeze frame information. If the code is found on its own or alongside other codes (a series of pcodes) then those codes are likely pending or stored codes and not the main code for the check engine light.

API Reference
ENDPOINT
http://api.carmd.com/v3.0/repair?vin=1GNALDEK9FZ108495&mileage=51000&dtc=p0420
REQUEST
{
  "vin":"1GNALDEK9FZ108495",
  "mileage":51000,
  "dtc":"p0420"
}
RESPONSE
{
  "message":{...},
  "data":[{
    "desc":"Replace Catalytic Converter(s) with new OE Catalytic Converter(s),
    "urgency":2,
    "urgency_desc":"Repair immediately if drivability issues are present. Threat to essential system components if not repaired as soon as possible.",
    "repair":{
      "difficulty":3,
      "hours":2.3,
      "labor_rate_per_hour":106.38,
      "part_cost":1967.01,
      "labor_cost":244.674,
      "misc_cost":25,
      "total_cost":2236.684
    },
    "parts":[{
      "desc":"Catalytic Converter",
      "manufacturer":"",
      "price":683.67,
      "qty":"1"
    },{
      "desc":"Catalytic Converter",
      "manufacturer":"",
      "price":1283.34,
      "qty":"1"
    }],
    "tsb":[{
      "id":118676,
      "manufacturer_number":"07-00-89-037K",
      "desc":"Warranty Administration - Courtesy Transportation and Roadside Assistance Programs",
      "categories":["Tools & Hardware"]
      "file_name":"4824780",
      "file_url":"http://downloads.innova.com/tsb-files/118000/4824780.pdf",
      "issue_date":"2017-06-23T00:00:00",
      "updated_date":"2017-10-10T00:00:00"
    },{...}]
  },
  {...}]
}

GET Diagnostics

Get a vehicle's diagnostic information based on its check engine light data. This service covers SAE public standard codes and OEM non-standard codes.

This endpoint contains information a consumer may find useful. This data is prefixed by “layman”. Additional information that may be useful for the more technically inclined is prefixed by “tech”.

This endpoint provides the following data:

  • Effects on vehicle if code is not resolved
  • System responsible for issuing this code
  • Layman’s version of the code definition, conditions for setting of the code, and importance of this code

HTTP REQUEST
GET /diag?vin=<vin>&mileage=<mileage>&dtc=<dtc>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/diag?vin=<vin>&mileage=<mileage>&dtc=<dtc>

PARAMETERS
  • vin

    Vehicle identification number

  • mileage

    Miles driven by this vehicle.

  • dtc

    Primary diagnostic trouble code.

API Reference
ENDPOINT

http://api.carmd.com/v3.0/diag?vin=1GNALDEK9FZ108495&mileage=51000&dtc=p0420
REQUEST
{
  "vin":"1GNALDEK9FZ108495",
  "mileage":51000,
  "dtc":"p0420"
}
RESPONSE
{
  "message":{...},
  "data":{
    "code":"P0420",
    "urgency":2,
    "urgency_desc":"Repair immediately if drivability issues are present. Threat to essential system components if not repaired as soon as possible.",
    "effect_on_vehicle":"This condition will prevent the vehicle from running at its optimum efficiency and fuel economy may suffer.",
    "responsible_system":"Sensors indicate the catalytic converter is not reducing exhaust gas emissions properly.",
    "layman_definition":"Catalyst System Efficiency Below Threshold (Bank 1)",
    "tech_definition":"Catalyst System Low Efficiency (Bank 1)",
  }
}

GET Upcoming Repairs

Provides insight into issues that this vehicle may experience in the next 12 months.

This endpoint provides the following data:

  • Repair name of this issue
  • Likelihood of this issue occurring
  • Cost of repair
  • Repair difficulty

HTTP REQUEST
GET /upcoming?vin=<vin>&mileage=<mileage>
GET /upcoming?year=<year>&make=<make>&model=<model>&mileage=<mileage>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/upcoming?vin=<vin>&mileage=<mileage>
GET http://api.carmd.com/v3.0/upcoming?year=<year>&make=<make>&model=<model>&mileage=<mileage>

Year, Make, Model, Engine parameter information is provided from GET Year, Make, Model, Engine endpoints.

PARAMETERS (option 1)
  • vin

    Vehicle identification number

  • mileage

    Miles driven by this vehicle.

PARAMETERS (option 2)
  • year

    Vehicle year

  • make

    Vehicle make

  • model

    Vehicle model

  • mileage

    Miles driven by this vehicle.

API Reference
ENDPOINT
http://api.carmd.com/v3.0/upcoming?vin=1GNALDEK9FZ108495&mileage=51000
http://api.carmd.com/v3.0/upcoming?year=2015&make=CHEVROLET&model=EQUINOX&mileage=51000
REQUEST
{
  "vin":"1GNALDEK9FZ108495",
  "mileage":51000
}
{
  "year":"2015",
  "make":"CHEVROLET",
  "model":"EQUINOX",
  "mileage":51000  
}
RESPONSE
{
  "message":{...},
  "data":[{
    "desc":"Replace Camshaft Position (CMP) Actuator Solenoid",
    "probability":0.57,
    "hours":1.96,
    "part_cost":144.18,
    "labor_cost":208.9,
    "misc_cost":25.0,
    "total_cost":378.09
  },  {
    "desc":"Replace Variable Valve Timing (VVT) Solenoid",
    "probability":0.19,
    "hours":0.6,
    "part_cost":58.21,
    "labor_cost":63.82,
    "misc_cost":25.0,
    "total_cost":147.03
  },{...}]
}

GET TSB

Provides a vehicle's technical service bulletins. Bulletins include a summary and PDF and are segmented into categories.

This endpoint provides the following data:

  • TSB Name
  • TSB summary
  • TSB PDF

HTTP REQUEST
GET /tsb?vin=<vin>
GET /tsb?year=<year>&make=<make>&model=<model>&engine=<engine>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/tsb?vin=<vin>
GET http://api.carmd.com/v3.0/tsb?year=<year>&make=<make>&model=<model>&engine=<engine>

Year, Make, Model, Engine parameter information is provided from GET Year, Make, Model, Engine endpoints.

PARAMETERS (option 1)
  • vin

    Vehicle identification number

PARAMETERS (option 2)
  • year

    Vehicle year

  • make

    Vehicle make

  • model

    Vehicle model

  • engine

    Vehicle engine

API Reference
ENDPOINT
http://api.carmd.com/v3.0/tsb?vin=1GNALDEK9FZ108495
http://api.carmd.com/v3.0/tsb?year=2015&make=CHEVROLET&model=EQUINOX&engine=L4,2.4L;DOHC;16V;DI;FFV
REQUEST
{
  "vin":"1GNALDEK9FZ108495"
}
{
  "year":"2015",
  "make":"CHEVROLET",
  "model":"EQUINOX",
  "engine":"L4,2.4L;DOHC;16V;DI;FFV"
}
RESPONSE
{
  "message":{...},
  "data":[{
    "id":118676,
    "manufacturer_number":"07-00-89-037K",
    "desc":"Warranty Administration - Courtesy Transportation and Roadside Assistance Programs",
    "categories":["Tools & Hardware"]
    "file_name":"4824780",
    "file_url":"http://downloads.innova.com/tsb-files/118000/4824780.pdf",
    "issue_date":"2017-06-23T00:00:00",
    "updated_date":"2017-10-10T00:00:00"
  },{
    "id":118672,
    "manufacturer_number":"15086A",
    "desc":"Customer Satisfaction - OnStar System Inoperative - Chip Corruption",
    "categories":["Recall"]
    "file_name":"4828709",
    "file_url":"http://downloads.innova.com/tsb-files/118000/4828709.pdf",
    "issue_date":"2017-06-22T00:00:00",
    "updated_date":"2017-10-10T00:00:00"
  },{...}] 
}  

GET Safety Recalls

Provides the safety recalls on a vehicle.

This endpoint provides the following data:

  • Description and information on the safety recall
  • Date recall was issued

HTTP REQUEST
GET /recall?vin=<vin>
GET /recall?year=<year>&make=<make>&model=<model>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/recall?vin=<vin>
GET http://api.carmd.com/v3.0/recall?year=<year>&make=<make>&model=<model>

Year, Make, Model, Engine parameter information is provided from GET Year, Make, Model, Engine endpoints.

PARAMETERS (option 1)
  • vin

    Vehicle identification number

PARAMETERS (option 2)
  • year

    Vehicle year

  • make

    Vehicle make

  • model

    Vehicle model

API Reference
ENDPOINT
http://api.carmd.com/v3.0/recall?vin=1GNALDEK9FZ108495
http://api.carmd.com/v3.0/recall?year=2015&make=CHEVROLET&model=EQUINOX
REQUEST
{
  "vin":"1GNALDEK9FZ108495"
}
{
  "year":"2015",
  "make":"CHEVROLET",
  "model":"EQUINOX"
}
RESPONSE
{
  "message":{...},
  "data":[{
    "desc":""GENERAL MOTORS LLC (GM) IS RECALLING CERTAIN MODEL YEAR 2015 BUICK LACROSSE, CADILLAC XTS, CHEVROLET CAMARO, EQUINOX, MALIBU, AND GMC TERRAIN VEHICLES.  THE AFFECTED VEHICLES HAVE FRONT SEAT-MOUNTED SIDE IMPACT AIR BAGS WHOSE INFLATOR MAY RUPTURE UPON ITS DEPLOYMENT.",
    "corrective_action":" GM WILL NOTIFY OWNERS, AND DEALERS WILL REPLACE THE SIDE IMPACT AIR BAG MODULES, FREE OF CHARGE. THE RECALL BEGAN ON OCTOBER 19, 2015.  OWNERS MAY CONTACT BUICK CUSTOMER SERVICE AT 1-800-521-7300, CHEVROLET CUSTOMER SERVICE AT 1-800-222-1020, CADILLAC CUSTOMER SERVICE AT 1-800-458-8006, OR GMC CUSTOMER SERVICE AT 1-800-462-8782.  GM'S NUMBER FOR THIS RECALL IS 01320.",
    "consequence":""IN THE EVENT OF A CRASH NECESSITATING DEPLOYMENT OF ONE OR BOTH OF THE SIDE IMPACT AIR BAGS, THE AIR BAG'S INFLATOR MAY RUPTURE AND THE AIR BAG MAY NOT PROPERLY INFLATE. THE RUPTURE COULD CAUSE METAL FRAGMENTS TO STRIKE THE VEHICLE OCCUPANTS, POTENTIALLY RESULTING IN SERIOUS INJURY OR DEATH.  ADDITIONALLY, IF THE AIR BAG DOES NOT PROPERLY INFLATE, THE DRIVER OR PASSENGER IS AT AN INCREASED RISK OF INJURY.",
    "recall_date":"1/16/2015",
    "campaign_number":"15V666000",
    "recall_number":"17668"
  },
  {...}]
}

GET Vehicle Warranty

Provides the warranty status on a vehicle.

This endpoint provides the following data:

  • Warranty name
  • Warranty description
  • Warranty qualitifications/limits
  • If warranty is transferable between owners.

HTTP REQUEST
GET /warranty?vin=<vin>
GET /warranty?year=<year>&make=<make>&model=<model>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/warranty?vin=<vin>
GET http://api.carmd.com/v3.0/warranty?year=<year>&make=<make>&model=<model>

Year, Make, Model, Engine parameter information is provided from GET Year, Make, Model, Engine endpoints.

PARAMETERS (option 1)
  • vin

    Vehicle identification number

PARAMETERS (option 2)
  • year

    Vehicle year

  • make

    Vehicle make

  • model

    Vehicle model

API Reference
ENDPOINT
http://api.carmd.com/v3.0/warranty?vin=1GNALDEK9FZ108495
http://api.carmd.com/v3.0/warranty?year=2015&make=CHEVROLET&model=EQUINOX
REQUEST
{
  "vin":"1GNALDEK9FZ108495"
}
{
  "year":"2015",
  "make":"CHEVROLET",
  "model":"EQUINOX"
}
RESPONSE
{
  "message":{...},
  "data":[{
    "type":"Electric/Hybrid",
    "criteria":"8 year / 100,000 miles ",
    "note":" Battery components only ",
    "max_miles":100000,
    "max_year ":8,
    "transferable":true
  },{
    "type":"Basic",
    "criteria":"3 year / 36,000 miles",
    "note":"",
    "max_miles":36000,
    "max_year ":3,
    "transferable":true
  },{...}]
}

GET Vehicle Image

Provides an image of the vehicle.

Note: Although this endpoint accepts a VIN the provided resource will be a generic image of that year make and model.

HTTP REQUEST
GET /image?vin=<vin>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/image?vin=<vin>

PARAMETERS (option 1)
  • vin

    Vehicle identification number

API Reference
ENDPOINT
http://api.carmd.com/v3.0/image?vin=5TFEV54198X043410
REQUEST
{
  "vin":"5TFEV54198X043410"
}
RESPONSE
{
  "message":{...},
  "data":[{
    "image":"image_of_vehicle_here"
  }]
}

GET Year, Make, Model, Engine

This endpoint can be used to assist users to determining their year, make, model, and engine as an alternative to using their VINs.

HTTP REQUEST
GET /year
GET /make?year=<year>
GET /model?year=<year>&make=<make>
GET /engine?year=<year>&make=<make>&model=<model>

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/year
GET http://api.carmd.com/v3.0/make?year=<year>
GET http://api.carmd.com/v3.0/model?year=<year>&make=<make>
GET http://api.carmd.com/v3.0/engine?year=<year>&make=<make>&model=<model>

YEAR PARAMETERS
  • None

    There are no parameters for the year endpoint

MAKE PARAMETERS
  • Year

    Int. This parameter only takes the years provided by the /year endpoint.

MODEL PARAMETERS
  • Year

    Int. This parameter only takes the years provided by the /year endpoint.

  • Make

    String. This parameter only takes the makes provided by the /make endpoint.

ENGINE PARAMETERS
  • Year

    Int. This parameter only takes the years provided by the /year endpoint.

  • Make

    String. This parameter only takes the makes provided by the /make endpoint.

  • Model

    String. This parameter only takes the models provided by the /model endpoint.

GET Year API Reference
ENDPOINT
http://api.carmd.com/v3.0/year
REQUEST
{}
RESPONSE
{
  "message":{...},
  "data":[ "2018", "2017", "2016", "2015", "2014", "2013", "2012", "2011", "2010", "2009", "2008", "2007", "2006", "2005","2004", "2003", "2002", "2001", "2000", "1999", "1998", "1997", "1996"]
}
GET Make API Reference
ENDPOINT
http://api.carmd.com/v3.0/make?year=2015
REQUEST
{
  "year":2015
}
RESPONSE
{
  "message":{...},
  "data":[ "ACURA", "Alfa Romeo", "Aston Martin", "Bently", "BMW", "Buick", "Cadillac", "Chevrolet", "Chrysler", "Dodge", "Ferrari", "Fiat", "Ford", "GMC","Honda", "Hyundai", "..."]
}
GET Model API Reference
ENDPOINT
http://api.carmd.com/v3.0/model?year=2015&make=ACURA
REQUEST
{
  "year":2015,
  "make":"ACURA"
}
RESPONSE
{
  "message":{...},
  "data":[ "ILX", "MDX", "RDX", "RLX", "TLX"]
}
GET Engine API Reference
ENDPOINT
http://api.carmd.com/v3.0/engine?year=2015&make=ACURA&model=RLX
REQUEST
{
  "year":2015,
  "make":"ACURA",
  "model":"RLX"
}
RESPONSE
{
  "message":{...},
  "data":["V6, 3.5L; SOHC; 24V; SEFI","V6, 3.5L; SOHC; 24V; SEFI; Hybrid"]
}

GET Credits

The remaining number of credits on this account.

This endpoint provides the following data:

  • Credit count

HTTP REQUEST
GET /credits

ENDPOINT DEFINITION
GET http://api.carmd.com/v3.0/credits

API Reference
ENDPOINT
http://api.carmd.com/v3.0/credits
REQUEST
{}
RESPONSE
{
  "message":{...},
  "data":{
    "credits":1000
  } 
}