Skip to content
Live catalog

Vehicle history (VHR)

Endpoints

Every call sends x-api-key and gets JSON back. Bodies are JSON with Content-Type: application/json.

Base URLhttps://auctionsapi.com/api/vhr

List report typesFree

GET/sources

The report types your key may order, with their formats and languages, and the free sample VINs.

Parameters

No parameters.

curl -X GET "https://auctionsapi.com/api/vhr/sources" \
-H "x-api-key: YOUR_API_KEY" \
-H "accept: application/json"
200Example answer
{
"sources": [
{
"id": 1,
"name": "USA Insurance Auctions & Korea History",
"available_formats": [
"json",
"html",
"pdf"
],
"available_languages": [
"en",
"ru"
],
"preview": {}
},
{
"id": 10,
"name": "Avtocod",
"available_formats": [
"html",
"pdf"
],
"available_languages": [
"ru"
],
"preview": {}
}
],
"demonstrations": {
"examples": [
{
"vin": "7FARW2H56JE022576",
"name": "2018 Honda CR-V EX AWD"
}
]
}
}

Check a VINFree

POST/checks

Free. Asks every report type (or only source_ids) whether it has records for the VIN. Each source comes back with its status, available_formats, available_languages, price_usd for your key and a preview.

Parameters

vinstring · bodyRequired

The 17-character VIN.

source_idsinteger[] · bodyOptional

Only these report types. Leave it out to check every type your key may use.

webhook_urlstring · bodyOptional

Public HTTPS address that receives the result when it is ready (real VINs only).

webhook_secretstring · bodyOptional

Your secret, 16 to 256 characters, used to sign the webhook.

Statuses

runningcompletedpartialfailedStatuses, errors and webhooks →
curl -X POST "https://auctionsapi.com/api/vhr/checks" \
-H "x-api-key: YOUR_API_KEY" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-d '{"vin":"7FARW2H56JE022576"}'
200Example answer
{
"request_id": "00000000-0000-4000-8000-000000000001",
"vin": "7FARW2H56JE022576",
"status": "completed",
"currency": "USD",
"sources": [
{
"id": 1,
"name": "USA Insurance Auctions & Korea History",
"available_formats": [
"json",
"html",
"pdf"
],
"available_languages": [
"en",
"ru"
],
"preview": {
"has_data": true,
"records_count": 3
}
},
{
"id": 11,
"name": "Korean Insurance History",
"status": "not_found",
"available_formats": [],
"available_languages": [
"en",
"ru"
],
"preview": {
"has_data": false
}
}
],
"status_url": "https://auctionsapi.com/api/vhr/requests/00000000-0000-4000-8000-000000000001"
}

Order a report

POST/reports

Orders one source for the VIN in one or more formats and one language. Charged once, only when every selected file is ready; sample VINs are free.

Parameters

vinstring · bodyRequired

The 17-character VIN.

source_idinteger · bodyRequired

The report type to order, from the check answer.

formatsstring[] · bodyOptional

Any of json, html, pdf. Default ["json"]. One price for all of them.

languagestring · bodyOptional

One language the report offers, for example en or ru. Default en.

expected_price_usdnumber · bodyOptional

The price_usd from the check. The API refuses with 422 if the price changed meanwhile.

webhook_urlstring · bodyOptional

Public HTTPS address that receives the result when it is ready (real VINs only).

webhook_secretstring · bodyOptional

Your secret, 16 to 256 characters, used to sign the webhook.

Statuses

runningpreparingrenderingcompletednot_foundfailedStatuses, errors and webhooks →
curl -X POST "https://auctionsapi.com/api/vhr/reports" \
-H "x-api-key: YOUR_API_KEY" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-d '{"vin":"7FARW2H56JE022576","source_id":1,"formats":["json","html","pdf"],"language":"en"}'
200Example answer
{
"request_id": "00000000-0000-4000-8000-000000000001",
"report_id": "00000000-0000-4000-8000-000000000001",
"vin": "7FARW2H56JE022576",
"source_id": 1,
"status": "completed",
"currency": "USD",
"files": {
"json": "https://cdn.example/reports/unique-report.json",
"html": "https://cdn.example/reports/unique-report.html",
"pdf": "https://cdn.example/reports/unique-report.pdf"
},
"status_url": "https://auctionsapi.com/api/vhr/requests/00000000-0000-4000-8000-000000000001"
}

Follow a requestFree

GET/requests/{id}

The current state of a check or a report. Poll it every 1 to 2 seconds until the status is final, even when it answers HTTP 200.

Parameters

iduuid · pathRequired

The request_id of a check or an order. For sample VINs call status_url exactly as given.

Statuses

