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

Craigslist Search API Documentation

GET https://scrappa.co/api/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300

Search Craigslist postings on any city site or subarea and in any category, with a keyword, price range and sort order. Each result has the posting id, title, url, price (whole units, with currency when known), images, location with approximate coordinates, the time of the latest bump (ISO 8601 UTC) and for housing the bedrooms and area. Results come in pages of 360; page up to 28 (Craigslist exposes at most 10000 results per search). Contact data is never returned. A valid search with no match is a successful empty result.

Craigslist Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "total": 831,
        "page": 1,
        "per_page": 360,
        "has_more": true,
        "results": [
            {
                "position": 1,
                "id": "g5tuoYXMyVFFgpXzYbiXMq",
                "posting_id": 7946124093,
                "title": "LeMond Greg Lemond Road Bike 55cm ((( REDUCED )))",
                "url": "https://www.craigslist.org/view/g5tuoYXMyVFFgpXzYbiXMq",
...

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.

8 optional filters available.

site string Optional

Craigslist city site hostname from the sites endpoint, e.g. portland or sfbay. Required unless subarea is set. Example: portland.

Example value portland
subarea string Optional

Subarea abbreviation from the sites endpoint, e.g. sfc for the city of San Francisco. Use instead of site.

Example value example
category string Optional

Category code from the categories endpoint, e.g. bik (bicycles by owner). Aggregate codes also work: sss (all for sale), bia (all bicycles), hhh (all housing). Defaults to sss.

Example value bia
query string Optional

Search keywords, up to 200 characters. Example: bike.

Example value bike
min_price integer Optional

Minimum price in whole units of the site currency. Example: 50.

Example value 50
max_price integer Optional

Maximum price in whole units of the site currency. Must be at least min_price. Example: 300.

Example value 300
sort string Optional

date, dateoldest, rel, priceasc or pricedsc. Craigslist defaults to relevance with a query and to newest first without.

Example value relevance
page integer Optional

1-based page number, 1 to 28. Each page has up to 360 results. Defaults to 1.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300",
    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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300');

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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300', 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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300',
    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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300")
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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300", 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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300', 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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300")
        .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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300", 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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300"
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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300"));
            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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300',
            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/craigslist/search?site=portland&category=bia&query=bike&min_price=50&max_price=300")
        .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": {
        "total": 831,
        "page": 1,
        "per_page": 360,
        "has_more": true,
        "results": [
            {
                "position": 1,
                "id": "g5tuoYXMyVFFgpXzYbiXMq",
                "posting_id": 7946124093,
                "title": "LeMond Greg Lemond Road Bike 55cm ((( REDUCED )))",
                "url": "https://www.craigslist.org/view/g5tuoYXMyVFFgpXzYbiXMq",
                "price": 200,
                "currency": "USD",
                "images": [
                    "https://images.craigslist.org/00f0f_52oL7PFWTmc_0CI0lN_600x450.jpg",
                    "https://images.craigslist.org/00o0o_7s8PevWIQe8_0CI0lN_600x450.jpg",
                    "https://images.craigslist.org/00505_jFRAv7Cqove_0lN0CI_600x450.jpg"
                ],
                "slug": "portland-lemond-greg-lemond-road-bike",
                "location": {
                    "name": "Tigard",
                    "site": "portland",
                    "subarea": "wsc",
                    "latitude": 45.4403,
                    "longitude": -122.7793
                },
                "bumped_at": "2026-10-15T19:24:12Z"
            },
            {
                "position": 2,
                "id": "6amiQ1na2PT7HVYjM9TDvR",
                "posting_id": 7931050968,
                "title": "Centurion Le Mans RS Road Bike ( NICE )",
                "url": "https://www.craigslist.org/view/6amiQ1na2PT7HVYjM9TDvR",
                "price": 200,
                "currency": "USD",
                "images": [
                    "https://images.craigslist.org/00303_4rWBDSH5ngs_0CI0lN_600x450.jpg",
                    "https://images.craigslist.org/00v0v_6LPhiNeAJpb_0lN0CI_600x450.jpg",
                    "https://images.craigslist.org/00G0G_5tPzrY1qGiI_0lN0CI_600x450.jpg"
                ],
                "slug": "portland-centurion-le-mans-rs-road-bike",
                "location": {
                    "name": "Tigard",
                    "site": "portland",
                    "subarea": "wsc",
                    "latitude": 45.4403,
                    "longitude": -122.7793
                },
                "bumped_at": "2026-10-15T19:23:50Z"
            }
        ]
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

422

Validation Error

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

{
    "errors": {
        "site": [
            "The site field is invalid."
        ]
    },
    "message": "The request validation failed"
}
422

Unsupported Site or Category

Craigslist does not support this site, subarea or category combination. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "INVALID_PARAMETER",
        "message": "Craigslist rejected the request. Check the site, category and filters. Use the sites and categories endpoints for valid values."
    },
    "success": false
}
502

Invalid Source Response

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

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "PARSER_DRIFT",
        "message": "Craigslist returned an unexpected response. Please retry later."
    },
    "success": false
}
503

Service Unavailable

The upstream service is temporarily unavailable. Please retry shortly.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Craigslist 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.