Tool ID:
dataforseo_serp_yahoo_organic_live_regularRun this action
Use the TypeScript SDK for one call. Usectx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'dataforseo_serp_yahoo_organic_live_regular',
{
"keyword": "software companies hiring engineers"
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute dataforseo_serp_yahoo_organic_live_regular --input '{
"keyword": "software companies hiring engineers"
}' --json
Example response
The SDK returns this shape atresult.toolResponse.raw. The example values illustrate the response.
{
"version": "example",
"status_code": 123,
"status_message": "example",
"time": "example",
"tasks_count": 123,
"tasks_error": 123,
"tasks": [
{}
]
}
deepline describe dataforseo_serp_yahoo_organic_live_regular --json for the latest machine-readable contract.
Input reference
Live Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
payload.url | string | No | — | direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://search.yahoo.com/search?p=rank+checker&n=100&vl=lang_en&vc=us&ei=UTF-8 |
payload.keyword | string | Yes | — | keyword 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 ”%” character for your keyword , please specify it as “%25”. if you need to use the “+” character for your keyword , please specify it as “%2B” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article |
payload.location_name | string | No | — | full 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 can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/yahoo/locations example: London,England,United Kingdom |
payload.location_code | integer | No | — | search 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 receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/yahoo/locations example: 2840 |
payload.location_coordinate | string | No | — | GPS 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 parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude” : 7 the minimum value for “radius” : 199.9 (mm) the maximum value for “radius” : 199999 (mm) example: 53.476225,-2.243572,200 |
payload.language_name | string | No | — | full 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 the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/yahoo/languages example: English |
payload.language_code | string | No | — | search 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 search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/yahoo/languages example: en |
payload.device | string | No | — | device type optional field can take the values: desktop , mobile default value: desktop |
payload.os | string | No | — | device 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, choose from the following values: android , ios default value: android |
payload.se_domain | string | No | — | search 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 this field example: au.search.yahoo.com , uk.search.yahoo.com , ca.search.yahoo.com , etc. |
payload.depth | integer | No | — | parsing depth optional field number of results in SERP default value: 6 max value: 700 Your account will be billed per each SERP. Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges . The cost can be calculated on the Pricing page. |
payload.max_crawl_pages | integer | No | — | page 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 center |
payload.target | string | No | — | target 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 include SERP elements that contain a url string. You can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results. examples: example.com - returns results for the website’s home page with URLs, such as https://example.com , or https://www.example.com/ , or See the live schema for the complete constraint. |
payload.search_param | string | No | — | additional parameters of the search query optional field get the list of available parameters and additional details here |
payload.stop_crawl_on_match | array | No | — | array 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 objects in this array if specified, the response will contain SERP results up to and including the specified match_value . example: “stop_crawl_on_match”:[{“match_value”:“dataforseo.com”,“match_type”:“with_subdomains”}] learn more about this parameter on our Help Center Your account will be billed See the live schema for the complete constraint. |
payload.tag | string | No | — | user-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 object of the response |
Output reference
Top-level response envelope for dataforseo_serp_yahoo_organic_live_regular.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
result.version | string | Yes | — | the current version of the API |
result.status_code | integer | Yes | — | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
result.status_message | string | Yes | — | general informational message you can find the full list of general informational messages here |
result.time | string | Yes | — | execution time, seconds |
result.tasks_count | integer | Yes | — | the number of tasks in the tasks array |
result.tasks_error | integer | Yes | — | the number of tasks in the tasks array returned with an error |
result.tasks | array | Yes | — | array of tasks |
Deepline cost
- Pricing model:
provider_usage(provider usage). - Estimated Deepline credits:
0.03per pricing unit.