API reference · DataForSEO

dataforseo/v3/serp/yahoo/organic/live/advanced

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run
Model IDdataforseo/v3/serp/yahoo/organic/live/advanced
01

Input Schema

18 parameters · 1 required · 17 optional

ParameterTypeRequiredDescription
keywordstringRequiredkeyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ‘+' will be decoded to a space character) if you need to use the "%" char...
osstringOptionaldevice operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, ch...
tagstringOptionaluser-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data ob...
urlstringOptionaldirect URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields
depthintegerOptionalparsing depth optional field number of results in SERP default value: 6 max value: 200 Your account will be billed per each SERP; Each Yahoo SERP can contain fewer than 10 results, so setting depth ab...
devicestringOptionaldevice type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop
targetstringOptionaltarget domain, subdomain, or webpage to get results for optional field a domain or a subdomain should be specified without https:// and www. note that the results of target-specific tasks will only in...
se_domainstringOptionalsearch engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in t...
match_typestringOptionaltarget match type required field if stop_crawl_on_match is specified type of match for the match_value possible values: domain – specific domain or subdomain with_subdomains – main domain and subdomai...
match_valuestringOptionaltarget domain, subdomain, or wildcard value required field if stop_crawl_on_match is specified specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified withou...
search_paramstringOptionaladditional parameters of the search query optional field get the list of available parameters and additional details here
language_codestringOptionalsearch engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the sear...
language_namestringOptionalfull name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of ...
location_codeintegerOptionalsearch engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can recei...
location_namestringOptionalfull name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you c...
max_crawl_pagesintegerOptionalpage crawl limit optional field number of search results pages to crawl default value: 1 max value: 100 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help cen...
location_coordinatestringOptionalGPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate par...
stop_crawl_on_matcharrayOptionalarray of targets to stop crawling optional field specified as an array of target objects each target object consists of one match_type field and one match_value field you can specify up to 10 target o...
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description
03

Code Examples

Ready-to-run snippets

curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "dataforseo/v3/serp/yahoo/organic/live/advanced",
  "prompt": "a beautiful sunset over mountains"
}'