runningpreparingrenderingcompletedpartialnot_foundfailedStatuses, errors and webhooks →
curl -X GET "https://auctionsapi.com/api/vhr/requests/00000000-0000-4000-8000-000000000001" \
-H "x-api-key: YOUR_API_KEY" \
-H "accept: application/json"
200Example answer
{
"request_id": "00000000-0000-4000-8000-000000000001",
"report_id": "00000000-0000-4000-8000-000000000001",
"vin": "7FARW2H56JE022576",
"source_id": 1,
"status": "rendering",
"files": {},
"status_url": "https://auctionsapi.com/api/vhr/requests/00000000-0000-4000-8000-000000000001"
}

List your reportsFree

GET/reports

Your purchased reports, newest first, 30 per page. Sample VINs are not kept here.

Parameters

pageinteger · queryOptional

Page number, from 1.

curl -X GET "https://auctionsapi.com/api/vhr/reports" \
-H "x-api-key: YOUR_API_KEY" \
-H "accept: application/json"
200Example answer
{
"current_page": 1,
"data": [
{
"request_id": "00000000-0000-4000-8000-000000000001",
"report_id": "00000000-0000-4000-8000-000000000001",
"vin": "7FARW2H56JE022576",
"source_id": 1,
"status": "completed",
"currency": "USD",
"files": {
"json": "https://cdn.example/reports/unique-report.json",
"pdf": "https://cdn.example/reports/unique-report.pdf"
},
"status_url": "https://auctionsapi.com/api/vhr/requests/00000000-0000-4000-8000-000000000001"
}
],
"last_page": 1,
"per_page": 30,
"total": 1,
"next_page_url": null
}

Get a reportFree

GET/reports/{id}

One of your reports with its file links, the same answer as POST /reports.

Parameters

iduuid · pathRequired

The report_id from an order answer; it is null until the report exists.

Statuses

runningpreparingrenderingcompletednot_foundfailedStatuses, errors and webhooks →
curl -X GET "https://auctionsapi.com/api/vhr/reports/00000000-0000-4000-8000-000000000001" \
-H "x-api-key: YOUR_API_KEY" \
-H "accept: application/json"
200Example answer
{
"request_id": "00000000-0000-4000-8000-000000000001",
"report_id": "00000000-0000-4000-8000-000000000001",
"vin": "7FARW2H56JE022576",
"source_id": 1,
"status": "completed",
"currency": "USD",
"files": {
"json": "https://cdn.example/reports/unique-report.json",
"pdf": "https://cdn.example/reports/unique-report.pdf"
},
"status_url": "https://auctionsapi.com/api/vhr/requests/00000000-0000-4000-8000-000000000001"
}

Retry failed filesFree

POST/reports/{id}/retry

Only for a report whose files failed. Reuses the saved source data: no new supplier call and no second charge.

Parameters

iduuid · pathRequired

The report_id from an order answer; it is null until the report exists.

Statuses

runningpreparingrenderingcompletednot_foundfailedStatuses, errors and webhooks →
curl -X POST "https://auctionsapi.com/api/vhr/reports/00000000-0000-4000-8000-000000000001/retry" \
-H "x-api-key: YOUR_API_KEY" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
200Example answer
{
"request_id": "00000000-0000-4000-8000-000000000001",
"report_id": "00000000-0000-4000-8000-000000000001",
"status": "preparing",
"files": {},
"status_url": "https://auctionsapi.com/api/vhr/requests/00000000-0000-4000-8000-000000000001"
}

Prompt for AI agents

Paste it into ChatGPT, Claude or your coding agent before you ask for code: it describes every endpoint, field, status and rule of the Vehicle History Report API.

  • 1It never contains your key: the code it writes reads it from an environment variable.
  • 2Ask for one step at a time: check, order, follow status_url, store the files.
  • 3Test with the sample VINs first: they answer at once and cost nothing.
860 words
vhr-ai-prompt.md
You are helping me integrate the AuctionsAPI Vehicle History Report (VHR) API.
Write production code that follows this contract exactly. Ask before you guess.
 
## 1. Basics
- Base URL: https://auctionsapi.com/api/vhr
- Every request sends the header x-api-key: <key>. Read the key from an environment
  variable (VHR_API_KEY); never hard-code it, log it or send it to a browser.
- Bodies are JSON (Content-Type: application/json); every answer is JSON.
- A VIN has 17 characters: letters and digits without I, O or Q. Uppercase it.
 
## 2. Flow
1. GET /sources: the report types (sources) this key may order, each with id, name,
   available_formats and available_languages, plus free sample VINs.
2. POST /checks {"vin"} (free): asks every source, or only "source_ids": [1, 2],
   whether it has records. Each source in "sources" has id, name, available_formats,
   available_languages, price_usd (the price for this key) and a preview object.
   A source WITHOUT a "status" field and with non-empty available_formats can be
   ordered. Other values: status "pending" (still answering), "not_found" (no record),
   "error" (could not answer now; NOT the same as no data), "not_checked" (not asked;
   NOT proof that no data exists). If availability_confirmed is false, show
   availability_notice to the user before ordering.
