{"openapi":"3.1.0","info":{"title":"CarHistory.report Developer API","description":"API-key-protected vehicle report and account endpoints. Report generation uses prepaid wallet credits; see developer documentation for pricing and source limitations.","version":"1.0.0"},"paths":{"/api/v1/balance":{"get":{"tags":["Developer Vehicle Intelligence API"],"summary":"Check Wallet Balance","description":"Retrieve current wallet balance, currency, and available lookup credits.","operationId":"get_balance_api_v1_balance_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletBalanceResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/report/generate":{"post":{"tags":["Developer Vehicle Intelligence API"],"summary":"Generate a source-aware vehicle history report","description":"Generate a vehicle report with source availability clearly labeled.\nDeducts the configured API report price from the user's prepaid wallet balance.","operationId":"generate_report_api_api_v1_report_generate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCheckRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCheckResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/reports":{"get":{"tags":["Developer Vehicle Intelligence API"],"summary":"List All Generated Reports","description":"Retrieve history of all vehicle reports generated by your API account.","operationId":"list_reports_api_v1_reports_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VehicleCheckRequest":{"properties":{"registration":{"type":"string","title":"Registration","description":"Vehicle Registration Mark (VRM) for UK or Ireland plate, e.g. '181LD350' or 'LK68EYB'"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Optional jurisdiction override. Omit or use 'AUTO' to detect UK or Ireland from the registration mark.","default":"AUTO"}},"type":"object","required":["registration"],"title":"VehicleCheckRequest"},"VehicleCheckResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"vrm":{"type":"string","title":"Vrm"},"country":{"type":"string","title":"Country"},"make":{"type":"string","title":"Make"},"model":{"type":"string","title":"Model"},"year":{"type":"string","title":"Year"},"color":{"type":"string","title":"Color"},"nct_mot_due":{"type":"string","title":"Nct Mot Due"},"theft_status":{"type":"string","title":"Theft Status"},"financial_status":{"type":"string","title":"Financial Status"},"cost_deducted":{"type":"number","title":"Cost Deducted"},"remaining_balance":{"type":"number","title":"Remaining Balance"},"pdf_filename":{"type":"string","title":"Pdf Filename"},"download_url":{"type":"string","title":"Download Url"},"data":{"additionalProperties":true,"type":"object","title":"Data"}},"type":"object","required":["success","vrm","country","make","model","year","color","nct_mot_due","theft_status","financial_status","cost_deducted","remaining_balance","pdf_filename","download_url","data"],"title":"VehicleCheckResponse"},"WalletBalanceResponse":{"properties":{"user_id":{"type":"integer","title":"User Id"},"email":{"type":"string","title":"Email"},"balance":{"type":"number","title":"Balance"},"currency":{"type":"string","title":"Currency","default":"GBP"},"per_report_price":{"type":"number","title":"Per Report Price","default":2.75},"reports_remaining":{"type":"integer","title":"Reports Remaining"}},"type":"object","required":["user_id","email","balance","reports_remaining"],"title":"WalletBalanceResponse"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}},"servers":[{"url":"https://carhistory.report"}]}