> ## Documentation Index > Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt > Use this file to discover all available pages before exploring further. # Craigslist craigslist Search API > Scrape the newest Craigslist listings near a US ZIP code. Call the Craigslist craigslist Search API for JSON. From 1 credit per call. Scrape the newest Craigslist listings near a US ZIP code. ## Request `zipCode` is required. ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.craigslist.search({ zipCode: "94103", query: "road bike", maxPrice: 800, limit: 10 }); console.log(result.data.results); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.craigslist.search(zip_code="94103", query="road bike", max_price=800, limit=10) print(result["data"]["results"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/craigslist/search \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"zipCode":"94103","query":"road bike","maxPrice":800,"limit":10}' ``` ```bash CLI icon="square-terminal" theme={null} stophy craigslist search 94103 --query "road bike" --maxPrice 800 --limit 10 ``` ## 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. ```json theme={null} { "success": true, "data": { "totalResults": 719, "results": [ { "listingId": "7951123997", "listingUrl": "https://www.craigslist.org/view/d/san-mateo-got-gary-fisher-klunker/2qNKE1a54sBSCGGXEBiaaj", "title": "Got A Gary Fisher Klunker Panther Diamondback LAWWILL Pro Cruiser !?🤔", "price": 123, "location": "san mateo", "latitude": 37.5395, "longitude": -122.2998, "imageUrl": "https://images.craigslist.org/00l0l_dkFwe5RfJb5_05a03S_600x450.jpg", "publishedAt": "2026-10-31T00:17:06.000Z" } ] }, "creditsUsed": 1, "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b" } ``` | Field | Type | Description | | - | - | - | | `publishedAt` | string (ISO 8601) | The publication time, in UTC. | For every field, see the response schema on this page. > [!NOTE] > > Listings come newest first, at most 360 per search, so narrow with filters when totalResults is higher. ## Optional parameters | Parameter | Type | Description | | - | - | - | | `query` | string | Search words (e.g., "road bike"). Leave out to list the newest in the category. | | `radius` | integer | Miles around the ZIP code, 25 by default. Must be between 1 and 250. If unset, defaults to `25`. | | `category` | string | Specifies which listings to search, `forSale` by default. Acceptable values are `forSale`, `carsAndTrucks`, `apartments`, `housing`, `jobs`, `gigs`, `services` and `free`. If unset, defaults to `forSale`. | | `minPrice` | integer | The minimum price in US dollars (e.g., 50). Must be between 0 and 100000000. | | `maxPrice` | integer | The maximum price in US dollars (e.g., 500). Must be between 0 and 100000000. | | `limit` | integer | The maximum number of listings to return. Billed at 1 credit per 10 returned. Must be between 1 and 360. If unset, defaults to `20`. | ## 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. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/craigslist/search openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. Text comes back whole. To get shorter responses, add ?maxTextLength= to the URL. Every text value longer than that is cut and ends with …. A screenshot is never cut, and a page whose text was cut has isTruncated set to true. x-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation's description says it costs per 10 results, or per second of audio. Then x-credits is the lowest price and x-credits-max the most one call can cost. Where an operation takes limit, send it to return fewer results and pay for fewer. When a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/craigslist/search: post: summary: Scrape the newest Craigslist listings near a US ZIP code description: Costs 1 credit per 10 listings. operationId: craigslistSearch parameters: - $ref: '#/components/parameters/MaxTextLength' requestBody: required: true content: application/json: schema: type: object properties: zipCode: type: string pattern: ^\d{5}$ description: US ZIP code to search around (e.g., "94103") query: description: >- Search words (e.g., "road bike"). Leave out to list the newest in the category type: string minLength: 1 maxLength: 200 radius: default: 25 description: Miles around the ZIP code, 25 by default type: integer minimum: 1 maximum: 250 category: default: forSale description: Which listings to search, forSale by default type: string enum: - forSale - carsAndTrucks - apartments - housing - jobs - gigs - services - free minPrice: description: Lowest price in US dollars (e.g., 50) type: integer minimum: 0 maximum: 100000000 maxPrice: description: Highest price in US dollars (e.g., 500) type: integer minimum: 0 maximum: 100000000 limit: default: 20 description: >- Return at most this many listings. You pay 1 credit per 10 returned. type: integer minimum: 1 maximum: 360 required: - zipCode additionalProperties: false example: zipCode: '94103' query: road bike maxPrice: 800 limit: 10 responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' x-cache: $ref: '#/components/headers/Cache' x-cache-age: $ref: '#/components/headers/CacheAge' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: totalResults: type: integer minimum: -9007199254740991 maximum: 9007199254740991 results: type: array items: type: object additionalProperties: false properties: listingId: type: string listingUrl: type: string format: uri title: type: string price: type: number location: type: string latitude: type: number longitude: type: number bedrooms: type: integer minimum: -9007199254740991 maximum: 9007199254740991 sqft: type: integer minimum: -9007199254740991 maximum: 9007199254740991 imageUrl: type: string format: uri publishedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - listingUrl - publishedAt required: - totalResults - results creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: parameters: MaxTextLength: name: maxTextLength in: query required: false description: >- 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. schema: type: integer minimum: 1 headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix time in seconds when the current window resets. schema: type: integer Cache: description: hit if this result came from the cache, miss if it was fetched live. schema: type: string CacheAge: description: Seconds since the returned result was written to the cache. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - inviteClaimed - inviteDisabled - inviteExpired - inviteUsedUp - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string requiredCredits: type: number availableCredits: type: number billingUrl: type: string const: https://stophy.dev/billing securitySchemes: apiKey: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.