Kalo te përmbajtja
Katalogu live

Historia e automjetit (VHR)

Endpoint-et

Çdo thirrje dërgon x-api-key dhe merr JSON. Trupat janë JSON me Content-Type: application/json.

URL bazëhttps://auctionsapi.com/api/vhr

Llojet e raporteveFalas

GET/sources

Llojet e raporteve që çelësi juaj mund të porosisë, me formatet dhe gjuhët e tyre, dhe VIN-et shembull falas.

Parametrat

Pa parametra.

curl -X GET "https://auctionsapi.com/api/vhr/sources" \
-H "x-api-key: YOUR_API_KEY" \
-H "accept: application/json"
200Shembull përgjigjeje
{
"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"
}
]
}
}

Kontrollo një VINFalas

POST/checks

Falas. Pyet çdo lloj raporti (ose vetëm source_ids) nëse ka regjistrime për VIN-in. Çdo burim kthehet me statusin, available_formats, available_languages, price_usd për çelësin tuaj dhe një parapamje.

Parametrat

vinstring · bodyI detyrueshëm

VIN-i me 17 shenja.

source_idsinteger[] · bodyOpsional

Vetëm këto lloje raportesh. Lëreni jashtë për të kontrolluar çdo lloj që mund të përdorë çelësi juaj.

webhook_urlstring · bodyOpsional

Adresë publike HTTPS që merr rezultatin kur është gati (vetëm VIN reale).

webhook_secretstring · bodyOpsional

Sekreti juaj, nga 16 deri në 256 shenja, që përdoret për të nënshkruar webhook-un.

Statuset

runningcompletedpartialfailedStatuset, gabimet dhe 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"}'
200Shembull përgjigjeje
{
"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"
}

Porosit një raport

POST/reports

Porosit një burim për VIN-in në një ose më shumë formate dhe në një gjuhë. Paguhet një herë, vetëm kur të gjithë skedarët e zgjedhur janë gati; VIN-et shembull janë falas.

Parametrat

vinstring · bodyI detyrueshëm

VIN-i me 17 shenja.

source_idinteger · bodyI detyrueshëm

Lloji i raportit për t’u porositur, nga përgjigjja e kontrollit.

formatsstring[] · bodyOpsional

Cilido nga json, html, pdf. Parazgjedhja ["json"]. Një çmim për të gjithë.

languagestring · bodyOpsional

Një gjuhë që ofron raporti, për shembull en ose ru. Parazgjedhja en.

expected_price_usdnumber · bodyOpsional

price_usd nga kontrolli. API refuzon me 422 nëse çmimi ka ndryshuar ndërkohë.

webhook_urlstring · bodyOpsional

Adresë publike HTTPS që merr rezultatin kur është gati (vetëm VIN reale).

webhook_secretstring · bodyOpsional

Sekreti juaj, nga 16 deri në 256 shenja, që përdoret për të nënshkruar webhook-un.

Statuset

runningpreparingrenderingcompletednot_foundfailedStatuset, gabimet dhe 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"}'
200Shembull përgjigjeje
{
"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"
}

Ndiq kërkesënFalas

GET/requests/{id}

Gjendja aktuale e një kontrolli ose raporti. Pyeteni çdo 1 deri në 2 sekonda derisa statusi të jetë përfundimtar, edhe kur përgjigjet HTTP 200.

Parametrat

iduuid · pathI detyrueshëm

request_id i një kontrolli ose porosie. Për VIN shembull thirrni status_url saktësisht siç erdhi.

Statuset

runningpreparingrenderingcompletedpartialnot_foundfailedStatuset, gabimet dhe 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"
200Shembull përgjigjeje
{
"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"
}

Raportet e tuaFalas

GET/reports

Raportet që keni blerë, më të rejat në fillim, 30 për faqe. VIN-et shembull nuk ruhen këtu.

Parametrat

pageinteger · queryOpsional

Numri i faqes, nga 1.

curl -X GET "https://auctionsapi.com/api/vhr/reports" \
-H "x-api-key: YOUR_API_KEY" \
-H "accept: application/json"
200Shembull përgjigjeje
{
"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
}

Merr një raportFalas

GET/reports/{id}

Një nga raportet tuaja me lidhjet e skedarëve, e njëjta përgjigje si POST /reports.

Parametrat

iduuid · pathI detyrueshëm

report_id nga përgjigja e porosisë; është null derisa raporti të ekzistojë.

Statuset

runningpreparingrenderingcompletednot_foundfailedStatuset, gabimet dhe 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"
200Shembull përgjigjeje
{
"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"
}

Riprovo skedarëtFalas

POST/reports/{id}/retry

Vetëm për një raport skedarët e të cilit dështuan. Ripërdor të dhënat e ruajtura të burimit: pa thirrje të re te furnizuesi dhe pa pagesë të dytë.

Parametrat

iduuid · pathI detyrueshëm

report_id nga përgjigja e porosisë; është null derisa raporti të ekzistojë.

Statuset

runningpreparingrenderingcompletednot_foundfailedStatuset, gabimet dhe 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 '{}'
200Shembull përgjigjeje
{
"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 për agjentë AI

Ngjite në ChatGPT, Claude ose agjentin tënd të kodit para se të kërkosh kod: përshkruan çdo endpoint, fushë, status dhe rregull të API-së Vehicle History Report.

  • 1Nuk përmban kurrë çelësin tënd: kodi që shkruan e lexon çelësin nga një variabël mjedisi.
  • 2Kërko një hap në një kohë: kontroll, porosi, ndjek status_url, ruaj skedarët.
  • 3Testo fillimisht me VIN-et shembull: përgjigjen menjëherë dhe nuk kushtojnë asgjë.
860 fjalë
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.
Provoje në playground →
© 2025. AuctionsAPI operates independently and is not affiliated with Copart, IAAI or Encar.