TurboFax
API Guide Sign in

API Guide

Public documentation — installation, code examples, live test console, and every endpoint. No login required to read. Paste your API key to try requests.

Public REST · JSON API v1.0 Base URL …
Installation — quick start

Follow these steps to connect your app. Use the test endpoints first — they never use CARFAX quota.

1

Get your API key

Customers: sign in and copy from My Account. Integrators: ask your TurboFax admin for a key.

2

Verify the key

GET /api/v1/test/ping — should return "ok": true.

3

Preview sample JSON

GET /api/v1/test/sample?kind=summary — build your UI against this shape.

4

Run a live lookup

POST /api/v1/carfax/lookup with {"vin":"YOUR_VIN"} (8–15 sec first time).

5

Read cache cheaply

GET /api/v1/carfax/summary?vin=… — same VIN, no new CARFAX pull.

Never put your API key in public frontend JavaScript. Call TurboFax from your backend server only.
Integration workflow
Customer enters VIN │ ▼ Your backend ──POST /api/v1/carfax/lookup──► TurboFax │ (live CARFAX) ◄──── JSON report + overview ─────────────┘ │ ├── GET /api/v1/carfax/summary (flags, values) ├── GET /api/v1/carfax/section (title, timeline…) ├── GET /api/v1/carfax/original/download (HTML / PNG) └── POST /api/v1/mmr/lookup (wholesale / retail)
Code examples

Replace YOUR_API_KEY. Example VIN: JM3KFBCMXJ0312594


          

          

          

        

      


      

        
Go-live checklist

        
    
          
  • GET /api/v1/test/ping returns ok
    • 
          
  • POST /api/v1/test/run passes (use button below)
    • 
          
  • API key in server environment — not in browser
    • 
          
  • Lookup timeout ≥ 120 seconds
    • 
          
  • Handle 429, 403, NO_REPORT errors
    • 
          
  • HTTPS on production base URL
    • 
        

      


      

        
Test console

        
        

          

            

              
              
            

            
Used for “Try it” on each endpoint. Keys are never stored — only sent with your test requests.

            
            
          

        

      


      

        
Authentication

        
Loading…

      


      


      

        
Error codes

        
CodeHTTPMeaning