Skip to content
Scrappa Get API key
Yandex API 1 credit/request

Yandex Search API Documentation

GET https://scrappa.co/api/yandex/search

Search the Yandex web index and read the first result page as JSON. Each organic result has the position, title, link, source site, displayed link, snippet, favicon and sitelinks. The response also lists ads, related searches and, when Yandex shows one, an entity card with a title, description and images. Narrow the search with lang (en, ru or tr), family_mode (true filters adult results), period (day, 2weeks or month) and, on the Russian site, lr (a Yandex region ID such as 213 for Moscow). A period with few matches returns fewer results; the list is never padded. Web search returns page 1 only (about 10 organic results): Yandex gives no later page to automated clients, so page above 1 answers 422. A request costs 1 credit. When Yandex blocks the normal route, a premium route answers it and the request costs 38 credits; the response meta shows the credits. A request that fails is not charged.

Yandex Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/yandex/search
Auth header
x-api-key
Cost
1 credit/request
text = pizza restaurant
Response preview
200 OK
{
    "ads": [
        {
            "link": "https://ads.example.com/click",
            "title": "Pizza delivery offer",
            "source": "example.com",
            "favicon": null,
            "snippet": "Free delivery on the first order.",
            "position": 1,
            "sitelinks": [],
            "displayed_link": "example.com"
        }
    ],
    "meta": {
...

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.

6 optional filters available.

text string Required

Search text. Alias: q.

Example value pizza restaurant
yandex_domain string Optional

Yandex site to search. Web and videos: com (default), ru, kz, by or com.tr. Images: com (default), ru, kz or by. Each site has its own index.

Example value example
lang string Optional

Result language: en, ru or tr.

Example value en
lr integer Optional

Yandex region ID, for example 213 for Moscow or 2 for Saint Petersburg. Works with yandex_domain=ru only.

Example value lang_en
family_mode boolean Optional

true filters adult results, false allows them. Yandex default applies when omitted.

Example value true
period string Optional

Only recent results: day, 2weeks or month.

Example value example
page integer Optional

Only 1 is accepted. Yandex serves the first result page only.

Example value 1

Response Schema

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

Example response fields

Scan these fields before integrating.

ads meta success answer_box pagination organic_results related_searches search_information

Common ads fields

link title source favicon
JSON Response
200 OK
{
    "ads": [
        {
            "link": "https://ads.example.com/click",
            "title": "Pizza delivery offer",
            "source": "example.com",
            "favicon": null,
            "snippet": "Free delivery on the first order.",
            "position": 1,
            "sitelinks": [],
            "displayed_link": "example.com"
        }
    ],
    "meta": {
        "billable": true,
        "duration_ms": 2400,
        "upstream_calls": 2
    },
    "success": true,
    "answer_box": {
        "title": "Pizza",
        "images": [
            "https://avatars.mds.yandex.net/i?id=example"
        ],
        "description": "Pizza is a dish of Italian origin."
    },
    "pagination": {
        "page": 1,
        "max_page": 1
    },
    "organic_results": [
        {
            "link": "https://www.doordash.com/cuisine/pizza-near-me/",
            "title": "Best Pizza Near Me - Order Pizza on DoorDash",
            "source": "Doordash.com",
            "favicon": "https://favicon.yandex.net/favicon/v2/https%3A%2F%2Fwww.doordash.com?size=32",
            "snippet": "Order Pizza near you. Choose from the largest selection of Pizza restaurants and have your meal delivered to your door.",
            "position": 1,
            "sitelinks": [
                {
                    "link": "https://www.doordash.com/menu",
                    "title": "Menu"
                }
            ],
            "displayed_link": "doordash.com \u203a cuisine \u203a pizza-near-me"
        }
    ],
    "related_searches": [
        {
            "query": "pizza restaurants near me",
            "position": 1
        }
    ],
    "search_information": {
        "lang": "en",
        "query": "pizza restaurant",
        "yandex_domain": "com"
    }
}

Errors

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

Validation Error

Returned when a required parameter is missing, a value is out of range or a parameter is not supported. No credits are charged.

Service Unavailable

Returned when Yandex could not be read after several attempts. Failed requests are not charged. Try again.

Unexpected Response

Returned when Yandex answers with a page this API cannot read, or an image cannot be read. Failed requests are not charged.

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.