Yandex

Yandex Search

Retrieve native Yandex Search data. Responses identify the source domain, interface language, and regional context; native regional defaults can affect ranking.

post/v1/yandex/search

Request

  • Base URL: https://api.prismcrawl.com
  • URL: https://api.prismcrawl.com/v1/yandex/search
  • Auth: API key in header x-api-key

Request body

querystring required

Text to search for on the selected service. At most 8,192 UTF-8 bytes.

pageinteger

One-based page number.

device'desktop' | 'mobile' | 'tablet'

Device presentation for the source request.

htmlboolean

Return the encoded original response rather than parsed JSON.

zero_traceboolean

Do not archive source or parsed response artifacts.

yandex_domain'yandex.com' | 'yandex.ru' | 'yandex.by' | 'yandex.kz' | 'yandex.uz' | 'yandex.com.tr'

Yandex marketplace domain; defaults to yandex.com.

family_modeinteger

Safe search: 0 off, 1 moderate, 2 strict.

lang'ru' | 'en' | 'be' | 'kk' | 'tr' | 'uk'

Yandex search language.

lrinteger

Yandex geographic region ID.

fix_typoboolean

Allow automatic query spelling corrections.

groups_on_pageinteger

Maximum search result groups per page.

sort_mode'relevance' | 'date'

Search result order.

period'all' | 'day' | 'last_two_weeks' | 'month'

Search publication period.

output'json' | 'html' | 'md' | 'null' nullable

Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format.

json_restrictorstring nullable

Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result.

no_cacheboolean nullable

Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.

Example request

{
  "json_restrictor": "results[].{title,url},has_next_page,next_page_token"
}

Response

Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.

successtrue required
request_idstring uuid required

Changes

No recorded changes to this operation across all 2 revisions of this API.