Yandex

Yandex Images

Retrieve native Yandex Images data.

post/v1/yandex/images/search

Request

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

Request body

querystring

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.

widthinteger

Exact image width. Requires height.

heightinteger

Exact image height. Requires width.

file_type'jpg' | 'png' | 'gifan'

Image format.

color'color' | 'gray' | 'red' | 'orange' | 'yellow' | 'cyan' | 'green' | 'blue' | 'violet' | 'white' | 'black'

Image color filter.

orientation'horizontal' | 'vertical' | 'square'

Image orientation.

image_type'photo' | 'clipart' | 'lineart' | 'demotivator' | 'face'

Image content type.

sitestring

Image source hostname.

recentboolean

Show images discovered within seven days.

urlstring

Public HTTP or HTTPS image URL for reverse search.

cropstring

Reverse image rectangle as left;top;right;bottom fractions from 0 to 1.

crop_idstring

Source crop ID for an image on avatars.mds.yandex.net.

tab'about' | 'similar'

Reverse image result tab.

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.