Serp

Live Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location.

post/v3/serp/yahoo/organic/live/regular

Request

  • Base URL: https://api.dataforseo.com
  • URL: https://api.dataforseo.com/v3/serp/yahoo/organic/live/regular
  • Auth: HTTP basic

Request body

urlstring nullable

<em>direct URL of the search query</em><br>optional field<br>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.<br>example:<br><code class="long-string">https://search.yahoo.com/search?p=rank+checker&amp;n=100&amp;vl=lang_en&amp;vc=us&amp;ei=UTF-8</code>

keywordstring

<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><br>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>

location_namestring

<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>

location_codeinteger

<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">2840</code>n

location_coordinatestring

<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n

language_namestring

<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><br>example:<br><code class="long-string">English</code>

language_codestring

<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><br></em>example:<br><code class="long-string">en</code>n

devicestring nullable

<em>device type</em><br>optional field<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>

osstring nullable

<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>

se_domainstring nullable

<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code>au.search.yahoo.com</code>, <code>uk.search.yahoo.com</code>, <code>ca.search.yahoo.com</code>, etc.

depthinteger nullable

<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>6</code><br>max value: <code>200</code><br><strong>Your account will be billed per each SERP;</strong> <br>Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank"></a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/yahoo-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.

max_crawl_pagesinteger nullable

<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>100</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a>

targetstring nullable

<em>target domain, subdomain, or webpage to get results for</em><br>optional field<br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<br>you can also use a wildcard (‘’) character to specify the search pattern in SERP and narrow down the results;<br>examples:<br><strong><code class="long-string">example.com</code></strong> - returns results for the website's home page with URLs, such as <code class="long-string">https://example.com</code>, or <code class="long-string">https://www.example.com/</code>, or <code class="long-string">https://example.com/</code>;<br><strong><code class="long-string">example.com</code></strong> - returns results for the domain, including all its pages;<br><strong><code class="long-string">example.com</code></strong> - returns results for the entire domain, including all its pages and subdomains;<br><strong><code class="long-string">example.com</code></strong> - returns results for the home page regardless of the subdomain, such as <code class="long-string">https://en.example.com</code>; <br><strong><code class="long-string">example.com/example-page</code></strong> - returns results for the exact URL;<br><strong><code class="long-string">example.com/example-page</code></strong> - returns results for all domain's URLs that start with the specified string

search_paramstring nullable

<em>additional parameters of the search query</em><br>optional field<br><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">get the list of available parameters and additional details here</a>

tagstring nullable

<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response

Example request

[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "albert einstein"
  }
]

Response

Successful operation

versionstring nullable

the current version of the API

status_codeinteger nullable

general status code you can find the full list of the response codes here

status_messagestring nullable

general informational message you can find the full list of general informational messages here

timestring nullable

total execution time, seconds

costnumber double nullable

total tasks cost, USD

tasks_countinteger nullable

the number of tasks in the tasks array

tasks_errorinteger nullable

the number of tasks in the tasks array returned with an error

Changes

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • breaking

      added to the ////////////////////////////// response property oneOf list for the response status

    • info

      removed from the ////////////////////////////// response property oneOf list for the response status