Skip to content
Scrappa Get API key
Edmunds API 1 credit/request

Edmunds Inventory Search API Documentation

GET https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2

Search the Edmunds car inventory by make, model and ZIP code. Each listing has the VIN, price, MSRP, mileage, year, trim, style id, colors, photo, dealer name and location, publish date (ISO 8601, UTC) and the public Edmunds page url. Page with page and per_page; the response has total and total_pages. A valid search with zero matches is a successful empty list.

Edmunds Inventory Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2
Auth header
x-api-key
Cost
1 credit/request
make = Toyota model = Camry zip = 90210
Response preview
200 OK
{
    "success": true,
    "data": {
        "results": [
            {
                "vin": "4T1BE46K57U553297",
                "type": "used",
                "url": "https://www.edmunds.com/toyota/camry/2007/vin/4T1BE46K57U553297/",
                "published_at": "2026-10-15T05:34:41Z",
                "stock_number": "553297",
                "price": 4995,
                "mileage": 142625,
                "year": 2007,
                "make": "Toyota",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

3 required parameters needed before sending a request.

4 optional filters available.

make string Required

Car make, e.g. Toyota. Example: Toyota.

Example value Toyota
model string Required

Car model, e.g. Camry. Example: Camry.

Example value Camry
zip string Required

5-digit US ZIP code to search around. Example: 90210.

Example value 90210
type string Optional

Listing type: used, new or cpo (certified pre-owned). Defaults to used.

Example value used
radius integer Optional

Search radius in miles, 1 to 500.

Example value 10
page integer Optional

Page number, starting at 1. Defaults to 1.

Example value 1
per_page integer Optional

Listings per page, 1 to 40. Defaults to 20.

Example value 2

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/edmunds/inventory/search?make=Toyota&model=Camry&zip=90210&type=used&page=1&per_page=2")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "results": [
            {
                "vin": "4T1BE46K57U553297",
                "type": "used",
                "url": "https://www.edmunds.com/toyota/camry/2007/vin/4T1BE46K57U553297/",
                "published_at": "2026-10-15T05:34:41Z",
                "stock_number": "553297",
                "price": 4995,
                "mileage": 142625,
                "year": 2007,
                "make": "Toyota",
                "model": "Camry",
                "trim": "CE",
                "style": "CE 4dr Sedan (2.4L 4cyl 5A)",
                "style_id": "100699450",
                "body_type": "Sedan",
                "exterior_color": "Blue Ribbon Metallic",
                "photo": "https://media.ed.edmunds-media.com/m2/for-sale/6e-4T1BE46K57U553297/img-1-600x400.jpg",
                "dealer": {
                    "name": "Quick & Easy Auto Sales",
                    "latitude": 33.921839,
                    "longitude": -118.210241,
                    "distance_miles": 16.7
                }
            },
            {
                "vin": "4T1DAACK6TU242320",
                "type": "used",
                "url": "https://www.edmunds.com/toyota/camry/2026/vin/4T1DAACK6TU242320/",
                "published_at": "2026-10-15T05:38:01Z",
                "stock_number": "242320",
                "price": 33238,
                "msrp": 33238,
                "year": 2026,
                "make": "Toyota",
                "model": "Camry",
                "trim": "SE",
                "style": "SE 4dr Sedan (2.5L 4cyl gas/electric hybrid CVT)",
                "style_id": "402082427",
                "body_type": "Sedan",
                "exterior_color": "Underground",
                "interior_color": "Black leatherette/cloth",
                "photo": "https://media.ed.edmunds-media.com/m2/for-sale/8e-4T1DAACK6TU242320/img-1-600x400.jpg",
                "dealer": {
                    "name": "Business Cars",
                    "latitude": 33.961986,
                    "longitude": -118.358306,
                    "distance_miles": 9.8
                }
            }
        ],
        "total": 573,
        "total_pages": 287,
        "page": 1,
        "per_page": 2
    },
    "meta": {
        "endpoint_family": "inventory_search",
        "billable": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required query parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "make": [
            "The make field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Resource Not Found

The requested Edmunds resource does not exist. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "inventory_search"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Edmunds resource was not found."
    },
    "success": false
}
503

Invalid Source Response

The upstream answered with a shape that no longer matches the documented contract. This response is not billable.

{
    "error": {
        "code": "PARSER_DRIFT",
        "message": "The Edmunds API is temporarily unavailable. Please retry."
    },
    "success": false
}
503

Service Unavailable

The upstream service is temporarily unavailable. Please retry shortly.

{
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Edmunds API is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.