/craigslist/areas

POST /api/craigslist/areas

Price: 5 credits

Get every Craigslist area (regional site): id, alias used to scope searches, short area code, hostname, description, country, region, coordinates, timezone and the list of sub-areas.

How to use it

Fetch the full Craigslist area directory (707 regional sites across 78 countries). Each area has id, alias (the value to pass as `area` to craigslist/postings/search), code (the short area code that postings report as location.area_code, e.g. sfo for sfbay), hostname, description, country, region, lat/lon, timezone and subareas (each with id, alias, description) whose alias is the `subarea` filter of the search endpoint. Pass country to narrow the list to one country.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string nullable — Two-letter country code to keep only areas of that country (examples: "US", "GB")

Response

• @type string (default: "CraigslistArea")
• id integer required
• alias string required
• code string nullable
• hostname string nullable
• description string nullable
• short_description string nullable
• country string nullable
• region string nullable
• lat number nullable
• lon number nullable
• timezone string nullable
• web_url string nullable
• subareas array (default: [])
  • @type string (default: "CraigslistSubArea")
  • id integer required
  • alias string nullable
  • description string nullable
  • short_description string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.