# /olx/regions

`POST /api/olx/regions`

Price: 1 credit

Get the OLX geography of a country marketplace: the top-level regions, or — with region_id — every city inside one region with its coordinates. Supplies the region_id and city_id used by offers/search.

## How to use it

Resolve OLX geography for a country marketplace (domain). Called without region_id it returns the top-level regions (16 voivodeships on olx.pl, the equivalent first-level units elsewhere); called with region_id it returns every city in that region with county, latitude/longitude, radius and has_districts — which tells you whether district_id applies to that city in offers/search. Use the returned ids as region_id / city_id in offers/search, optionally together with distance.

## 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 regions or cities to return (min: 1)
- `region_id` (integer, nullable) — List the cities of this region instead of the top-level regions (examples: 2; >: 0)

## Response

### 200 — Successful Response

- `@type` (string) (default: "OlxRegion")
- `id` (string, required)
- `name` (string, nullable)
- `alias` (string, nullable)
- `region_id` (string, nullable)
- `county` (string, nullable)
- `latitude` (number, nullable)
- `longitude` (number, nullable)
- `radius` (number, nullable)
- `zoom` (integer, nullable)
- `has_districts` (boolean, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

Region not found on this OLX domain

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.