/yandexsearch/search

POST /api/yandexsearch/search

Price: 50 credits

Search Yandex by query and return organic web results: destination url, title, displayed url (breadcrumb), snippet and position. Region-biased and language-aware. <br><b>Results are ordered by relevance — the first result is the most relevant.</b>

How to use it

Yandex web search by query (text). Each result is an organic SERP entry (url, title, displayed_url, snippet, position). Bias to a region with region (geo-id, e.g. 213=Moscow, 2=Saint Petersburg) and set results language with lang. Pick the domain (yandex.com international or yandex.ru Russian). Strong for Russian-language and RU-region web discovery where Google/DuckDuckGo differ.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• text string required — Search query (examples: "python fastapi", "купить ноутбук"; minLength: 1)
• count integer required — Max number of organic results to return (min: 1)
• domain string — Yandex domain — Russian (yandex.ru) or international (yandex.com) (default: "yandex.ru"; one of: "yandex.com", "yandex.ru")
• region integer nullable — Yandex region geo-id biasing local ranking (examples: 213, 2; >: 0)
• lang string nullable — Interface and results language (examples: "ru", "en"; minLength: 1)

Response

• @type string (default: "YandexSearchResult")
• url string required
• displayed_url string (default: "")
• snippet string (default: "")
• position integer (default: 0)

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 — The entity was not found, or a precondition failed 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.