3. POST /reports {"vin", "source_id", "formats", "language"}: orders ONE source.
   formats: any of "json", "html", "pdf" (default ["json"]); one price covers all of
   them. language: one code the source offers, for example "en" or "ru" (default
   "en"; arrays are rejected). Optional "expected_price_usd": the price_usd from the
   check; the API answers 422 if the price changed, before any charge.
4. The answer has request_id, report_id (may be null while preparing), vin,
   source_id, status, currency, files and status_url. files is {} until the report
   is ready, then {"json": url, "html": url, "pdf": url} for the chosen formats.
5. Download the files from those links. They are bearer links: anyone with a link
   can open it, so store them like secrets. No API key is needed for the files.
 
## 3. Waiting
- A call waits up to about 10 seconds. HTTP 202 means the work goes on.
- Poll GET status_url (or GET /requests/{id}) every 1 to 2 seconds until the status
  is final, even when the poll answers HTTP 200. Give up after a few minutes and
  poll again later; stopping the wait does not cancel the work on the server.
- Never send the same purchase again while one is pending: the API answers 409.
- Check statuses: running, completed, partial (some sources failed), failed.
- Report statuses: running, preparing, rendering, completed, not_found, failed.
  Final: completed, partial, failed, not_found.
 
## 4. Money rules
- Checks, statuses, history and retries are free.
- A report is charged once, only when every selected file is ready. not_found and
  failed are never charged. The sample VINs below are always free.
 
## 5. Other endpoints
- GET /reports?page=N: your purchased reports, newest first, 30 per page (Laravel
  pagination: data, current_page, last_page, next_page_url). Samples are not kept.
- GET /reports/{id}: one report, same shape as the POST /reports answer.
- POST /reports/{id}/retry: only after a report whose files failed. Reuses the
  saved source data: no new source call and no second charge.
 
## 6. Errors (JSON with error_code and message; nothing is charged)
- 401 missing or invalid key  - 402 not enough report balance
- 403 report type not enabled for this key  - 409 same report already pending
- 422 invalid body or changed price  - 429 too many requests (back off)
- 503 reports paused for a moment (retry later)
 
## 7. Webhooks (real VINs only)
- Add "webhook_url" (public HTTPS) and "webhook_secret" (16 to 256 characters) to a
  check or a report. The API answers 202 at once and POSTs the same JSON when ready.
- Verify X-VHR-Signature: "sha256=" + hex HMAC-SHA256 of
  X-VHR-Timestamp + "." + raw body, keyed with webhook_secret. Compare in constant
  time, refuse timestamps older than 5 minutes, de-duplicate X-VHR-Event-Id.
 
## 8. Sample VINs (free, answer at once, no webhooks)
- 7FARW2H56JE022576  2018 Honda CR-V EX AWD  (reports: 1, 2, 3, 4, 5, 6, 7, 8, 9)
- 1C4RJGAG3PC525071  2023 Jeep Grand Cherokee Laredo  (reports: 1, 3)
- KMUHCESB1SU250832  2025 Genesis GV80  (reports: 2)
- 5YFB4MDE0TP377402  2026 Toyota Corolla  (reports: 1, 6)
- KNAKR814DNA244958  2022 Kia Carnival  (reports: 3)
- KMTG341ABMU089876  2021 Genesis G70  (reports: 4)
- KMHB3518BNW003977  2022 Hyundai Casper 1.0  (reports: 5)
- JTDKB20U203000002  2008 Toyota Prius  (reports: 7, 8, 9)
- WVWZZZ3C4KE000001  2019 Volkswagen Passat  (reports: 7, 8, 9)
- VF1RFB00355000004  Renault  (reports: 9)
- WBA8E31070K000003  2016 BMW 3 Series  (reports: 7, 8, 9)
- SCBCN13S2TC024887  2026 Bentley Continental GT  (reports: 7)
- XTA219040P0906805  2023 LADA Granta  (reports: 7)
- JMZKE5W7A00623042  2017 Mazda CX-5  (reports: 10)
- WDC2539191F753149  2019 Mercedes-Benz GLC 300 d 4MATIC  (reports: 10)
- KNAF241BEMA915413  2021 Kia K3  (reports: 11)
- KMHGE41ABBU141129  2011 Hyundai Genesis  (reports: 11)
- KMHD641EELU077852  2020 Hyundai Avante  (reports: 11)
 
## 9. What to build first
- A small client with check(vin), order(vin, sourceId, formats, language) and
  waitFor(statusUrl) that polls with backoff and returns the final answer.
- Show the user which sources have records before ordering; never order a source
  that has a status field or no available_formats.
Try it in the playground →
© 2025. AuctionsAPI operates independently and is not affiliated with Copart, IAAI or Encar.