/olx/categories/filters

POST /api/olx/categories/filters

Price: 20 credits

Get every search filter available in one OLX category, with its type, unit and full catalog of allowed values — the lookup that turns a category into the facets you can search it by.

How to use it

List the category-specific search facets of an OLX category (car make and mileage, phone memory, flat area and room count, job contract type, and so on). Each entry gives key — pass it straight into the filters parameter of offers/search — plus name, type (select/checkboxes/input/price/checkbox), unit, value_type and values (the allowed value/label pairs for enum filters) or suggested_ranges (typical cut-off points for numeric filters). Get category_id from the categories endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• domain string — OLX country marketplace domain. (default: "olx.pl"; one of: "olx.pl", "olx.ua", "olx.ro", "olx.bg", "olx.pt", "olx.kz", "olx.uz")
• count integer required — Max number of filters to return (min: 1)
• category_id integer required — Category id to list the available search filters for (examples: 2298; >: 0)

Response

• @type string (default: "OlxCategoryFilter")
• key string required
• name string nullable
• type string nullable
• unit string nullable
• scope string nullable
• value_type string nullable
• position integer nullable
• values array (default: [])
  • @type string (default: "OlxCategoryFilterValue")
  • value string required
  • label string nullable
• suggested_ranges array (default: [])

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 — Category not found, or it exposes no search filters on this OLX domain 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.