Skip to content
Scrappa Get API key
OLX Poland API 1 credit/request

OLX Poland Locations API Documentation

GET https://scrappa.co/api/olx-pl/locations

OLX Poland Locations API finds cities and districts by name and returns their ids with the region. No match returns an empty list, which is a valid billed answer.

OLX Poland Locations API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/olx-pl/locations
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "results": [
            {
                "city": "Krak\u00f3w",
                "region": "Ma\u0142opolskie",
                "city_id": 8959,
                "region_id": 4
            },
            {
                "city": "Krakuszowice",
                "region": "Ma\u0142opolskie",
                "city_id": 30397,
                "region_id": 4
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

query string Required

Place name, at least 2 characters. Example: Krak.

Example value coffee shops

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "results": [
            {
                "city": "Krak\u00f3w",
                "region": "Ma\u0142opolskie",
                "city_id": 8959,
                "region_id": 4
            },
            {
                "city": "Krakuszowice",
                "region": "Ma\u0142opolskie",
                "city_id": 30397,
                "region_id": 4
            },
            {
                "city": "Krakowiany",
                "region": "Dolno\u015bl\u0105skie",
                "city_id": 47985,
                "region_id": 3
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "locations"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

500

Parser Drift

OLX answered with a response shape this parser does not recognise. Never charged.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "locations"
    },
    "error": {
        "code": "PARSER_DRIFT",
        "message": "OLX response shape changed unexpectedly. The incident has been reported."
    },
    "success": false
}
503

Upstream Unavailable

The upstream service is temporarily unavailable. Please retry shortly.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "locations"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "OLX upstream is temporarily unavailable."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.