Skip to main content
POST
Scrape the newest Craigslist listings near a US ZIP code
Scrape the newest Craigslist listings near a US ZIP code.

Request

zipCode is required.

Response

If successful, the response body contains the standard envelope. data.results[] contains the listings, newest first, each with its title, price, location and link. The following example is a real response, truncated: each list shows one item and long strings are cut.
For every field, see the response schema on this page.
Listings come newest first, at most 360 per search, so narrow with filters when totalResults is higher.

Optional parameters

Billing

A successful request consumes 1 credit per 10 listings, up to 36 credits. Requests that fail, or that return no items, are not billed. Set limit to cap the number of items returned and billed.

Pagination

This method is not paginated. A single request returns the complete result.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json
zipCode
string
required

US ZIP code to search around (e.g., "94103")

Pattern: ^\d{5}$
query
string

Search words (e.g., "road bike"). Leave out to list the newest in the category

Required string length: 1 - 200
radius
integer
default:25

Miles around the ZIP code, 25 by default

Required range: 1 <= x <= 250
category
enum<string>
default:forSale

Which listings to search, forSale by default

Available options:
forSale,
carsAndTrucks,
apartments,
housing,
jobs,
gigs,
services,
free
minPrice
integer

Lowest price in US dollars (e.g., 50)

Required range: 0 <= x <= 100000000
maxPrice
integer

Highest price in US dollars (e.g., 500)

Required range: 0 <= x <= 100000000
limit
integer
default:20

Return at most this many listings. You pay 1 credit per 10 returned.

Required range: 1 <= x <= 360

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required