EDRfinder API

The EDRfinder API allows you to access most of the data that we offer in EDRfinder through an automated process without interactively using the EDRfinder's web based interface. This enables you to have your systems make requests against our database in order to integrate EDRfinder into your inhouse applications.

Overview

The EDRfinder API is a RESTful Webservice that is very easy to integrate with existing applications. All communication takes place using the standard HTTPS protocol, just like usual Web access from Internet Browsers like Firefox or Chrome.

Two different types of data can be retrieved through the API:

First selected information about vehicle data that is available in our database can be retrieved as a dataset in industry standard formats like XML or JSON. This data can be fed into other systems for further processing or display.

Secondly we offer Vehicle Information Sheets as PDF documents that represent the information in human readable form. These documents can be retrieved in various languages like English, German, French, Italian and Spanish. Downloaded documents can be stored in local systems for further reference.

Access to the EDRfinder API is charged on a pay-per-use basis like access through the Web Interface but we also offer discounted bulk access packages for high volume requests. Please contact us for a quote.


Base URL

Access to the EDRfinder API can only be made through HTTPS. We do not support HTTP. The base URL of the EDRfinder production API (v2) is

for all requests. Using this endpoint always requires an authentication as described below. We also provide a demo endpoint at

Requests against this endpoint do not require authentication and can be freely used for evaluation and development purposes. Please send us a message if you plan to generate large volume requests (over 1.000 per hour) against the demo endpoint.


Authorization

All production requests to the EDRfinder API require you to provide an authorization token. You must include an Authorization header in all your requests that contains your secret authorization token which is accessible through your account page in the EDRfinder web application.


Retrieving Resources with the HTTP GET Method

You can retrieve data from the EDRfinder API by GETting an URL. The easiest way to do this is to copy and paste a URL into your web browser's address bar or you can also send a GET request from any HTTPS capable application.


Possible GET Response Status Codes

Whenever you send a GET request the EDRfinder API will send back a response to you. The following responses are possible.


Using GET requests to access data

GET vehicle information by selecting make, model, my

You can request information about a vehicle by sending a GET request for a vehicle and specify Make, Model and MY.

You always have to set the following parameters:

An example request for data about an 2019 Audi A3 in JSON format could look like this.

You can paste the URL above into your browser's address bar or try by clicking here. Another example request for data about an 2019 Audi A3 in PDF format could look like this.

You can paste the URL above into your browser's address bar or try by clicking here. Optionally you can specify the language of the response.

If you do not provide the lang parameter at all or specify a value that is not supported the default response language will be in english. The following example request will get the data in PDF format and in french language.

You can paste the URL above into your browser's address bar or try by clicking here.

GET vehicle information by VIN query

If you do not know make, model and model year for a vehicle of interest but have the VIN you can request information about the vehicle by sending a GET request for a vehicle and provide it's VIN.

You always have to set the following parameters:

An example request for data about an 2018 Ford Kuga in JSON format could look like this.

You can paste the URL above into your browser's address bar or try by clicking here. Another example request for data about this 2018 Ford Kuga in PDF format could look like this.

You can paste the URL above into your browser's address bar or try by clicking here. Optionally you can specify the language of the response.

If you do not provide the lang parameter at all or specify a value that is not supported the default response language will be in english. The following example request will get the data in PDF format and in french language.

You can paste the URL above into your browser's address bar or try by clicking here.

Echo authorization header

While using the EDRfinder demo API you do not have to provide an authorization header in your requests. Access to the production API however requires authorization as described above. In order to test your authorization we provide a function that will echo the authorization header that was received by the EDRfinder API. This enables you to test the authorization communication between your system and the EDRfinder API. You can try sending an authorization header by using the standard curl utility.

The EDRfinder API will send back an information about how your request was received and understood. If you send the request above the response will be: This tells you that the authorization header was received and the value you provided is echoed back to you.

Implementation and pricing

The EDRfinder API is easy to implement and we are happy to help you with any questions that might arise. Pricing depends on volume and use case and is individually contracted. Please contact us at edrfinder@edrfinder.com if you are interested in using the EDRfinder API.