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

heycar Car Search API Documentation

GET https://scrappa.co/api/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20

Search car listings on heycar, now Drive (drive.co.uk), the UK car marketplace. Filter by make, model, price in GBP, mileage in miles, fuel type, body type and gearbox, and sort by price, year, mileage or distance. Each listing has the title, make, model, variant, price with currency, year, mileage, registration, body type, fuel type, gearbox, colour, engine size, power, CO2, images, dealer, location, timestamps (ISO 8601, UTC) and the public web url. Page with the 0-based page and size parameters. UK stock only (GBP). A valid filter with no match is a successful empty page.

heycar Car Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "listings": [
            {
                "id": "16731596",
                "heycar_id": "volkswagen-golf-2016-14-tsi-125-match-edition-5dr-dsg-b52b7c37",
                "title": "Volkswagen Golf 1.4 TSI 125 Match Edition 5dr DSG",
                "make": {
                    "id": "volkswagen",
                    "label": "Volkswagen"
                },
                "model": {
                    "id": "volkswagen-golf",
...

Parameters

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

Runnable path

This endpoint has no required query parameters.

13 optional filters available.

make string Optional

Make slug, lowercase. Example: volkswagen. Use mercedes_benz (with underscore) for Mercedes-Benz.

Example value volkswagen
model string Optional

Model slug with the make prefix. Example: volkswagen-golf.

Example value volkswagen-golf
page integer Optional

0-based page number, 0 to 399. Defaults to 0.

Example value 0
size integer Optional

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

Example value 20
sort string Optional

Sort order: price-asc, price-desc, year-desc, mileage-asc, date-active-desc, relevance-desc or distance-asc. Omit for the default order.

Example value relevance
price_min integer Optional

Minimum price in GBP, whole pounds.

Example value 10
price_max integer Optional

Maximum price in GBP, whole pounds.

Example value 10
mileage_max integer Optional

Maximum mileage in miles.

Example value 10
fuel_type string Optional

One of petrol, diesel, hybrid, electric.

Example value example
body_type string Optional

One of suv, saloon, estate, convertible, coupe, hatchback.

Example value example
gearbox string Optional

One of automatic, manual, semiauto.

Example value example
lat number Optional

Latitude. Send with lon and sort=distance-asc to order by distance and exclude far listings.

Example value 10
lon number Optional

Longitude. Send with lat.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20",
    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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20');

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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20', 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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20',
    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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20")
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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20", 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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20', 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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20")
        .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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20", 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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20"
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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20"));
            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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20',
            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/heycar/search?make=volkswagen&model=volkswagen-golf&page=0&size=20")
        .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": {
        "listings": [
            {
                "id": "16731596",
                "heycar_id": "volkswagen-golf-2016-14-tsi-125-match-edition-5dr-dsg-b52b7c37",
                "title": "Volkswagen Golf 1.4 TSI 125 Match Edition 5dr DSG",
                "make": {
                    "id": "volkswagen",
                    "label": "Volkswagen"
                },
                "model": {
                    "id": "volkswagen-golf",
                    "label": "Golf"
                },
                "variant": "1.4 TSI 125 Match Edition 5dr DSG",
                "price": 13499,
                "currency": "GBP",
                "is_vat_included": true,
                "year": 2016,
                "mileage": 15651,
                "registration": "SK66MDO",
                "stock_condition": "used",
                "previous_owners": 2,
                "body_type": "hatchback",
                "fuel_type": "petrol",
                "gearbox": "semiauto",
                "color": "blue",
                "doors": 5,
                "seats": 5,
                "engine_size": 1.4,
                "bhp": 123.4,
                "co2_g_km": 116,
                "first_registration_date": "2016-09-14",
                "is_ulez_compliant": false,
                "image_count": 35,
                "images": [
                    "https://cdn.uk.prod.group-mobility-trader.com/images/cas/811d30f1406ca1d31dbe202d3888873e/e8ef682826ac1c09a1bd3fd3c33e363c.jpg"
                ],
                "dealer": {
                    "id": "7237",
                    "name": "Car Deal Warehouse Superstore Newbridge",
                    "city": "Newbridge"
                },
                "location": {
                    "postcode": "EH288TH",
                    "latitude": 55.942214,
                    "longitude": -3.405555
                },
                "created_at": "2026-10-07T06:30:41Z",
                "last_updated_at": "2026-10-15T01:43:15Z",
                "active_at": "2026-10-07",
                "url": "https://drive.co.uk/auto/volkswagen-golf-2016-14-tsi-125-match-edition-5dr-dsg-b52b7c37"
            }
        ],
        "total": 2087,
        "page": 0,
        "size": 20,
        "total_pages": 696,
        "has_more": true,
        "next_page": 1
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

422

Validation Error

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

{
    "errors": {
        "size": [
            "The size must be 50 or fewer listings per page."
        ]
    },
    "message": "The request validation failed"
}
502

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 heycar 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 heycar 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.