Skip to content
Scrappa Get API key
imot.bg API 1 credit/request

imot.bg Autocomplete API Documentation

GET https://scrappa.co/api/imot-bg/autocomplete

imot.bg Autocomplete API resolves a place name to a ready location_id for the search route. Type in Bulgarian or Latin letters. Results are cities, regions, neighbourhoods and villages with their number of listings. A query with no match returns an empty list. Failed requests are not billed.

imot.bg Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/imot-bg/autocomplete
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "\u041b\u044e\u043b\u0438\u043d",
        "results": [
            {
                "name": "\u041b\u044e\u043b\u0438\u043d - \u0446\u0435\u043d\u0442\u044a\u0440",
                "type": "neighbourhood",
                "label": "\u041b\u044e\u043b\u0438\u043d - \u0446\u0435\u043d\u0442\u044a\u0440, \u0433\u0440\u0430\u0434 \u0421\u043e\u0444\u0438\u044f",
                "parent": "\u0433\u0440\u0430\u0434 \u0421\u043e\u0444\u0438\u044f",
                "location_id": "\u0433\u0440\u0430\u0434 \u0421\u043e\u0444\u0438\u044f~\u041b\u044e\u043b\u0438\u043d - \u0446\u0435\u043d\u0442\u044a\u0440",
                "listing_count": 161
            },
            {
                "name": "\u041b\u044e\u043b\u0438\u043d 1",
...

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.

1 optional filter available.

query string Required

Search text, 2 to 100 characters. Example: Люлин or sofia.

Example value coffee shops
limit integer Optional

Number of results, 1 to 25 (default 10).

Example value 10

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": {
        "query": "\u041b\u044e\u043b\u0438\u043d",
        "results": [
            {
                "name": "\u041b\u044e\u043b\u0438\u043d - \u0446\u0435\u043d\u0442\u044a\u0440",
                "type": "neighbourhood",
                "label": "\u041b\u044e\u043b\u0438\u043d - \u0446\u0435\u043d\u0442\u044a\u0440, \u0433\u0440\u0430\u0434 \u0421\u043e\u0444\u0438\u044f",
                "parent": "\u0433\u0440\u0430\u0434 \u0421\u043e\u0444\u0438\u044f",
                "location_id": "\u0433\u0440\u0430\u0434 \u0421\u043e\u0444\u0438\u044f~\u041b\u044e\u043b\u0438\u043d - \u0446\u0435\u043d\u0442\u044a\u0440",
                "listing_count": 161
            },
            {
                "name": "\u041b\u044e\u043b\u0438\u043d 1",
                "type": "neighbourhood",
                "label": "\u041b\u044e\u043b\u0438\u043d 1, \u0433\u0440\u0430\u0434 \u0421\u043e\u0444\u0438\u044f",
                "parent": "\u0433\u0440\u0430\u0434 \u0421\u043e\u0444\u0438\u044f",
                "location_id": "\u0433\u0440\u0430\u0434 \u0421\u043e\u0444\u0438\u044f~\u041b\u044e\u043b\u0438\u043d 1",
                "listing_count": 141
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

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

422

Validation Error

A required parameter or a range is invalid. This response is not billable.

{
    "errors": {
        "page": [
            "imot.bg shows at most 1,000 results per search (25 pages). The page must be 26 or lower."
        ]
    },
    "message": "The request validation failed"
}
503

Upstream Unavailable

imot.bg could not be reached or returned data that does not match the request. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "imot.bg could not be reached. Please retry shortly."
    },
    "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.