POST /api/kijiji/locations
Price: 1 credit
Get the Kijiji location tree around a given location: Canada, its provinces and the regions or cities under the requested node, each with its ID, localized name, parent ID and current listing count. Use the returned IDs as location_id when searching listings.
Fetch the Kijiji (Canada) location tree. location_id 0 returns Canada plus the 11 provinces; pass a province ID (Ontario 9004, Quebec 9001, British Columbia 9007, Alberta 9003, ...) to get its regions and cities. Each entry has id, name, parent_id, listing_count and url; the response also carries the ancestors of the requested node, so rebuild the hierarchy via parent_id -> id. The ids feed location_id on kijiji/listings/search.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)location_id integer — Root location ID of the subtree to return (0 returns Canada and its provinces) (default: 0; min: 0)category_id integer — Category ID the listing counts should be scoped to (default: 0; min: 0)locale string — Language of location names (default: "en"; one of: "en", "fr")@type string (default: "KijijiLocation")id integer requiredname string nullableparent_id integer nullablelisting_count integer nullableurl string nullable422 — 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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.