/kijiji/listings/filters

POST /api/kijiji/listings/filters

Price: 5 credits

Get the filter catalog Kijiji offers for a category: every filter with its type and, for choice filters, the full list of accepted values with their labels and current listing counts (for example all car makes and models, or all real estate unit types).

How to use it

Discover which filter values kijiji/listings/search accepts inside a category. Pass category_id (for example 174 for Cars & Trucks, 37 for long-term rentals, 45 for jobs) and get back each filter with name, label, type, min_value/max_value for ranges, and values: the accepted value codes with labels and listing_count. Use this to resolve the make and model codes for vehicle searches — the model list is huge and depends on the make, so look it up here rather than guessing.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category_id integer — Category ID whose filter catalog should be returned (0 is all categories) (default: 0; min: 0)
• location_id integer — Location ID the listing counts should be scoped to (default: 0; min: 0)
• locale string — Language of filter labels (default: "en"; one of: "en", "fr")

Response

• @type string (default: "KijijiListingFilter")
• name string required
• label string nullable
• type string nullable
• group string nullable
• parent_name string nullable
• min_value number nullable
• max_value number nullable
• values array (default: [])
  • @type string (default: "KijijiFilterValue")
  • value string required
  • label string nullable
  • parent_value string nullable
  • listing_count integer 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 — No filters available for this category (nonexistent category ID) 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.