AIsa SERP — Other Engines
Server Details
Google is not the whole market. Your agent needs Bing, Yahoo, Baidu, Naver, Seznam and YouTube results — the engines that decide whether you exist in China, Korea, Japan or Central Europe.
What you can ask for • "What ranks for this term on Baidu, and how different is it from Google?" • "Check Naver results for our Korean brand name." • "Compare Bing and Yahoo results for the same query." • "What comes up on YouTube search for this phrase in Japanese?" • "Take a screenshot of the results page as a user there sees it."
How to use it Point any MCP client at https://mcp.aisa.one/seo-serp-other-engines/mcp and sign in with OAuth — there is no key to create or paste. 34 tools: organic results from Bing, Yahoo, Baidu, Naver and Seznam in live, regular and raw-HTML forms, YouTube search, an AI summary of a result set, and a rendered screenshot.
Why this rather than the source The engines that matter outside the US, with the same call shape as the Google ones.
It is also a door to the rest The same login reaches 26 sources and 580+ operations. Check the local engine here, then ask the same agent what the site's traffic or backlinks look like in that market — without adding a second server.
What it costs Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident.
Where else it reaches https://mcp.aisa.one/seo-serp/mcp for Google itself. https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
- Status
- Healthy
- Uptime
- 94.6% over 48 days
- OAuth
- Works in Glama
- Last Tested
- Transport
- Streamable HTTP · MCP 2025-11-25
- URL
TDQS
Scored across 41 tools
Most engine endpoints are distinguishable by engine + mode, but the task-based trio on Baidu/Naver/Seznam (`organic_fetch`, `organic_fetch_regular`, `organic_fetch_html`) is essentially indistinguishable because all three share the placeholder description 'Description of the fields for sending a request'. The split between submit-then-fetch engines (Baidu/Naver/Seznam) and live engines (Bing/Yahoo/YouTube) is also not made explicit, so an agent can easily call the wrong lifecycle step. The deprecated `use` sitting alongside `batch_use` adds a further, though clearly flagged, trap.
The 34 DataForSEO tools follow one rigid, predictable pattern `{get|post}_dataforseo_serp_{engine}_{endpoint}`, which is easy to scan. The remaining control-plane tools (`search`, `batch_quote`, `batch_use`, `batch_get_schema`, `list_categories`, `account`, `use`) use a different, looser convention including a bare noun (`account`) and bare verbs (`search`, `use`). This is a minor deviation across two families rather than chaotic mixing.
41 tools is well past the 25+ threshold, and much of the bulk is near-duplicate endpoint permutations across six engines (languages/locations/fetch/html/regular/live). The surface could be collapsed by parametrizing engine and mode instead of exposing one tool per combination. The control-plane tools plus dozens of generated endpoint wrappers make the set heavy for what is a single SEO/SERP data domain.
SERP retrieval is covered for Baidu, Bing, Naver, Seznam, Yahoo and YouTube, plus AI summary, screenshot and account/quote plumbing, so core lookup needs are met. However coverage is asymmetric: Baidu has no live endpoint, and Bing/Yahoo/YouTube have no queued submit/fetch pair, so an agent needing a specific delivery mode for a given engine can hit a dead end. Naver legitimately lacks language/location lists, but there is no engine-limits or result-parsing helper to round out the lifecycle.
Available Tools
41 toolsaccountShow account and usageARead-onlyInspect
Who am I, what can I use, how much can I spend: the key, the account balance, the Go-to-Market wallet when one is active, and usage for today, 7 days and 30 days. Free; needs the Authorization header. Call it to verify a new connection or to explain a 402. ok is true only when the balance was read; otherwise each entry of errors says what to do in next_step.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds substantial context beyond the readOnlyHint/openWorldHint/destructiveHint annotations: the call is free, it requires the Authorization header, and it discloses result semantics ('ok is true only when the balance was read; otherwise each entry of errors says what to do in next_step'). That tells an agent how to interpret partial failure, which annotations cannot convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with what the agent gets, followed by cost/auth, then call triggers, then result interpretation. No sentence is redundant and none could be dropped without losing information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter read tool with an output schema already present, the description covers the remaining gaps: cost, auth requirement, invocation triggers, and the ok/errors/next_step contract. Nothing an agent needs to call or interpret it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so the description has nothing parameter-level to compensate for, and the schema is fully covered. A 4 rather than 5 reflects that it adds no input-syntax detail, though none is possible here.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a concrete resource set (identity/key, account balance, Go-to-Market wallet, usage over 1/7/30 days) rather than restating the name. It is clearly distinguishable from every sibling, which are all Reddit, batch, or search tools. An agent knows exactly what it will learn by calling it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit triggering conditions are given: 'Call it to verify a new connection or to explain a 402.' That is a strong when-to-use statement. It stops short of 5 because it names no alternative tool or a when-not condition, though the sibling list offers no obvious competing diagnostic.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
batch_get_schemaGet AIsa tool schemas in one batchARead-onlyIdempotentInspect
Retrieve schemas for 1 to 20 exact tool names from search. Build arguments from successful schemas, then call batch_quote. Do not call batch_use yet. Use tool names exactly as search returns them, without a client prefix such as mcp__aisa__. Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.
| Name | Required | Description | Default |
|---|---|---|---|
| tools | Yes | Exact tool names returned by search whose complete contracts are needed. Never invent tool names. | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. | |
| include_documentation | No | Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support. | |
| include_response_schema | No | Return the complete response_schema. Defaults to false. | |
| include_arguments_schema | No | Return the complete arguments_schema. Defaults to true. |
Output Schema
| Name | Required | Description |
|---|---|---|
| tools | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| error_count | Yes | |
| total_count | Yes | |
| success_count | Yes | |
| next_steps_guidance | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description is not required to restate it. It adds genuine operational context: the batch_use prohibition, exact-name/prefix requirements, and session reuse semantics. It does not cover failure handling when names are invalid, keeping it below a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action and size limit, and every sentence carries workflow value. The session_id sentence duplicates the schema's own parameter description, which is minor redundancy rather than bloat.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only batch retrieval tool with an output schema, the description supplies the orchestration context an agent needs (source of names, next steps, session handling) without needing to explain return values. Nothing essential to correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds real meaning beyond the schema by constraining names to those returned by search and warning against a client prefix such as mcp__aisa__, which is not encoded in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Retrieve schemas for 1 to 20 exact tool names') and pins the source of those names to search. This clearly separates it from siblings like search (finds tools), batch_quote, and batch_use.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly sequences the workflow: build arguments from successful schemas, then call batch_quote, and 'Do not call batch_use yet.' This is an explicit when-to-use and when-not-to-use instruction naming the alternative siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
batch_quoteQuote published AIsa tools without executing themARead-onlyIdempotentInspect
Obtain AIsaServices cost quotes for 1 to 20 published tools without executing them. Same input as batch_use: exact tool names and schema-valid arguments. Never falls back to execution. The response reports auto_execute_eligible and auto_execute_threshold_micros_usd. auto_execute_eligible waives only the extra cost-confirmation step and does not override a user prohibition on execution, a narrower scope, or a tighter budget limit. Quotes are price observations, not authorization grants. Use tool names exactly as search returns them, without a client prefix such as mcp__aisa__. Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.
| Name | Required | Description | Default |
|---|---|---|---|
| calls | Yes | ||
| search_id | No | Optional search correlation identifier returned by search. | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | |
| batch_id | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| error_count | Yes | |
| total_count | Yes | |
| success_count | Yes | |
| next_steps_guidance | Yes | Deterministic next-step instructions derived from this result. Not an authorization grant. |
| auto_execute_eligible | No | True when the worst-known total of successful USD quotes is at or below auto_execute_threshold_micros_usd. A non-USD successful quote makes the batch ineligible. Present on quote responses. |
| auto_execute_threshold_micros_usd | No | Configured auto-execute threshold in micro-USD. 0 disables automatic execution. Present on quote responses. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well past the readOnly/idempotent annotations by explaining that quotes are price observations rather than authorization grants, and precisely delimiting what auto_execute_eligible does and does not waive (user prohibition, narrower scope, tighter budget). It also guarantees no execution fallback, which is the key behavioral risk for this tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded and most sentences carry distinct rules (no fallback, eligibility limits, naming, session reuse). It is on the long side and the argument-shape constraint is stated twice in spirit, but little is truly wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value documentation isn't required, yet the description still flags the two response fields that matter for a downstream decision. Combined with session and naming guidance, an agent has everything needed to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
At 67% schema coverage the schema already documents each parameter, so the description earns credit only for added meaning: exact-name rules for 'tool', session_id reuse semantics, and the 1-to-20 argument-shape parallel with batch_use. It doesn't clarify search_id beyond what the schema states.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Obtain AIsaServices cost quotes for 1 to 20 published tools') plus the crucial scope qualifier 'without executing them.' It is immediately distinguishable from the sibling batch_use, which executes rather than quotes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names the parallel sibling ('Same input as batch_use') and draws the boundary ('Never falls back to execution'). It also gives operational conditions: use names exactly as search returns them, strip any mcp__aisa__ prefix, and reuse session_id from Search for the task.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
batch_useExecute published AIsa toolsADestructiveInspect
Billable API calls can incur substantial charges. Never call before a successful batch_quote for the same tools and arguments. Execute only when that quote response reports auto_execute_eligible=true for these calls, or when explicit user authorization covers that cost and risk. auto_execute_eligible waives only the extra cost-confirmation step; it does not override a user prohibition on execution, a narrower scope, or a tighter budget limit. Re-quote if tools, arguments, or scope change. Execute 1 to 20 independent published-tool calls; never silently retry. A missing or failed quote is not free. Use tool names exactly as search returns them, without a client prefix such as mcp__aisa__. Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.
| Name | Required | Description | Default |
|---|---|---|---|
| calls | Yes | ||
| search_id | No | Optional search correlation identifier returned by search. | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
Output Schema
| Name | Required | Description |
|---|---|---|
| results | Yes | |
| batch_id | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| error_count | Yes | |
| total_count | Yes | |
| success_count | Yes | |
| next_steps_guidance | Yes | Deterministic next-step instructions derived from this result. Not an authorization grant. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover mutability, destructiveness, and open-world behavior. The description adds critical business logic: billable calls, quote dependency, the meaning of auto_execute_eligible (waives only cost confirmation, not user prohibitions), and no silent retry. It doesn't detail rate limits or return format, but with an output schema present, that's acceptable.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense and front-loads the cost warning, but it packs many separate instructions into one block, making it less scannable. Some sentences like 'A missing or failed quote is not free' add value, but the overall flow could be better structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the destructive, open-world annotations and the presence of an output schema, the description covers the essential preconditions and behavioral constraints. It could mention error handling or partial failure behavior, but the core guidance is sufficient for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 67%, and the description adds important semantics: tool names must be exact without client prefix, session_id reuse guidance, and 1-20 call limit. It doesn't explain search_id, but the schema description for search_id is already clear enough.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb and resource: 'Execute 1 to 20 independent published-tool calls', and the title matches. It distinguishes itself from batch_quote by requiring a quote first, but doesn't explicitly contrast with the singular 'use' sibling, though that's implied by 'batch'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use and when-not-to-use conditions: only after a successful batch_quote with auto_execute_eligible=true or explicit user authorization. It also states re-quote conditions and prohibits silent retries, leaving little ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_baidu_languagesList of Baidu Languages for SERPBRead-onlyIdempotentInspect
You will receive the list of languages by calling this API. You can also download the full list of supported languages in the CSV format (last updated 2026-04-06).
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds useful extras — CSV download of the full list and a last-updated date (2026-04-06) — but says nothing about response format or whether the list is cached/static. Comparable in weight to a scope-only addition, so a 3.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two substantive sentences: what you get, plus the CSV alternative and freshness date. The opening clause restates the obvious ('You will receive the list of languages') and the pricing boilerplate is injected noise, but the payload is compact overall.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter, read-only lookup with an output schema present, the description covers purpose and an alternate retrieval channel (CSV) plus data freshness. Nothing needed to invoke it correctly is missing; the only gap is which downstream call consumes the returned language codes.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so there is nothing to document; baseline 4 applies. The description correctly implies a no-argument retrieval.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific resource (the list of supported Baidu SERP languages) and the name pins the engine and data type, so it is distinguishable from sibling endpoints like get_dataforseo_serp_baidu_locations or get_dataforseo_serp_bing_languages. The phrasing 'You will receive... by calling this API' is slightly passive and never explicitly contrasts with those siblings, keeping it short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no note that this endpoint should be called to obtain language codes before submitting Baidu SERP tasks, and no routing to the alternative endpoints (e.g., baidu_locations for location codes). Usage can only be inferred from the tool name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_baidu_locationsList of Baidu Locations for SERPARead-onlyIdempotentInspect
You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds two pieces of genuinely new context – the country filtering use case and a usage-based billing estimate (~$0.012/request) – but says nothing about response shape or pagination, which is acceptable since an output schema exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The functional content is two short sentences with the result statement front-loaded and no redundancy. The appended pricing block is boilerplate but clearly delimited and brief, so it does not materially dilute the definition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter lookup with an output schema and full annotation coverage, the agent needs only to know what it returns and how the result is consumed. The description supplies both (list of locations, usable for country filtering later), so nothing essential is missing; the absence of explicit Baidu wording is compensated by the tool name.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so the baseline of 4 applies. The description's only 'parameter-like' mention, filtering by country, belongs to the downstream task submission rather than this call, and should not be mistaken for an input to this tool.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource combination ('receive the list of locations'), and the tool name/title anchor it to Baidu SERP rather than any other engine. It does not itself contrast against the parallel get_dataforseo_serp_*_locations siblings, but the engine qualifier in the name makes the resource unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The only guidance is implicit: 'You can filter the list of locations by country when setting a task,' which hints the output feeds task submission. It never says when to call this rather than a *_languages tool or an organic_fetch sibling, nor that a task must be created afterward. Adequate but leaves the routing decision to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_baidu_organic_fetchGet Baidu Organic SERP Advanced Results by idDRead-onlyIdempotentInspect
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The only behavioral value the description adds is the published reference price ($0 per successful request), which is genuinely beyond the annotations, but nothing about the 30-day retrieval window, rate limits, or result availability is disclosed here.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but brevity here comes from under-specification rather than efficiency. The lead sentence is a non-statement placeholder that does no work, and only the pricing fragment carries any information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return values need not be explained, but the description still omits the tool's basic function and does not distinguish it from numerous near-identical siblings (regular, html, naver/seznam/yahoo equivalents). For a task-result fetch tool in a dense family, this is inadequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and there is a single well-documented 'id' parameter (UUID, usable within 30 days), so the schema carries the full burden. The description adds no syntax or format detail beyond what the schema already provides, making the baseline 3 appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does; it opens with a dangling header ('Description of the fields for sending a request:') and then only pricing boilerplate. Any sense of purpose comes entirely from the title and tool name, not the description, so the description is effectively missing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no prerequisites, and no mention of alternatives such as the regular or html fetch siblings or the submit/live variants. The agent is given nothing to route by.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_baidu_organic_fetch_htmlGet Baidu Organic HTML Results by idDRead-onlyIdempotentInspect
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so safety is covered. The description adds only a boilerplate $0 pricing blurb with a 'may differ' disclaimer, and omits genuinely useful behavior such as the HTML output format or the id retention window (which lives only in the schema).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but the brevity is under-specification rather than conciseness: a dangling header sentence followed by an HTML-commented pricing block. Neither sentence conveys actionable information about the tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values need not be described, and the schema covers the single input. However, the description supplies no statement of what the tool retrieves or where the id comes from, leaving the agent to reconstruct the workflow from sibling names alone.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one parameter (id) with 100% schema description coverage, including the UUID format and the 7-day reuse window. The description adds nothing about the parameter, so the baseline 3 applies since the schema fully documents it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does. 'Description of the fields for sending a request:' is a placeholder header, not a purpose statement, and it does not even restate the name or title. An agent learns the tool's function only from the tool name/title, not from the description text.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance whatsoever. Nothing distinguishes this fetch-by-id tool from siblings like get_dataforseo_serp_baidu_organic_fetch, ..._fetch_regular, or the post_*_submit tools that produce the id this tool consumes.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_baidu_organic_fetch_regularGet Baidu Organic SERP Results by id(regular)DRead-onlyIdempotentInspect
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnlyHint, idempotentHint, destructiveHint=false, openWorldHint). The description adds a pricing note, which is a small piece of behavioral context, but says nothing about retrieval semantics, task-id lifetime, error behavior, or what the call actually returns.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short, but its first sentence is meaningless filler and the only substantive content is an embedded pricing callout. It is not front-loaded with useful information, and the opening sentence does not earn its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Even accounting for a rich output schema and safety annotations, the description is effectively empty. It provides no purpose or usage context, so an agent must rely entirely on the name/title and sibling list to decide if and how to call it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the single required 'id' parameter is fully documented in the schema. The description adds no parameter-level semantics beyond the schema, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description does not state what the tool does. It opens with the meta-sentence 'Description of the fields for sending a request:' and then only provides pricing boilerplate, leaving the actual purpose entirely to the tool name and title.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives such as get_dataforseo_serp_baidu_organic_fetch, ..._fetch_html, or any other sibling. No context, prerequisites, or exclusions are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_bing_languagesList of Bing Languages for SERPCRead-onlyIdempotentInspect
You will receive the list of languages by calling this API.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so safety is fully covered by structured data. The description adds no behavioral context beyond what the title states (the list of languages) and the pricing note; it does not mention that the result is static reference data, caching behavior, or rate/credit implications beyond the boilerplate cost line.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single short sentence delivers the core idea up front, followed by a clearly delimited pricing block. The pricing boilerplate is arguably noise for tool selection but is compact and marked off, so it does not obscure the meaning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists and annotations cover the safety profile, so the description needn't explain return values or side effects. However, for a reference-data lookup with many near-identical siblings, it should at least identify Bing and clarify that this is a static catalog rather than a search operation; that gap leaves it minimally adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so there is no parameter semantics to explain; baseline 4 applies. The description correctly implies a no-input lookup.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The sentence 'You will receive the list of languages by calling this API' states the resource (languages) but never names the verb or the provider scope (Bing); it relies entirely on the tool name and title. It does convey the general purpose, but it does not distinguish this from siblings like get_dataforseo_serp_bing_locations or the other providers' language endpoints.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to call this tool, when not to, or which sibling to prefer (e.g., bing_locations, or the other providers' language lists). The only extra text is billing boilerplate, which gives no selection guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_bing_locationsList of Bing Locations for SERPARead-onlyIdempotentInspect
You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is fully covered. The description's only added behavioral content is the usage-based billing estimate ($0.02 default request), which is useful cost context, but it says nothing about pagination, list size, or coverage limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core message is front-loaded in the first sentence and the filtering hint follows immediately. The opening 'You will receive ... by this API call' is slightly padded and the injected pricing block is boilerplate, but nothing is misleading or bloated.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no parameters and an output schema present, the description does not need to document return values. It adequately covers what the call yields and how the result is used, leaving only minor gaps around list scope/size.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so per the baseline there is nothing for the description to disambiguate. It still notes that filtering happens downstream ('when setting a task') rather than via this call's arguments, which prevents an agent from hunting for a non-existent country parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific resource ('the list of locations') for the Bing SERP context, so the agent can tell it returns location data rather than organic results. However, it never distinguishes itself from the near-identical siblings get_dataforseo_serp_baidu_locations or get_dataforseo_serp_seznam_locations beyond the implicit Bing scope in the name/title.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
'You can filter the list of locations by country when setting a task' hints at the intended workflow (look up locations before creating a task), but it never states when to call this versus the languages sibling or the organic_fetch tools. Usage is implied rather than explicitly framed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_seznam_languagesList of Seznam Languages for SERPCRead-onlyIdempotentInspect
You will receive the list of languages by calling this API.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered structurally. The description contributes non-obvious behavioral context in the form of usage-based billing with a $0.012 default request estimate, but says nothing about response shape, caching, or whether the language list is static.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short, but its first sentence is filler that merely restates the title, and the pricing comment block is boilerplate injected across tools. Little of the text is load-bearing, though it is at least front-loaded and not bloated.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter read tool with an output schema (so return values need not be described), the essentials are technically present, and pricing is disclosed. However, an agent still cannot tell from the description why it should pick this Seznam language list over the sibling engine language lists, nor what the returned language codes are used for.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so there is nothing for the description to disambiguate. Baseline is 4 for a parameterless tool; no additional parameter meaning is needed or missing.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The sentence 'You will receive the list of languages by calling this API' essentially restates the title 'List of Seznam Languages for SERP' without adding a real verb/resource statement or any scope details. Nothing distinguishes it from the many sibling language tools (baidu_languages, bing_languages, yahoo_languages, youtube_languages) beyond the tool name itself.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to call this tool, what prerequisites exist, or how it relates to siblings such as get_dataforseo_serp_seznam_locations or the seznam_organic_fetch tools. The only added text is a billing disclaimer, which is not usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_seznam_locationsList of Seznam Locations for SERPBRead-onlyIdempotentInspect
You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive, openWorld. The description adds almost nothing beyond the pricing note: no return shape, no pagination, no rate limits. The filtering remark hints at downstream task setting but is vague, and since the input schema has zero parameters the filtering claim is confusing.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core sentence is short and front-loaded, but the pricing boilerplate and the irrelevant filter sentence add noise. The description is small but not tight.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values needn't be explained, and annotations cover safety. The description is adequate for a no-param lookup but fails to clarify what the list is used for beyond a vague task-setting remark, leaving an agent to infer the Seznam context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Zero parameters, so baseline is 4. The description's mention of filtering by country is not tied to any parameter and could mislead, but with no params there is little else required.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific resource (list of Seznam SERP locations) and the call returns locations. It is distinguishable from the sibling Seznam languages tool and from organic fetch tools by name and description, though it doesn't explicitly name a sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The sentence 'You can filter the list of locations by country when setting a task' implies context (used before submitting a task) but gives no explicit when-to-use versus alternatives and no exclusions. No routing to sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_seznam_organic_fetchGet Seznam Organic SERP Advanced Results by idCRead-onlyIdempotentInspect
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so safety is covered. The description adds only a cost note ($0 reference price, account-specific settlement may differ), which is a small piece of context but says nothing about behavior, task lifetime, or error conditions beyond what the schema already states.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but the opening sentence is a dangling stub that promises a field description that is never delivered, and the rest is repeated boilerplate pricing markup. Nothing is front-loaded about the actual operation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values need not be explained, but the description omits the essential submit-then-fetch workflow context and any differentiation from the _html/_regular/live variants. Given the dense set of sibling tools, an agent gets almost no help deciding to call this one.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is a single parameter with 100% schema description coverage, so the schema already explains the UUID task identifier and its 30-day validity. The description adds no parameter meaning whatsoever, but with full schema coverage the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description body is a stub header ('Description of the fields for sending a request:') that never states what the tool does; only the name and title carry meaning. It does not distinguish this advanced fetch from the _html or _regular Seznam siblings. Effectively the description restates nothing, leaving purpose to the tool name.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance at all. It never mentions that this retrieves results for a task previously created via post_dataforseo_serp_seznam_organic_submit, nor when to prefer it over get_dataforseo_serp_seznam_organic_fetch_html or _regular. The pricing line is the only content and provides no routing information.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_seznam_organic_fetch_htmlGet Seznam Organic HTML Results by idCRead-onlyIdempotentInspect
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive and openWorld, so the safety profile is covered. The description adds only a generic pricing note, not operational context such as the fact that results expire (the 7-day retention detail lives in the schema, not here) or that HTML output differs in shape from the regular endpoint.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but brevity here reflects absent content rather than efficient content: the lead sentence is an unfinished placeholder and the second block is auto-injected pricing boilerplate. No substantive information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema and full annotations present, the technical scaffolding is covered, but for a tool sitting among ~40 sibling SERP fetchers the description supplies none of the disambiguation an agent needs to pick fetch_html over fetch_regular or the per-engine variants. It is incomplete for its actual selection task.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% for the single 'id' parameter, and it documents the UUID format and the 7-day reuse window, so the baseline of 3 applies. The description adds no parameter meaning beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description is a placeholder fragment ('Description of the fields for sending a request:') followed by a pricing boilerplate block; it never states that the tool retrieves previously-submitted Seznam organic SERP results as HTML. The only purpose signal comes from the title/name, which the description merely restates by implication.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no prerequisite that a task must first be submitted via post_dataforseo_serp_seznam_organic_submit, and no differentiation from the many sibling fetchers (fetch, fetch_regular, fetch_html for baidu/naver/seznam). Nothing routes the agent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_seznam_organic_fetch_regularGet Seznam Organic SERP Results by id(regular)CRead-onlyIdempotentInspect
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered elsewhere. The only thing the description adds is an auto-injected pricing note ($0/reference price), which is boilerplate rather than meaningful behavioral context such as the 30-day result-retrieval window.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Brevity here reflects under-specification, not efficiency: the leading sentence promises a description of request fields and then delivers none. The only substantive content is an injected pricing block unrelated to tool selection or invocation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Although an output schema exists (so return values needn't be described) and annotations cover safety, the description supplies essentially no information about purpose, prerequisites, or the submit-then-fetch workflow. For a read-by-id retrieval tool with many near-identical siblings, this leaves the agent without the context needed to use it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single parameter has 100% schema coverage, including a clear explanation of the UUID task identifier and the 30-day reuse window, so the schema fully carries parameter meaning. The description adds nothing beyond that, which is the baseline 3 for high-coverage schemas.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description text is only a dangling placeholder heading ('Description of the fields for sending a request:') followed by injected pricing boilerplate. It never states what the tool does; only the tool name/title ('Get Seznam Organic SERP Results by id') conveys the verb+resource, and the description does nothing to sharpen or differentiate it from siblings like get_dataforseo_serp_baidu_organic_fetch_regular.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance at all, no mention of the fetch-by-id-after-submit lifecycle, and no routing to alternatives such as the corresponding 'submit' or 'html' variants. An agent gets zero help choosing this tool over its many siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_yahoo_languagesList of Yahoo Languages for SERPCRead-onlyIdempotentInspect
You will receive the list of languages by calling this API.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, openWorld, and non-destructive, so the safety profile is covered. The description's one genuine addition is the usage-based billing disclosure (~$0.012 per request), which is real behavioral context not present in structured fields; beyond that it discloses nothing about the response shape or pagination.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, and the pricing note is legitimately useful, but the lead sentence ('You will receive the list of languages by calling this API') is pure filler that occupies the front-loaded position. The informative content is a billing comment block rather than a description of the tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With zero parameters, full annotation coverage, and an output schema that documents the return value, the definition is close to sufficient for invoking the tool. What is missing is the context most needed in a 40-tool family: that this returns Yahoo SERP languages specifically versus the parallel Baidu/Bing/Seznam/YouTube language lists.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so per the rubric the baseline is 4. The description adds nothing here, but there is nothing to add – no parameter semantics are missing.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description says only 'You will receive the list of languages by calling this API' – essentially restating the title 'List of Yahoo Languages for SERP' without naming Yahoo, SERP, or the DataForSEO context. It does not distinguish this tool from the many sibling list endpoints (baidu_languages, bing_languages, seznam_languages, yahoo_locations), so an agent gains no discriminating signal from the text.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no prerequisites, and no mention of alternatives such as get_dataforseo_serp_yahoo_locations or the other vendor language lists. The only sentence is a restatement of the call itself, leaving the agent to infer selection from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_yahoo_locationsList of Yahoo Locations for SERPARead-onlyIdempotentInspect
You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is fully covered. The description's only added behavioral fact is the usage-based billing estimate ($0.012 default), which is boilerplate, and it says nothing about result size or any return-shaping limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core content is two short sentences, front-loaded with what is returned. The opening 'by this API call' is filler, and the pricing comment block pads the text, but nothing is buried or redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter lookup with full annotation coverage and an output schema, the description supplies what an agent needs: what comes back and the country-filtering context. It is adequate, though it could note that the full list is returned without pagination.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters (empty schema, 100% coverage), so per the baseline a 4 is appropriate: there is no parameter semantics to explain, and the description adds no conflicting or misleading param information.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear verb+resource ('you will receive the list of locations'), so an agent knows this is a lookup of location values. However, it never says these are Yahoo SERP locations, relying on the name/title, and it does not distinguish itself from siblings like get_dataforseo_serp_yahoo_languages or get_dataforseo_serp_youtube_locations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
'You can filter the list of locations by country when setting a task' hints at the purpose (supplying location values for task submission) but does not state when to call this tool versus alternatives. Usage is implied rather than spelled out, and no exclusions or prerequisites are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_youtube_languagesList of Youtube Languages for SERPCRead-onlyIdempotentInspect
You will receive the list of languages by calling this API.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is covered. The description adds a genuinely useful behavioral fact not present in annotations: it is usage-billed with a default estimate of $0.012 USD per request. It does not, however, describe the response shape or latency, so it adds moderate value only.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The intent is front-loaded in a single sentence, but roughly half the content is injected billing boilerplate unrelated to the tool's function. The core sentence is tautological, so the text is short but not efficient in adding information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter listing tool with an output schema (so return values need not be explained), the description is minimally adequate. However, it omits the one thing an agent actually needs — that this returns YouTube SERP languages specifically, distinct from the other platform language listers.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so per the rubric this is a baseline 4. There is nothing for the description to clarify beyond confirming it can be called with no arguments.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description ('You will receive the list of languages by calling this API') essentially restates the title 'List of Youtube Languages for SERP' and the tool name without adding specificity. It never mentions YouTube or SERP in the body, so it fails to distinguish this from the many sibling language-list tools (baidu, bing, yahoo, seznam languages).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to call this tool versus alternatives such as get_dataforseo_serp_baidu_languages or get_dataforseo_serp_youtube_locations. No prerequisite or context is provided; the agent must infer usage entirely from the name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_youtube_locationsList of Youtube Locations for SERPBRead-onlyIdempotentInspect
You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is covered. The description adds that the call returns a static location list and includes a cost estimate ($0.012 default), which is genuinely useful behavioral context, but it says nothing about response shape or whether filtering must happen at task-submission time. Modest added value over annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Very short, which is appropriate, but the opening sentence is redundant filler ('by this API call') and the description is dominated by an injected pricing boilerplate block. The useful content is one clause; the rest is padding.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and zero parameters, the description needn't explain return values, and annotations cover safety. The remaining gap is the lack of any signal distinguishing this from the ~20 sibling location/language tools in the same namespace, which is the main thing an agent needs here.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so there is nothing to document — the baseline of 4 applies. The description's note about country filtering is about downstream task configuration rather than this tool's inputs, which is not misleading but also not a parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states it returns a list of locations, but the first sentence ('You will receive the list of locations by this API call') largely restates the name and never itself mentions YouTube. The title carries the YouTube-specific meaning, and there is no differentiation from the many sibling *_locations and *_languages tools. Purpose is inferable but vague in the body text.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The only guidance is 'You can filter the list of locations by country when setting a task,' which implies a downstream use but not when to call this tool versus get_dataforseo_serp_youtube_languages or the baidu/bing/yahoo/seznam location siblings. No exclusions or alternatives are given, so an agent has no routing signal.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_categoriesBrowse the AIsa catalogueARead-onlyInspect
The AIsa catalogue at a glance: categories, the servers in each, tool counts, and the dedicated endpoint to connect if you only need one category. Free. (AIsa-only: tool-router has no equivalent.) Use mcp.aisa.one/mcp?modules=<category> (or mcp.aisa.one/<category>/mcp) to have that category's tools listed directly instead of via search.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish that this is a safe, read-only, closed-world operation. The description adds useful context beyond annotations by saying it returns categories, servers, tool counts, and the dedicated endpoint, and that it is free. It omits auth/rate-limit details, but those are less critical given the read-only annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with what the tool returns and is generally efficient. The parenthetical about tool-router and the endpoint URL add some density, but each part contributes usage or content context.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With zero parameters, read-only annotations, and an output schema available, the description supplies enough context for correct invocation. It explains the catalogue contents and gives the category-specific endpoint alternative, leaving no critical gap for an agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so parameter semantics are not a meaningful differentiator. The schema has no properties to explain, and the description does not need to document any inputs.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that this tool gives a catalogue overview: categories, servers per category, tool counts, and a dedicated endpoint. The resource is specific and recognizable, though sibling differentiation is only partial because it references 'tool-router' rather than the listed siblings like search/use.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives a clear alternative: use the category-specific endpoint if you only need one category, rather than going via search. It also notes the tool is free and AIsa-only, but it does not explicitly state when to call list_categories instead of search or use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_ai_summarySERP API AI SummaryADestructiveInspect
The purpose of the Live SERP API AI Summary endpoint is to provide a summary of the content found on any SERP and generate a response based on the user’s specified prompt. To obtain results, you have to specify task_id, which you can find in the response to the POST request. Learn more in our Help Center.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint, non-idempotency and destructiveHint, so the safety bar is lower. The description adds genuinely useful context beyond them: usage-based billing with a ~$0.02 request estimate, the fact that results depend on a prior POST, and the 30-day task_id validity window. It does not explain why a summarization call is flagged destructive or what resources are consumed, which is a notable omission given that surprising annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two core sentences are front-loaded and free of filler, with pricing isolated in a clearly marked block. Minor noise remains: a leading zero-width character, raw HTML comment markers, and a 'Learn more in our Help Center' pointer with no actual link.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and cost plus the task_id prerequisite are covered. However, the body is an array of task objects, implying multiple tasks can be submitted in one call, and the description speaks only of a singular task_id; it also omits the optional toggles that materially change the summary, leaving the agent under-informed about how to call it fully.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is 0% (the only top-level property is the undescribed 'body' array), so the description should compensate, but it only restates the task_id requirement already documented in the nested schema and says nothing about prompt, fetch_content, include_links, or support_extra. It also asserts task_id is mandatory while the schema marks no required fields, leaving an unresolved ambiguity.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: it summarizes SERP content and generates a response driven by a user prompt, which is clearly distinguishable from raw SERP retrieval tools like post_dataforseo_serp_google_organic_live. It does not, however, differentiate itself from the closest siblings (post_dataforseo_content_summary_live, post_dataforseo_serp_google_ai_mode_live), so an agent must still guess which summarizer applies.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives one real prerequisite: a task_id must be taken from a prior POST response before this endpoint can return anything. It offers no when-to-use vs. when-not guidance and never names an alternative sibling summarizer or SERP endpoint, so routing between the many SERP tools is left to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_baidu_organic_submitSetting Baidu Organic SERP TasksDDestructiveInspect
Baidu SERP API provides top 10 search engine results. These results are specific to the selected location (see the List of Locations) and other settings.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, openWorldHint=true, readOnlyHint=false and non-idempotent, so the safety profile is covered. However, the description adds almost nothing beyond that: it omits the critical behavioral fact that this is an asynchronous submit whose results must be retrieved later, and it doesn't clarify why a search submit is flagged destructive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but the space is spent on generic API framing and pricing boilerplate rather than the tool's actual function. The purpose is not front-loaded, so the reader must infer the action from the title.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For an asynchronous, billed submit tool with a rich nested body schema and an output schema, the description should at minimum say that it queues a task and that results are retrieved separately. Instead it says nothing about lifecycle or retrieval, leaving a significant gap for the agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds no parameter meaning beyond what the schema provides, and the top-level 'body' parameter is reported at 0% schema description coverage. The nested item fields are richly documented in the schema, so an agent can recover most detail there, but the description does not compensate or explain the body array wrapper.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description describes what the Baidu SERP API returns ('top 10 search engine results') rather than what this tool does. The tool name and title imply submitting/creating a task, but the description never states that this tool submits a task for asynchronous processing, and it doesn't distinguish itself from the sibling live and fetch variants.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance whatsoever. The description does not explain when to choose submit vs the live/fetch siblings, nor any prerequisites such as needing location_code or an asynchronous polling step. The only hint, 'see the List of Locations,' points at a data source, not usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_bing_organic_liveLive Bing Organic SERP AdvancedBDestructiveInspect
Live SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs.
Usage-based billing; Default request estimate: $0.002 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the operational profile (readOnlyHint=false, destructiveHint=true, openWorldHint=true, idempotentHint=false), so the description's burden is lighter. It usefully adds cost context ('Usage-based billing; Default request estimate: $0.002 USD'), but it neither explains the per-SERP/per-depth billing model nor reconciles the read-style 'provides real-time data' framing with the destructive annotation. It also claims 'top 100 results' while the schema's default depth is 10, which is potentially misleading.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two front-loaded sentences state the purpose and the extra-element coverage, with the pricing note appended as a clearly delimited boilerplate block. No filler sentences, though the generic 'search engine' phrasing wastes the chance to say 'Bing'.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and the schema is richly annotated. Still, for a 15-field advanced SERP endpoint the description omits the Bing specificity, the live/billing implications, and how it relates to the other SERP siblings, leaving the agent to infer routing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds no parameter detail beyond restating keyword/search-engine/location. However, the nested body schema itself documents nearly every field in depth (depth, device, os, target, match_type, location_coordinate, billing caveats), so the schema carries the semantics and a baseline 3 is appropriate; the description contributes nothing here.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a concrete verb+resource: 'provides real-time data on top 100 search engine results for the specified keyword, search engine, and location,' and adds the featured-snippet scope. It never names Bing and doesn't distinguish itself from the many sibling organic SERP tools (Google organic live, YouTube organic live, AI mode), so sibling differentiation is left to the tool name alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to choose this endpoint over alternatives such as post_dataforseo_serp_google_organic_live or the youtube/ai-mode variants. No prerequisites, no exclusion conditions, and no guidance on the live-vs-task model are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_bing_organic_live_htmlLive Bing Organic SERP HTMLCDestructiveInspect
Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint, non-idempotent, and destructive, so the safety profile is largely carried by structured data. The description adds real value by disclosing usage-based billing (~$0.02/request). It does not explain the destructiveHint=true claim on what looks like a retrieval, nor does it clarify the live/real-time external-call nature.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core purpose is front-loaded in a single sentence with no wasted prose. The injected pricing comment block is boilerplate but short. Slightly too terse for the complexity involved.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values need not be explained, but for a live SERP tool with a nested body payload and multiple near-identical siblings, the description omits the HTML-format distinction, sibling routing, and any parameter guidance. It is not complete enough to invoke confidently without reading the schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema description coverage is 0% for the single top-level 'body' array property, and the description says nothing about the payload. Although the nested schema contains rich per-field docs, the description adds no parameter meaning of its own and does not compensate for the undocumented top-level wrapper.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a concrete verb and resource: 'provides a raw HTML page of search engine results.' An agent can tell it returns raw HTML rather than parsed JSON. However, it says 'for the specified ... search engine,' which is misleading for a Bing-only endpoint, and it does not distinguish itself from close siblings such as post_dataforseo_serp_bing_organic_live or _live_regular.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no prerequisites, and no mention of the alternatives. The critical HTML-vs-regular-vs-submit choice among sibling tools is left entirely for the agent to infer. The pricing block is the only non-purpose sentence and it is not usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_bing_organic_live_regularLive Bing Organic SERP RegularCDestructiveInspect
Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, and destructiveHint=true. The description adds useful billing context with a default request estimate, but it does not explain the destructive/read-only distinction, auth needs, or rate limits beyond what annotations provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short and front-loaded: the purpose sentence comes first, followed by a compact pricing note. The pricing block is boilerplate, but it adds cost context without excessive length.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a live SERP endpoint among many Bing/Yahoo/Baidu analogues, the description is too generic: it omits the search engine, result type, variant selection, and parameter prerequisites. An output schema exists, so return values need not be covered, but selection context remains incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The top-level body parameter has 0% schema description coverage, and the description mentions only keyword, search engine, and location at a high level. The nested schema contains extensive field docs, but the description does not compensate for the undocumented body wrapper or required fields.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a generic verb and resource — real-time search engine results for a keyword, search engine, and location — but never names Bing, organic, or the 'regular' variant. It therefore does not distinguish this tool from sibling live, live_html, or other engine endpoints.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit guidance on when to use this live regular endpoint versus alternatives such as post_dataforseo_serp_bing_organic_live, post_dataforseo_serp_bing_organic_live_html, or fetch/submit variants. Usage is implied only by the tool name and title.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_screenshotSERP API Page ScreenshotCDestructiveInspect
Using the Live Page Screenshot endpoint, you can capture a screenshot of any SERP page.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, and openWorldHint=true, so the safety profile is covered elsewhere. The description adds only a billing estimate, and notably omits the crucial behavioral fact that this operates on an existing task (task_id), which an agent must understand before calling.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose is front-loaded in one sentence and nothing is padded. The pricing block is boilerplate but short and potentially useful cost context, so the definition stays efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained. But for a task-based nested-body tool, the description omits the critical workflow dependency on a prior task_id and any limits on what pages can be screenshotted, leaving the agent without the context needed to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The top-level 'body' parameter carries no description (0% schema coverage), so the description should compensate and does not. However, the nested schema fields (task_id, page, browser preset/resolution) are richly documented in the schema itself, so overall parameter meaning is conveyed, just not by the description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('capture a screenshot of any SERP page') via the 'Live Page Screenshot endpoint', which is clear enough for an agent to know exactly what it produces. It does not differentiate itself from the many sibling SERP fetch/submit tools, so it stops short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this versus the numerous sibling SERP tools, nor any mention of prerequisites such as needing a task_id from a prior task-creation request. The agent gets a purpose statement but no routing or context rules.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_seznam_organic_submitSetting Seznam Organic SERP TasksCDestructiveInspect
Seznam SERP API provides top 10 search engine results from one of the most popular search engines in the Czech Republic. Seznam is focused on the local search market, and thus supports the Czech language only.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the operation is not read-only, is destructive and non-idempotent, so the safety profile is covered. The description adds useful billing context (usage-based, default estimate $0.02, non-fixed price), but omits the key behavioral trait of a submit endpoint: that it asynchronously queues a task whose results must be retrieved later via the fetch/get siblings.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short but front-loads an API blurb rather than the tool's action, and begins with stray zero-width characters before any content. The pricing block is boilerplate rather than tool-specific guidance, so the sentences do not earn their place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex, expensive, asynchronous write endpoint with a rich body schema, the description omits the task-queue workflow (submit now, retrieve results later) and any link to the companion fetch tools. With an output schema and annotations present, only the return format is excused, leaving the operational context incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds no parameter meaning at all; it never mentions keyword, language, location, depth, or device. Reported top-level schema coverage is 0%, and while the nested body schema is detailed, the description does not compensate for the gap it is responsible for closing.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description describes the Seznam SERP API generically ('provides top 10 search engine results') rather than stating the tool's own action. Since this is a submit/set-task endpoint, the description never says it creates or queues a task, and it fails to distinguish itself from the many sibling fetch/get tools. That mismatch between the resource-only framing and the actual verb makes the purpose only marginally clearer than the name.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of alternatives (the fetch/regular/html/get siblings), and no exclusions. An agent gets no signal about when to prefer this submit tool over the live/fetch siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_yahoo_organic_liveLive Yahoo Organic SERP AdvancedCDestructiveInspect
Live SERP provides real-time data on top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly=false, destructive=true, idempotent=false, and openWorld=true, so the safety profile is supplied structurally. The description adds genuine behavioral value via the pricing note (usage-based billing, ~$0.02 default estimate), which tells the agent the call has a cost. It does not explain the tension between a data-retrieval operation and the destructiveHint=true annotation, nor rate/crawl constraints beyond what the schema states.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two compact sentences plus a short pricing block; the purpose statement is front-loaded and nothing is padded. It is efficient, though the pricing HTML comment adds a small amount of structural noise.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool whose single body parameter contains many nested, semantically significant fields (keyword, location_code/name/coordinate, depth, device, stop_crawl_on_match), the description gives no orientation to the request shape. An output schema exists so return values needn't be explained, but the input-side guidance is inadequate given the parameter complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The only top-level parameter is a 'body' array with 0% schema description coverage at that level, so the description carries the compensation burden — and it provides none. It never explains that the body wraps keyword/location/language fields or that keyword is effectively required, leaving the agent to parse the deeply nested schema unaided.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a verb+resource ('provides real-time data on top search engine results') but never names Yahoo or 'organic,' so it reads generically across every SERP tool. It does not distinguish this tool from its obvious siblings post_dataforseo_serp_yahoo_organic_live_regular or post_dataforseo_serp_yahoo_organic_live_html. Purpose is understandable but not specific to this tool.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no prerequisites, and no mention of the sibling variants (live vs live_regular vs live_html) that an agent must choose between. The only contextual instruction is a pointer to 'List of Locations'/'List of Languages,' which is not usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_yahoo_organic_live_htmlLive Yahoo Organic SERP HTMLCDestructiveInspect
Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint/destructiveHint/idempotentHint, and the description adds a genuinely useful behavioral fact not in them: usage-based billing with a $0.02 default estimate, which matters because depth/max_crawl_pages drive per-SERP charges. It still omits what 'live' implies operationally (immediate vs. queued response), rate limits, and that the returned payload is a bulk HTML document; note also that the annotations' destructiveHint is not reflected anywhere in the description, though the description makes no explicit safety claim that would contradict them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One front-loaded sentence stating the output, followed by a short templated pricing block; nothing is padded or repeated. It is very short, but the brevity comes from under-specification rather than from tight editing of necessary content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a live, cost-incurring scrape against a deeply nested option schema with no top-level parameter documentation, the definition leaves the key selection question (HTML vs. regular live vs. task-based submit) unanswered. An output schema exists, so return-value explanation is not required, but the missing when-to-use and live/async context leaves the agent under-informed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is reported at 0% and the single 'body' parameter is undocumented, but the nested field descriptions are extensive. The description only echoes three concepts (keyword, search engine, location) and adds no syntax, defaults, required-ness rules, or the depth/max_crawl_pages billing interplay that the schema itself explains.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the artifact produced ('raw HTML page of search engine results') and the inputs it is derived from (keyword, search engine, location), so the agent knows this returns scraped SERP markup rather than structured results. However, it largely restates the title and never differentiates itself from the very similar siblings post_dataforseo_serp_yahoo_organic_live and _live_regular (HTML vs. structured) or the equivalent bing/naver HTML variants.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance at all: nothing says to pick this over the non-HTML live variant, over the task-based submit endpoints, or over the other search engines' HTML endpoints. The only conditional information is the template billing note, which is about cost, not selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_yahoo_organic_live_regularLive Yahoo Organic SERP RegularBDestructiveInspect
Live Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location.
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already flag this as non-read-only and destructive, and the description adds genuinely useful billing context ('usage-based billing; default request estimate: $0.02 USD', not a fixed price). However, it never explains why the operation is destructive, that it fires a live billed request per SERP, or how cost scales with depth/max_crawl_pages, leaving the annotation profile unexplained.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The prose is a single front-loaded sentence with no filler, followed by a clearly delimited pricing note. It is appropriately sized for a short blurb, though at this brevity it borders on under-specification rather than true economy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be described. But for a billed, destructive-flagged live SERP request with a large nested body, the description omits the task/request model, the required keyword-plus-location/language pairing, and any differentiation among the three Yahoo live siblings — leaving material gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The top-level body parameter carries no description (schema coverage reported as 0%), but the nested properties are documented in exhaustive detail inside the schema itself. The description adds only 'keyword, search engine, and location', which merely names three of the many documented inputs and contributes no syntax or format detail beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: retrieving real-time Yahoo SERP data for a given keyword, search engine, and location. That is clear enough to act on, but it makes no attempt to distinguish this tool from its close siblings post_dataforseo_serp_yahoo_organic_live and post_dataforseo_serp_yahoo_organic_live_html; the meaning of 'regular' is never explained.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance at all: nothing says when to prefer this 'regular' variant over the html or non-regular Yahoo live endpoints, nor what prerequisites (e.g., valid location/language pairing) exist. The description only restates what the tool returns.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_youtube_organic_liveLive YouTube Organic AdvancedBDestructiveInspect
Live SERP provides real-time data on the top 20 blocks of YouTube search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/live/advanced/'
Usage-based billing; Default request estimate: $0.002 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations (readOnlyHint=false, destructiveHint=true, idempotentHint=false) are counterintuitive for a data-retrieval endpoint, and the description does not reconcile that tension or mention auth or rate limits. It does add genuinely useful behavioral context the annotations lack: the request is billed per call at roughly $0.002 USD, and higher block_depth may incur extra charges.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core capability is stated in the first sentence, followed by a docs link and a clearly delimited pricing block. It is compact and front-loaded, with only mild boilerplate in the trailing URL and billing lines.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be described, and the description covers purpose, location/language dependence, and cost. However, for a paid, multi-field live SERP call it omits which fields are required and when to use it versus the other SERP/social siblings, leaving real gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description generically notes that results are specific to the selected location and language settings, mirroring location_code/language_code, but adds no syntax, defaults, or constraints beyond the schema. The nested field descriptions (os, device, block_depth, keyword encoding rules) already carry that load, so the description contributes little parameter meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource: it 'provides real-time data on the top 20 blocks of YouTube search engine results', scoped to live SERP with location/language targeting. That is enough to distinguish it from a generic search sibling like get_youtube_search, though it never names an alternative explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to choose this live endpoint over a batch/standard SERP tool, nor any stated prerequisites even though the nested schema marks keyword, and one of location/language, as required. The reader is only told what the results depend on, not when this tool is the right pick.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_youtube_video_comments_liveLive YouTube Comments AdvancedCDestructiveInspect
Live YouTube Comments provides real-time data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics.
Usage-based billing; Default request estimate: $0.004 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorld/destructive/non-idempotent, so the safety profile is covered; the description's real contribution is the billing disclosure ('usage-based, default estimate $0.004'). However it omits the notable behaviors: the request is submitted as a body array (batched tasks), and depth above 20 incurs additional charges — a cost-side effect only the schema mentions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded in one clear sentence, but the definition carries a stray leading invisible character and a templated pricing block with HTML comments. The pricing line does earn some place by disclosing cost, yet the packaging is boilerplate rather than tailored.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The schema declares zero required top-level parameters, yet video_id is required inside the body — the description never states this, so an agent could issue an empty, invalid, or uncharged-but-failing request. An output schema exists so return values need no explanation, but the invocation contract (task-array wrapper, mandatory video_id, paired language/location fields) is left undocumented.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is reported at 0% for the top-level `body` parameter, so the description is expected to compensate and does not. It never explains the array-of-task-objects wrapper, and it mentions only the video implicitly while ignoring language/location/depth/os/tag semantics; the inherited schema docs are the only guidance (and note depth is capped at 200, contradicting the 'top 20' claim).
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource: real-time comments on a specified YouTube video, plus what comes back (top 20 comments, author info, comment metrics). It does not distinguish itself from close siblings such as post_dataforseo_serp_youtube_video_info_live or _video_subtitles_live, so the agent must infer the boundary from the name alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use / when-not-to-use guidance and no named alternatives, despite three closely related YouTube siblings. The only usage signal ('the video you specify') is an implicit requirement, not a selection rule.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_youtube_video_info_liveLive YouTube Video Info AdvancedCDestructiveInspect
Live YouTube Video Info provides real-time data on the video you specify in the request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/live/advanced/?bash'
Usage-based billing; Default request estimate: $0.006 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description frames this as a data fetch ('provides real-time data', 'you will get data'), which is inherently read-only, yet the annotations declare readOnlyHint=false and destructiveHint=true — the agent receives conflicting safety signals with no reconciliation. On the positive side it does disclose usage-based pricing (~$0.006 default estimate) and what the payload contains, which is real added value.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded in the first sentence, followed by what data is returned, a docs link, and a clearly fenced pricing note. Slightly padded by the raw docs URL, but no sentence is wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need no explanation, and pricing is covered. What remains missing is any guidance on the contradictory annotations, on required parameter pairing, and on the fact that body accepts an array (potentially multiple tasks) while the description speaks of a single video.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds only 'the video you specify in the request,' implying video_id, and nothing about the language/location pairing or the array-shaped body. However, the nested item schema documents every field in detail (os, device, tag, video_id, language_code/name, location_code/name), so the schema carries the semantic load even though the top-level body param itself is undescribed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb+resource: it 'provides real-time data on the video you specify,' returning metrics from the video's watching page plus channel data. That is concrete enough to distinguish it from generic SERP calls, but it does not name or contrast with its closest siblings (youtube_video_comments_live, youtube_video_subtitles_live, youtube_organic_live).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It says nothing about when to pick this tool over the comment, subtitle, or organic-live siblings, nor about prerequisites such as needing a language or location pair. The only usage-like hint is 'the video you specify in the request,' which is implicitly covered by the schema.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_youtube_video_subtitles_liveLive YouTube Subtitles AdvancedBDestructiveInspect
Live YouTube Subtitles provides real-time data on subtitles in the video you specify in the request. You will get data from the watching page containing subtitled text, its language, and duration in the video. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/live/advanced/?bash'
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the operation openWorld, non-idempotent and destructive-looking, so the description is not the sole carrier of behavior. It adds useful substance by naming the source ('watching page') and the returned fields, plus a billing estimate. It does not mention rate limits, response latency, or whether the destructive annotation reflects real data mutation, leaving a mismatch with the 'you will get data' framing unaddressed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core description is two front-loaded sentences that lead with the capability and then the payload; nothing in the prose is padding. The appended docs link and pricing boilerplate add length but are injected metadata rather than authored verbosity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be described, and annotations cover the safety profile. However, for a live SERP endpoint the description omits the mutual-exclusivity rules the caller must respect and any note on cost/pagination behavior, so it is only minimally complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema description coverage is 0% and the description explains no parameter at all — not the required-ish video_id, nor the language_code/language_name and location_code/location_name either/or pairs, nor the subtitles_language vs subtitles_translate_language distinction. The vague phrase 'the video you specify' does not compensate for that gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ('provides real-time data on subtitles in the video you specify') and enumerates what is returned (subtitled text, language, duration in the video), so an agent can distinguish it from youtube_video_info_live or video_comments_live by resource. It never names those siblings, so differentiation relies on the tool name itself rather than the prose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no statement of prerequisites (e.g. that a language/location pair must be supplied), and no routing against the sibling YouTube live tools. The only pointer is a docs URL, which offloads the decision entirely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
searchSearch AIsa tools and agent-ready plansARead-onlyInspect
Discover AIsa tools and Plans for external data or actions. Skip tasks that only need supplied content or general knowledge. For multi-step tasks, search the full goal before decomposing it. Use English; put identifiers in known_fields. If has_full_schema=false, call batch_get_schema. Next call batch_quote, not batch_use. Do not search for standalone rewriting, translation, summarization, formatting, or calculations on supplied content. For one capability, use an atomic query. Select a matching capability, date window, and metric. A Plan may cover only part of the task; assess its purpose and follow next_steps_guidance.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of additional direct tool candidates. | |
| query | Yes | Natural-language capability or task to discover. | |
| category | No | Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.) | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. | |
| known_fields | No | Known values such as ticker, URL, provider, or identifier that improve retrieval. | |
| provider_filters | No | Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown. |
Output Schema
| Name | Required | Description |
|---|---|---|
| plan | No | |
| tools | Yes | |
| search_id | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| retrieval_mode | No | |
| next_steps_guidance | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds workflow behavior the annotations cannot: the has_full_schema flag gates a required batch_get_schema call, and the next step after search is batch_quote, not batch_use. It stops short of disclosing retrieval limits or catalog breadth that would push it to a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is a dense run of imperatives rather than flowing prose, but each sentence carries a distinct rule (scope, language, workflow branch, negative cases, result interpretation) and the most important scoping guidance is front-loaded. Slightly more compression would help.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, the description need not explain return values, and it correctly avoids doing so while still referencing the output fields that drive the workflow (has_full_schema, next_steps_guidance). A mutation-free, well-annotated search tool is adequately covered, though catalog scope ('AIsa-only', no external providers) could be stated more explicitly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the structured baseline is 3. The description adds genuine meaning beyond the schema by telling the agent to write the query in English and to place tickers, URLs, providers, or identifiers in known_fields, which is non-obvious routing guidance for a nested free-form object.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: 'Discover AIsa tools and Plans for external data or actions.' It also separates this discovery step from the sibling execution tools by naming batch_get_schema, batch_quote, and batch_use and stating when each follows, so an agent can place it in the workflow without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use ('tasks needing external data or actions'), when-not ('tasks that only need supplied content or general knowledge'; no standalone rewriting, translation, summarization, formatting, or calculations), and named alternatives (batch_get_schema when has_full_schema=false, batch_quote rather than batch_use). It also specifies query language and atomic-query style, leaving little to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
useRun an AIsa operationCDestructiveInspect
deprecated, use batch_use instead
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | No | Arguments matching input_schema / arguments_schema | |
| search_id | No | search_id from the search that found this operation | |
| operation_id | Yes | operation_id as returned by search | |
| max_price_usd | No | Refuse the call before any spend if its quoted price is above this many USD |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, and openWorldHint=true, so the agent knows this is a state-changing, open-world operation. The description adds only the deprecation status and says nothing about what gets mutated, spend behavior (despite a max_price_usd param), or authorization needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single clause with zero waste; the deprecation notice and the replacement are front-loaded. It is terse by design for a deprecated endpoint, though it is under-specified rather than optimally efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Has an output schema and annotations, which reduces the burden, but a 4-parameter operation tool with a deprecation notice gives no information about what it executes or whether it remains functional. For an agent deciding between this and batch_use, the description is thin.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all four parameters (operation_id, arguments, search_id, max_price_usd) are already documented in the schema. The description adds no parameter meaning on top, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does — no verb or resource. It only labels the tool as deprecated and points to a replacement, leaving the actual capability ('Run an AIsa operation' from the title) unexplained. An agent must infer the purpose from the title and schema alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly routes the agent to the alternative ('use batch_use instead'), which is exactly the guidance needed for a deprecated tool. It doesn't explain when, if ever, this tool should still be called (e.g., during a migration window), so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
17 tool updates
- Added
account - Removed
get_details - Changed
post_dataforseo_serp_ai_summary1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "fetch_content": true, - "include_links": true, - "prompt": "explain what DataForSEO is", - "task_id": "07031739-1535-0139-0000-9d1e639a5b7d" - } - ], - "properties": { - "fetch_content": { - "description": "<em>fetch content from pages in SERPs</em><br>optional field<br>if set to <code>true</code>, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_links": { - "description": "<em>include source links in the summary</em><br>optional field<br>if set to <code>true</code>, the <code>summary</code> field in the API response will contain links to sources of the generated summary;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "prompt": { - "description": "<em>AI prompt</em><br>optional field<br>additional task for AI summariser;<br>any form of text, question or information that communicates to AI what response you're looking for;<br>max number of symbols or characters you can specify: <code>2000</code>;<br><strong>note:</strong> your prompt has to be relevant to the keyword specified in the POST request to SERP API", - "type": [ - "string", - "null" - ] - }, - "support_extra": { - "description": "<em>support extra SERP features</em><br>optional field<br>if set to <code>true</code>, the AI model will consider the following extra SERP features, in addition to <code>organic</code> results: <code>answer_box</code>, <code>knowledge_graph</code>, <code>featured_snippet</code>;<br>default value: <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "task_id": { - "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time", - "type": "string" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "fetch_content": { + "description": "<em>fetch content from pages in SERPs</em><br>optional field<br>if set to <code>true</code>, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_links": { + "description": "<em>include source links in the summary</em><br>optional field<br>if set to <code>true</code>, the <code>summary</code> field in the API response will contain links to sources of the generated summary;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "prompt": { + "description": "<em>AI prompt</em><br>optional field<br>additional task for AI summariser;<br>any form of text, question or information that communicates to AI what response you're looking for;<br>max number of symbols or characters you can specify: <code>2000</code>;<br><strong>note:</strong> your prompt has to be relevant to the keyword specified in the POST request to SERP API", + "type": [ + "string", + "null" + ] + }, + "support_extra": { + "description": "<em>support extra SERP features</em><br>optional field<br>if set to <code>true</code>, the AI model will consider the following extra SERP features, in addition to <code>organic</code> results: <code>answer_box</code>, <code>knowledge_graph</code>, <code>featured_snippet</code>;<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "task_id": { + "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_baidu_organic_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "best iphone ever", - "location_code": 2156, - "priority": 2, - "tag": "some_string_123" - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values: <code>desktop</code>, <code>mobile</code>, <code>tablet</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "get_website_url": { - "description": "<em>include direct URL for each ranked result</em><br>optional field<br>if set to <code>true</code>, the returned results will contain direct URLs of the ranked websites<br>by default, the URLs in Baidu results are encoded by the search engine,<br>for example:<br><code>http://www.baidu.com/link?url=KQt6LSwU5OHnPtB8210R8flBP40grY6lTPxH_0UO7S2kgiZMTmw3ztV0hCo5c1kL</code>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, <strong>the charge per task will be multiplied by 10</strong> as our system runs a separate request for each ranked website to return its direct URL", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code> with the <code>zh_CN</code> language code. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">zh_CN</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code>. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">Chinese (Simplified)</code>", - "type": "string" - }, - "location_code": { - "description": "<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\">2156</code>", - "type": "integer" - }, - "location_coordinate": { - "description": "<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)if you use this field, the returned results will be based on the closest city found for your coordinates. Thus, <strong>we don't recommend</strong> using this field as the results might not be relevant to the specified coordinates<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>", - "type": "string" - }, - "location_name": { - "description": "<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\">New York,New York,United States</code>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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><br>if you specify <code>tablet</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>regular</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "oneOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values: <code>desktop</code>, <code>mobile</code>, <code>tablet</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "get_website_url": { + "description": "<em>include direct URL for each ranked result</em><br>optional field<br>if set to <code>true</code>, the returned results will contain direct URLs of the ranked websites<br>by default, the URLs in Baidu results are encoded by the search engine,<br>for example:<br><code>http://www.baidu.com/link?url=KQt6LSwU5OHnPtB8210R8flBP40grY6lTPxH_0UO7S2kgiZMTmw3ztV0hCo5c1kL</code>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, <strong>the charge per task will be multiplied by 10</strong> as our system runs a separate request for each ranked website to return its direct URL", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code> with the <code>zh_CN</code> language code. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">zh_CN</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code>. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">Chinese (Simplified)</code>", + "type": "string" + }, + "location_code": { + "description": "<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\">2156</code>", + "type": "integer" + }, + "location_coordinate": { + "description": "<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)if you use this field, the returned results will be based on the closest city found for your coordinates. Thus, <strong>we don't recommend</strong> using this field as the results might not be relevant to the specified coordinates<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>", + "type": "string" + }, + "location_name": { + "description": "<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\">New York,New York,United States</code>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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><br>if you specify <code>tablet</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>regular</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_bing_organic_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "flight ticket new york san francisco", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "browser_screen_height": { - "description": "<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_resolution_ratio": { - "description": "<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_width": { - "description": "<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", - "format": "int64", - "type": [ - "integer", - "null" - ] - }, - "calculate_rectangles": { - "description": "<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><p>by default, the parameter is set to <code>false</code><p><strong></p>\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", - "type": [ - "boolean", - "null" - ] - }, - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center article</a></p>", - "type": "string" - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", - "type": "string" - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", - "type": "string" - }, - "location_code": { - "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_coordinate": { - "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", - "type": "string" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "match_type": { - "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", - "type": "string" - }, - "match_value": { - "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<p><em>additional parameters of the search query</em><p>optional field<p><a href=\"https://dataforseo.com/help-center/bing-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "oneOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "browser_screen_height": { + "description": "<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_resolution_ratio": { + "description": "<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_width": { + "description": "<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "calculate_rectangles": { + "description": "<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><p>by default, the parameter is set to <code>false</code><p><strong>Note:</strong> provider usage may increase for using this parameter</p>\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", + "type": [ + "boolean", + "null" + ] + }, + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center article</a></p>", + "type": "string" + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "location_code": { + "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_coordinate": { + "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", + "type": "string" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "match_type": { + "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", + "type": "string" + }, + "match_value": { + "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<p><em>additional parameters of the search query</em><p>optional field<p><a href=\"https://dataforseo.com/help-center/bing-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_bing_organic_live_html1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", - "type": "string" - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", - "type": "string" - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", - "type": "string" - }, - "location_code": { - "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_coordinate": { - "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", - "type": "string" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "match_type": { - "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", - "type": "string" - }, - "match_value": { - "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "oneOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", + "type": "string" + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "location_code": { + "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_coordinate": { + "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", + "type": "string" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "match_type": { + "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", + "type": "string" + }, + "match_value": { + "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_bing_organic_live_regular1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", - "type": "string" - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", - "type": "string" - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", - "type": "string" - }, - "location_code": { - "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_coordinate": { - "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", - "type": "string" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "match_type": { - "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", - "type": "string" - }, - "match_value": { - "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "oneOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", + "type": "string" + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "location_code": { + "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_coordinate": { + "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", + "type": "string" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "match_type": { + "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", + "type": "string" + }, + "match_value": { + "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_naver_organic_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "device": "desktop", - "keyword": "albert einstein", - "postback_data": "regular", - "postback_url": "https://your-server.com/postbackscript.php", - "tag": "some_string_123" - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>15</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 15 results;</strong> <br>Setting depth above 15 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 15 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "se_domain": { - "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.naver.com</em>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "oneOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<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<br>in most cases, we wouldn’t recommend using this method;<br>example:<br><code class=\"long-string\">https://search.naver.com/search.naver?where=nexearch&sm=top_hty&fbm=1&ie=utf8&query=iphone</code>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>15</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 15 results;</strong> <br>Setting depth above 15 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 15 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.naver.com</em>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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<br>in most cases, we wouldn’t recommend using this method;<br>example:<br><code class=\"long-string\">https://search.naver.com/search.naver?where=nexearch&sm=top_hty&fbm=1&ie=utf8&query=iphone</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_screenshot1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "browser_screen_scale_factor": 0.5, - "task_id": "06211235-0696-0139-1000-36727fbd3c90" - } - ], - "properties": { - "browser_preset": { - "description": "<em>browser resolution preset</em><br>optional field<br>browser preset associated with a certain device type<br>can take the following values: <code>desktop</code>, <code>tablet</code>, <code>mobile</code> <br><strong>Note:</strong> by default, browser preset corresponds to the device type specified in the POST request", - "type": [ - "string", - "null" - ] - }, - "browser_screen_height": { - "description": "<em>height of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1080<br>default value for <code>mobile</code>: 844<br>default value for <code>table</code>: 1366", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_scale_factor": { - "description": "<em>browser scale factor</em><br>optional field<br>can be specified in the following range: <code>0.5-3</code><br>default value for <code>desktop</code>: 1<br>default value for <code>mobile</code>: 3<br>default value for <code>table</code>: 2", - "type": [ - "number", - "null" - ] - }, - "browser_screen_width": { - "description": "<em>width of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1920<br>default value for <code>mobile</code>: 390<br>default value for <code>table</code>: 1024", - "format": "int64", - "type": [ - "integer", - "null" - ] - }, - "page": { - "description": "<em>number of SERP pages</em><br>optional field<br>if <code>depth</code> in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot;<br>default value: <code>1</code>", - "type": [ - "integer", - "null" - ] - }, - "task_id": { - "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time", - "type": "string" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "browser_preset": { + "description": "<em>browser resolution preset</em><br>optional field<br>browser preset associated with a certain device type<br>can take the following values: <code>desktop</code>, <code>tablet</code>, <code>mobile</code> <br><strong>Note:</strong> by default, browser preset corresponds to the device type specified in the POST request", + "type": [ + "string", + "null" + ] + }, + "browser_screen_height": { + "description": "<em>height of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1080<br>default value for <code>mobile</code>: 844<br>default value for <code>table</code>: 1366", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_scale_factor": { + "description": "<em>browser scale factor</em><br>optional field<br>can be specified in the following range: <code>0.5-3</code><br>default value for <code>desktop</code>: 1<br>default value for <code>mobile</code>: 3<br>default value for <code>table</code>: 2", + "type": [ + "number", + "null" + ] + }, + "browser_screen_width": { + "description": "<em>width of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1920<br>default value for <code>mobile</code>: 390<br>default value for <code>table</code>: 1024", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "page": { + "description": "<em>number of SERP pages</em><br>optional field<br>if <code>depth</code> in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot;<br>default value: <code>1</code>", + "type": [ + "integer", + "null" + ] + }, + "task_id": { + "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_seznam_organic_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "cs", - "location_code": 2203 - } - ], - "properties": { - "calculate_rectangles": { - "description": "<em>calculate pixel rankings for SERP elements in advanced results</em><br>optional field<br>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<br><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><br>by default, the parameter is set to <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2", - "type": [ - "boolean", - "null" - ] - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code>;<br>maximum value: <code>500</code>;<br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", - "type": "string" - }, - "language_code": { - "description": "<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:<em><br></em><code class=\"long-string\">cs</code>n", - "type": "string" - }, - "language_name": { - "description": "<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\">Czech</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>if you use this field, you don't need to specify <code>location_name</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>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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>10</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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "se_domain": { - "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.seznam.cz</em>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<em>additional parameters of the search query</em><br>optional field", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "oneOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<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;<br>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;<br>in most cases, we wouldn’t recommend using this method.", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "calculate_rectangles": { + "description": "<em>calculate pixel rankings for SERP elements in advanced results</em><br>optional field<br>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<br><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><br>by default, the parameter is set to <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2", + "type": [ + "boolean", + "null" + ] + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code>;<br>maximum value: <code>500</code>;<br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "type": "string" + }, + "language_code": { + "description": "<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:<em><br></em><code class=\"long-string\">cs</code>n", + "type": "string" + }, + "language_name": { + "description": "<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\">Czech</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>if you use this field, you don't need to specify <code>location_name</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>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>10</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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.seznam.cz</em>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<em>additional parameters of the search query</em><br>optional field", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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;<br>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;<br>in most cases, we wouldn’t recommend using this method.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_yahoo_organic_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<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.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>", - "type": "string" - }, - "language_code": { - "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<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>", - "type": "string" - }, - "location_code": { - "description": "<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", - "type": "integer" - }, - "location_coordinate": { - "description": "<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", - "type": "string" - }, - "location_name": { - "description": "<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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<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.", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<em>additional parameters of the search query</em><br>optional field<br><a href=\"https://dataforseo.com/help-center/yahoo-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "oneOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>", + "type": "string" + }, + "language_code": { + "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<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>", + "type": "string" + }, + "location_code": { + "description": "<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", + "type": "integer" + }, + "location_coordinate": { + "description": "<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", + "type": "string" + }, + "location_name": { + "description": "<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<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.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<em>additional parameters of the search query</em><br>optional field<br><a href=\"https://dataforseo.com/help-center/yahoo-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_yahoo_organic_live_html1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</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.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>", - "type": "string" - }, - "language_code": { - "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<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>", - "type": "string" - }, - "location_code": { - "description": "<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", - "type": "integer" - }, - "location_coordinate": { - "description": "<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", - "type": "string" - }, - "location_name": { - "description": "<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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<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.", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "oneOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "url": { - "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>", + "type": "string" + }, + "language_code": { + "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<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>", + "type": "string" + }, + "location_code": { + "description": "<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", + "type": "integer" + }, + "location_coordinate": { + "description": "<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", + "type": "string" + }, + "location_name": { + "description": "<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<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.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "url": { + "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_yahoo_organic_live_regular1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<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.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>", - "type": "string" - }, - "language_code": { - "description": "<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", - "type": "string" - }, - "language_name": { - "description": "<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>", - "type": "string" - }, - "location_code": { - "description": "<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", - "type": "integer" - }, - "location_coordinate": { - "description": "<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", - "type": "string" - }, - "location_name": { - "description": "<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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<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.", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "oneOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>", + "type": "string" + }, + "language_code": { + "description": "<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", + "type": "string" + }, + "language_name": { + "description": "<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>", + "type": "string" + }, + "location_code": { + "description": "<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", + "type": "integer" + }, + "location_coordinate": { + "description": "<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", + "type": "string" + }, + "location_name": { + "description": "<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<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.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_youtube_organic_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "audi", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "block_depth": { - "description": "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 200\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "block_depth": { + "description": "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 200\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "type": "string" + }, + "language_code": { + "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_youtube_video_comments_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840, - "video_id": "vQXvyV0zIP4" - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>200</code><br><strong>Note:</strong> your account will be billed per each SERP containing up to 20 results;<br>thus, setting a depth above <code>20</code> may result in additional charges if the search engine returns more than 20 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>only value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<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/youtube/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<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/youtube/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_<br><strong>if you use this field, you don't need to specify <code>location_name</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/youtube/locations</code><br>example:<br><code class=\"long-string\">2840</code>n", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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/youtube/locations</code><br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "os": { - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "video_id": { - "description": "<em>ID of the video</em><br><strong>required field</strong><br>you can find video ID in the URL or 'youtube_video' item of <a href=\"/v3/serp/youtube/organic/live/advanced/\" rel=\"noopener noreferrer\" target=\"_blank\">YouTube Organic</a> result<br>example:<br><code>vQXvyV0zIP4</code>", - "type": "string" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>200</code><br><strong>Note:</strong> your account will be billed per each SERP containing up to 20 results;<br>thus, setting a depth above <code>20</code> may result in additional charges if the search engine returns more than 20 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>only value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<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/youtube/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<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/youtube/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_<br><strong>if you use this field, you don't need to specify <code>location_name</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/youtube/locations</code><br>example:<br><code class=\"long-string\">2840</code>n", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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/youtube/locations</code><br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "os": { + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "video_id": { + "description": "<em>ID of the video</em><br><strong>required field</strong><br>you can find video ID in the URL or 'youtube_video' item of <a href=\"/v3/serp/youtube/organic/live/advanced/\" rel=\"noopener noreferrer\" target=\"_blank\">YouTube Organic</a> result<br>example:<br><code>vQXvyV0zIP4</code>", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_youtube_video_info_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840, - "video_id": "vQXvyV0zIP4" - } - ], - "properties": { - "device": { - "description": "device type\noptional field\nonly value: desktop", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - }, - "video_id": { - "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4", - "type": "string" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "device": { + "description": "device type\noptional field\nonly value: desktop", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "video_id": { + "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_youtube_video_subtitles_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840, - "video_id": "Y8Wu4rSNJms" - } - ], - "properties": { - "device": { - "description": "device type\noptional field\nonly value: desktop", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", - "type": [ - "string", - "null" - ] - }, - "subtitles_language": { - "description": "language code of original text\nyou can get the language code from YouTube Video Info result", - "type": [ - "string", - "null" - ] - }, - "subtitles_translate_language": { - "description": "language code of translated text\npossible values:\n\"az\", \"ay\", \"ak\", \"sq\", \"am\", \"en\", \"ar\", \"hy\", \"as\", \"af\", \"eu\", \"be\", \"bn\", \"my\", \"bg\", \"bs\", \"bho\", \"cy\", \"hu\", \"vi\", \"haw\", \"ht\", \"gl\", \"lg\", \"el\", \"ka\", \"gn\", \"gu\", \"gd\", \"da\", \"fy\", \"zu\", \"iw\", \"ig\", \"yi\", \"id\", \"ga\", \"is\", \"es\", \"it\", \"yo\", \"kk\", \"kn\", \"ca\", \"qu\", \"rw\", \"ky\", \"zh-Hant\", \"zh-Hans\", \"ko\", \"co\", \"xh\", \"ku\", \"km\", \"lo\", \"la\", \"lv\", \"ln\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"dv\", \"mt\", \"mi\", \"mr\", \"mn\", \"und\", \"de\", \"ne\", \"nl\", \"no\", \"ny\", \"or\", \"om\", \"pa\", \"fa\", \"pl\", \"pt\", \"ps\", \"ro\", \"ru\", \"sm\", \"sa\", \"ceb\", \"nso\", \"sr\", \"si\", \"sd\", \"sk\", \"sl\", \"so\", \"sw\", \"su\", \"tg\", \"th\", \"ta\", \"tt\", \"te\", \"ti\", \"ts\", \"tr\", \"tk\", \"uz\", \"ug\", \"uk\", \"ur\", \"fil\", \"fi\", \"fr\", \"ha\", \"hi\", \"hmn\", \"hr\", \"cs\", \"sv\", \"sn\", \"ee\", \"eo\", \"et\", \"st\", \"jv\", \"ja\", \"kri\"", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - }, - "video_id": { - "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nY8Wu4rSNJms", - "type": "string" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "device": { + "description": "device type\noptional field\nonly value: desktop", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", + "type": [ + "string", + "null" + ] + }, + "subtitles_language": { + "description": "language code of original text\nyou can get the language code from YouTube Video Info result", + "type": [ + "string", + "null" + ] + }, + "subtitles_translate_language": { + "description": "language code of translated text\npossible values:\n\"az\", \"ay\", \"ak\", \"sq\", \"am\", \"en\", \"ar\", \"hy\", \"as\", \"af\", \"eu\", \"be\", \"bn\", \"my\", \"bg\", \"bs\", \"bho\", \"cy\", \"hu\", \"vi\", \"haw\", \"ht\", \"gl\", \"lg\", \"el\", \"ka\", \"gn\", \"gu\", \"gd\", \"da\", \"fy\", \"zu\", \"iw\", \"ig\", \"yi\", \"id\", \"ga\", \"is\", \"es\", \"it\", \"yo\", \"kk\", \"kn\", \"ca\", \"qu\", \"rw\", \"ky\", \"zh-Hant\", \"zh-Hans\", \"ko\", \"co\", \"xh\", \"ku\", \"km\", \"lo\", \"la\", \"lv\", \"ln\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"dv\", \"mt\", \"mi\", \"mr\", \"mn\", \"und\", \"de\", \"ne\", \"nl\", \"no\", \"ny\", \"or\", \"om\", \"pa\", \"fa\", \"pl\", \"pt\", \"ps\", \"ro\", \"ru\", \"sm\", \"sa\", \"ceb\", \"nso\", \"sr\", \"si\", \"sd\", \"sk\", \"sl\", \"so\", \"sw\", \"su\", \"tg\", \"th\", \"ta\", \"tt\", \"te\", \"ti\", \"ts\", \"tr\", \"tk\", \"uz\", \"ug\", \"uk\", \"ur\", \"fil\", \"fi\", \"fr\", \"ha\", \"hi\", \"hmn\", \"hr\", \"cs\", \"sv\", \"sn\", \"ee\", \"eo\", \"et\", \"st\", \"jv\", \"ja\", \"kri\"", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "video_id": { + "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nY8Wu4rSNJms", + "type": "string" + } + }, + "type": "object" + } +]
15 tool updates
- Changed
post_dataforseo_serp_ai_summary2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "fetch_content": true, - "include_links": true, - "prompt": "explain what DataForSEO is", - "task_id": "07031739-1535-0139-0000-9d1e639a5b7d" - } - ], - "properties": { - "fetch_content": { - "description": "<em>fetch content from pages in SERPs</em><br>optional field<br>if set to <code>true</code>, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_links": { - "description": "<em>include source links in the summary</em><br>optional field<br>if set to <code>true</code>, the <code>summary</code> field in the API response will contain links to sources of the generated summary;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "prompt": { - "description": "<em>AI prompt</em><br>optional field<br>additional task for AI summariser;<br>any form of text, question or information that communicates to AI what response you're looking for;<br>max number of symbols or characters you can specify: <code>2000</code>;<br><strong>note:</strong> your prompt has to be relevant to the keyword specified in the POST request to SERP API", - "type": [ - "string", - "null" - ] - }, - "support_extra": { - "description": "<em>support extra SERP features</em><br>optional field<br>if set to <code>true</code>, the AI model will consider the following extra SERP features, in addition to <code>organic</code> results: <code>answer_box</code>, <code>knowledge_graph</code>, <code>featured_snippet</code>;<br>default value: <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "task_id": { - "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "fetch_content": true, + "include_links": true, + "prompt": "explain what DataForSEO is", + "task_id": "07031739-1535-0139-0000-9d1e639a5b7d" + } + ], + "properties": { + "fetch_content": { + "description": "<em>fetch content from pages in SERPs</em><br>optional field<br>if set to <code>true</code>, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_links": { + "description": "<em>include source links in the summary</em><br>optional field<br>if set to <code>true</code>, the <code>summary</code> field in the API response will contain links to sources of the generated summary;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "prompt": { + "description": "<em>AI prompt</em><br>optional field<br>additional task for AI summariser;<br>any form of text, question or information that communicates to AI what response you're looking for;<br>max number of symbols or characters you can specify: <code>2000</code>;<br><strong>note:</strong> your prompt has to be relevant to the keyword specified in the POST request to SERP API", + "type": [ + "string", + "null" + ] + }, + "support_extra": { + "description": "<em>support extra SERP features</em><br>optional field<br>if set to <code>true</code>, the AI model will consider the following extra SERP features, in addition to <code>organic</code> results: <code>answer_box</code>, <code>knowledge_graph</code>, <code>featured_snippet</code>;<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "task_id": { + "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_baidu_organic_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "best iphone ever", - "location_code": 2156, - "priority": 2, - "tag": "some_string_123" - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values: <code>desktop</code>, <code>mobile</code>, <code>tablet</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "get_website_url": { - "description": "<em>include direct URL for each ranked result</em><br>optional field<br>if set to <code>true</code>, the returned results will contain direct URLs of the ranked websites<br>by default, the URLs in Baidu results are encoded by the search engine,<br>for example:<br><code>http://www.baidu.com/link?url=KQt6LSwU5OHnPtB8210R8flBP40grY6lTPxH_0UO7S2kgiZMTmw3ztV0hCo5c1kL</code>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, <strong>the charge per task will be multiplied by 10</strong> as our system runs a separate request for each ranked website to return its direct URL", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code> with the <code>zh_CN</code> language code. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">zh_CN</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code>. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">Chinese (Simplified)</code>", - "type": "string" - }, - "location_code": { - "description": "<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\">2156</code>", - "type": "integer" - }, - "location_coordinate": { - "description": "<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)if you use this field, the returned results will be based on the closest city found for your coordinates. Thus, <strong>we don't recommend</strong> using this field as the results might not be relevant to the specified coordinates<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>", - "type": "string" - }, - "location_name": { - "description": "<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\">New York,New York,United States</code>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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><br>if you specify <code>tablet</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>regular</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "anyOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "best iphone ever", + "location_code": 2156, + "priority": 2, + "tag": "some_string_123" + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values: <code>desktop</code>, <code>mobile</code>, <code>tablet</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "get_website_url": { + "description": "<em>include direct URL for each ranked result</em><br>optional field<br>if set to <code>true</code>, the returned results will contain direct URLs of the ranked websites<br>by default, the URLs in Baidu results are encoded by the search engine,<br>for example:<br><code>http://www.baidu.com/link?url=KQt6LSwU5OHnPtB8210R8flBP40grY6lTPxH_0UO7S2kgiZMTmw3ztV0hCo5c1kL</code>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, <strong>the charge per task will be multiplied by 10</strong> as our system runs a separate request for each ranked website to return its direct URL", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code> with the <code>zh_CN</code> language code. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">zh_CN</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code>. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">Chinese (Simplified)</code>", + "type": "string" + }, + "location_code": { + "description": "<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\">2156</code>", + "type": "integer" + }, + "location_coordinate": { + "description": "<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)if you use this field, the returned results will be based on the closest city found for your coordinates. Thus, <strong>we don't recommend</strong> using this field as the results might not be relevant to the specified coordinates<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>", + "type": "string" + }, + "location_name": { + "description": "<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\">New York,New York,United States</code>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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><br>if you specify <code>tablet</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>regular</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_bing_organic_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "flight ticket new york san francisco", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "browser_screen_height": { - "description": "<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_resolution_ratio": { - "description": "<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_width": { - "description": "<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", - "format": "int64", - "type": [ - "integer", - "null" - ] - }, - "calculate_rectangles": { - "description": "<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><p>by default, the parameter is set to <code>false</code><p><strong></p>\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", - "type": [ - "boolean", - "null" - ] - }, - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center article</a></p>", - "type": "string" - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", - "type": "string" - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", - "type": "string" - }, - "location_code": { - "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_coordinate": { - "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", - "type": "string" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "match_type": { - "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", - "type": "string" - }, - "match_value": { - "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<p><em>additional parameters of the search query</em><p>optional field<p><a href=\"https://dataforseo.com/help-center/bing-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "anyOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "flight ticket new york san francisco", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "browser_screen_height": { + "description": "<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_resolution_ratio": { + "description": "<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_width": { + "description": "<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "calculate_rectangles": { + "description": "<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><p>by default, the parameter is set to <code>false</code><p><strong></p>\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", + "type": [ + "boolean", + "null" + ] + }, + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center article</a></p>", + "type": "string" + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "location_code": { + "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_coordinate": { + "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", + "type": "string" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "match_type": { + "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", + "type": "string" + }, + "match_value": { + "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<p><em>additional parameters of the search query</em><p>optional field<p><a href=\"https://dataforseo.com/help-center/bing-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_bing_organic_live_html2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", - "type": "string" - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", - "type": "string" - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", - "type": "string" - }, - "location_code": { - "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_coordinate": { - "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", - "type": "string" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "match_type": { - "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", - "type": "string" - }, - "match_value": { - "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "anyOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", + "type": "string" + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "location_code": { + "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_coordinate": { + "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", + "type": "string" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "match_type": { + "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", + "type": "string" + }, + "match_value": { + "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_bing_organic_live_regular2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", - "type": "string" - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", - "type": "string" - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", - "type": "string" - }, - "location_code": { - "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_coordinate": { - "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", - "type": "string" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "match_type": { - "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", - "type": "string" - }, - "match_value": { - "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "anyOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", + "type": "string" + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "location_code": { + "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_coordinate": { + "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", + "type": "string" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "match_type": { + "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", + "type": "string" + }, + "match_value": { + "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_naver_organic_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "device": "desktop", - "keyword": "albert einstein", - "postback_data": "regular", - "postback_url": "https://your-server.com/postbackscript.php", - "tag": "some_string_123" - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>15</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 15 results;</strong> <br>Setting depth above 15 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 15 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "se_domain": { - "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.naver.com</em>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "anyOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<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<br>in most cases, we wouldn’t recommend using this method;<br>example:<br><code class=\"long-string\">https://search.naver.com/search.naver?where=nexearch&sm=top_hty&fbm=1&ie=utf8&query=iphone</code>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "device": "desktop", + "keyword": "albert einstein", + "postback_data": "regular", + "postback_url": "https://your-server.com/postbackscript.php", + "tag": "some_string_123" + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>15</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 15 results;</strong> <br>Setting depth above 15 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 15 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.naver.com</em>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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<br>in most cases, we wouldn’t recommend using this method;<br>example:<br><code class=\"long-string\">https://search.naver.com/search.naver?where=nexearch&sm=top_hty&fbm=1&ie=utf8&query=iphone</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_screenshot2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "browser_screen_scale_factor": 0.5, - "task_id": "06211235-0696-0139-1000-36727fbd3c90" - } - ], - "properties": { - "browser_preset": { - "description": "<em>browser resolution preset</em><br>optional field<br>browser preset associated with a certain device type<br>can take the following values: <code>desktop</code>, <code>tablet</code>, <code>mobile</code> <br><strong>Note:</strong> by default, browser preset corresponds to the device type specified in the POST request", - "type": [ - "string", - "null" - ] - }, - "browser_screen_height": { - "description": "<em>height of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1080<br>default value for <code>mobile</code>: 844<br>default value for <code>table</code>: 1366", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_scale_factor": { - "description": "<em>browser scale factor</em><br>optional field<br>can be specified in the following range: <code>0.5-3</code><br>default value for <code>desktop</code>: 1<br>default value for <code>mobile</code>: 3<br>default value for <code>table</code>: 2", - "type": [ - "number", - "null" - ] - }, - "browser_screen_width": { - "description": "<em>width of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1920<br>default value for <code>mobile</code>: 390<br>default value for <code>table</code>: 1024", - "format": "int64", - "type": [ - "integer", - "null" - ] - }, - "page": { - "description": "<em>number of SERP pages</em><br>optional field<br>if <code>depth</code> in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot;<br>default value: <code>1</code>", - "type": [ - "integer", - "null" - ] - }, - "task_id": { - "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "browser_screen_scale_factor": 0.5, + "task_id": "06211235-0696-0139-1000-36727fbd3c90" + } + ], + "properties": { + "browser_preset": { + "description": "<em>browser resolution preset</em><br>optional field<br>browser preset associated with a certain device type<br>can take the following values: <code>desktop</code>, <code>tablet</code>, <code>mobile</code> <br><strong>Note:</strong> by default, browser preset corresponds to the device type specified in the POST request", + "type": [ + "string", + "null" + ] + }, + "browser_screen_height": { + "description": "<em>height of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1080<br>default value for <code>mobile</code>: 844<br>default value for <code>table</code>: 1366", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_scale_factor": { + "description": "<em>browser scale factor</em><br>optional field<br>can be specified in the following range: <code>0.5-3</code><br>default value for <code>desktop</code>: 1<br>default value for <code>mobile</code>: 3<br>default value for <code>table</code>: 2", + "type": [ + "number", + "null" + ] + }, + "browser_screen_width": { + "description": "<em>width of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1920<br>default value for <code>mobile</code>: 390<br>default value for <code>table</code>: 1024", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "page": { + "description": "<em>number of SERP pages</em><br>optional field<br>if <code>depth</code> in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot;<br>default value: <code>1</code>", + "type": [ + "integer", + "null" + ] + }, + "task_id": { + "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_seznam_organic_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "cs", - "location_code": 2203 - } - ], - "properties": { - "calculate_rectangles": { - "description": "<em>calculate pixel rankings for SERP elements in advanced results</em><br>optional field<br>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<br><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><br>by default, the parameter is set to <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2", - "type": [ - "boolean", - "null" - ] - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code>;<br>maximum value: <code>500</code>;<br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", - "type": "string" - }, - "language_code": { - "description": "<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:<em><br></em><code class=\"long-string\">cs</code>n", - "type": "string" - }, - "language_name": { - "description": "<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\">Czech</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>if you use this field, you don't need to specify <code>location_name</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>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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>10</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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "se_domain": { - "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.seznam.cz</em>", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<em>additional parameters of the search query</em><br>optional field", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "anyOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<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;<br>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;<br>in most cases, we wouldn’t recommend using this method.", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "cs", + "location_code": 2203 + } + ], + "properties": { + "calculate_rectangles": { + "description": "<em>calculate pixel rankings for SERP elements in advanced results</em><br>optional field<br>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<br><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><br>by default, the parameter is set to <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2", + "type": [ + "boolean", + "null" + ] + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code>;<br>maximum value: <code>500</code>;<br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "type": "string" + }, + "language_code": { + "description": "<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:<em><br></em><code class=\"long-string\">cs</code>n", + "type": "string" + }, + "language_name": { + "description": "<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\">Czech</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>if you use this field, you don't need to specify <code>location_name</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>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>10</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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.seznam.cz</em>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<em>additional parameters of the search query</em><br>optional field", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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;<br>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;<br>in most cases, we wouldn’t recommend using this method.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_yahoo_organic_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<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.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>", - "type": "string" - }, - "language_code": { - "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<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>", - "type": "string" - }, - "location_code": { - "description": "<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", - "type": "integer" - }, - "location_coordinate": { - "description": "<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", - "type": "string" - }, - "location_name": { - "description": "<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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<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.", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<em>additional parameters of the search query</em><br>optional field<br><a href=\"https://dataforseo.com/help-center/yahoo-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "anyOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>", + "type": "string" + }, + "language_code": { + "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<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>", + "type": "string" + }, + "location_code": { + "description": "<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", + "type": "integer" + }, + "location_coordinate": { + "description": "<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", + "type": "string" + }, + "location_name": { + "description": "<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<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.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<em>additional parameters of the search query</em><br>optional field<br><a href=\"https://dataforseo.com/help-center/yahoo-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_yahoo_organic_live_html2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</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.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>", - "type": "string" - }, - "language_code": { - "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<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>", - "type": "string" - }, - "location_code": { - "description": "<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", - "type": "integer" - }, - "location_coordinate": { - "description": "<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", - "type": "string" - }, - "location_name": { - "description": "<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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<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.", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "anyOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "url": { - "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>", + "type": "string" + }, + "language_code": { + "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<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>", + "type": "string" + }, + "location_code": { + "description": "<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", + "type": "integer" + }, + "location_coordinate": { + "description": "<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", + "type": "string" + }, + "location_name": { + "description": "<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<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.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "url": { + "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_yahoo_organic_live_regular2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<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.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<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>", - "type": "string" - }, - "language_code": { - "description": "<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", - "type": "string" - }, - "language_name": { - "description": "<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>", - "type": "string" - }, - "location_code": { - "description": "<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", - "type": "integer" - }, - "location_coordinate": { - "description": "<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", - "type": "string" - }, - "location_name": { - "description": "<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>", - "type": "string" - }, - "max_crawl_pages": { - "description": "<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>", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<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.", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "<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>", - "type": [ - "string", - "null" - ] - }, - "stop_crawl_on_match": { - "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", - "items": { - "anyOf": [ - { - "properties": { - "match_type": { - "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } - ], - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>", + "type": "string" + }, + "language_code": { + "description": "<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", + "type": "string" + }, + "language_name": { + "description": "<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>", + "type": "string" + }, + "location_code": { + "description": "<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", + "type": "integer" + }, + "location_coordinate": { + "description": "<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", + "type": "string" + }, + "location_name": { + "description": "<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<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.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "oneOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_youtube_organic_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "audi", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "block_depth": { - "description": "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 200\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "audi", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "block_depth": { + "description": "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 200\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "type": "string" + }, + "language_code": { + "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_youtube_video_comments_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840, - "video_id": "vQXvyV0zIP4" - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>200</code><br><strong>Note:</strong> your account will be billed per each SERP containing up to 20 results;<br>thus, setting a depth above <code>20</code> may result in additional charges if the search engine returns more than 20 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<em>device type</em><br>optional field<br>only value: <code>desktop</code>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<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/youtube/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<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/youtube/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_<br><strong>if you use this field, you don't need to specify <code>location_name</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/youtube/locations</code><br>example:<br><code class=\"long-string\">2840</code>n", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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/youtube/locations</code><br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "os": { - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "<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", - "type": [ - "string", - "null" - ] - }, - "video_id": { - "description": "<em>ID of the video</em><br><strong>required field</strong><br>you can find video ID in the URL or 'youtube_video' item of <a href=\"/v3/serp/youtube/organic/live/advanced/\" rel=\"noopener noreferrer\" target=\"_blank\">YouTube Organic</a> result<br>example:<br><code>vQXvyV0zIP4</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840, + "video_id": "vQXvyV0zIP4" + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>200</code><br><strong>Note:</strong> your account will be billed per each SERP containing up to 20 results;<br>thus, setting a depth above <code>20</code> may result in additional charges if the search engine returns more than 20 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>only value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<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/youtube/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<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/youtube/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_<br><strong>if you use this field, you don't need to specify <code>location_name</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/youtube/locations</code><br>example:<br><code class=\"long-string\">2840</code>n", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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/youtube/locations</code><br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "os": { + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "video_id": { + "description": "<em>ID of the video</em><br><strong>required field</strong><br>you can find video ID in the URL or 'youtube_video' item of <a href=\"/v3/serp/youtube/organic/live/advanced/\" rel=\"noopener noreferrer\" target=\"_blank\">YouTube Organic</a> result<br>example:<br><code>vQXvyV0zIP4</code>", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_youtube_video_info_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840, - "video_id": "vQXvyV0zIP4" - } - ], - "properties": { - "device": { - "description": "device type\noptional field\nonly value: desktop", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - }, - "video_id": { - "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840, + "video_id": "vQXvyV0zIP4" + } + ], + "properties": { + "device": { + "description": "device type\noptional field\nonly value: desktop", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "video_id": { + "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_youtube_video_subtitles_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840, - "video_id": "Y8Wu4rSNJms" - } - ], - "properties": { - "device": { - "description": "device type\noptional field\nonly value: desktop", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", - "type": [ - "string", - "null" - ] - }, - "subtitles_language": { - "description": "language code of original text\nyou can get the language code from YouTube Video Info result", - "type": [ - "string", - "null" - ] - }, - "subtitles_translate_language": { - "description": "language code of translated text\npossible values:\n\"az\", \"ay\", \"ak\", \"sq\", \"am\", \"en\", \"ar\", \"hy\", \"as\", \"af\", \"eu\", \"be\", \"bn\", \"my\", \"bg\", \"bs\", \"bho\", \"cy\", \"hu\", \"vi\", \"haw\", \"ht\", \"gl\", \"lg\", \"el\", \"ka\", \"gn\", \"gu\", \"gd\", \"da\", \"fy\", \"zu\", \"iw\", \"ig\", \"yi\", \"id\", \"ga\", \"is\", \"es\", \"it\", \"yo\", \"kk\", \"kn\", \"ca\", \"qu\", \"rw\", \"ky\", \"zh-Hant\", \"zh-Hans\", \"ko\", \"co\", \"xh\", \"ku\", \"km\", \"lo\", \"la\", \"lv\", \"ln\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"dv\", \"mt\", \"mi\", \"mr\", \"mn\", \"und\", \"de\", \"ne\", \"nl\", \"no\", \"ny\", \"or\", \"om\", \"pa\", \"fa\", \"pl\", \"pt\", \"ps\", \"ro\", \"ru\", \"sm\", \"sa\", \"ceb\", \"nso\", \"sr\", \"si\", \"sd\", \"sk\", \"sl\", \"so\", \"sw\", \"su\", \"tg\", \"th\", \"ta\", \"tt\", \"te\", \"ti\", \"ts\", \"tr\", \"tk\", \"uz\", \"ug\", \"uk\", \"ur\", \"fil\", \"fi\", \"fr\", \"ha\", \"hi\", \"hmn\", \"hr\", \"cs\", \"sv\", \"sn\", \"ee\", \"eo\", \"et\", \"st\", \"jv\", \"ja\", \"kri\"", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - }, - "video_id": { - "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nY8Wu4rSNJms", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840, + "video_id": "Y8Wu4rSNJms" + } + ], + "properties": { + "device": { + "description": "device type\noptional field\nonly value: desktop", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", + "type": [ + "string", + "null" + ] + }, + "subtitles_language": { + "description": "language code of original text\nyou can get the language code from YouTube Video Info result", + "type": [ + "string", + "null" + ] + }, + "subtitles_translate_language": { + "description": "language code of translated text\npossible values:\n\"az\", \"ay\", \"ak\", \"sq\", \"am\", \"en\", \"ar\", \"hy\", \"as\", \"af\", \"eu\", \"be\", \"bn\", \"my\", \"bg\", \"bs\", \"bho\", \"cy\", \"hu\", \"vi\", \"haw\", \"ht\", \"gl\", \"lg\", \"el\", \"ka\", \"gn\", \"gu\", \"gd\", \"da\", \"fy\", \"zu\", \"iw\", \"ig\", \"yi\", \"id\", \"ga\", \"is\", \"es\", \"it\", \"yo\", \"kk\", \"kn\", \"ca\", \"qu\", \"rw\", \"ky\", \"zh-Hant\", \"zh-Hans\", \"ko\", \"co\", \"xh\", \"ku\", \"km\", \"lo\", \"la\", \"lv\", \"ln\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"dv\", \"mt\", \"mi\", \"mr\", \"mn\", \"und\", \"de\", \"ne\", \"nl\", \"no\", \"ny\", \"or\", \"om\", \"pa\", \"fa\", \"pl\", \"pt\", \"ps\", \"ro\", \"ru\", \"sm\", \"sa\", \"ceb\", \"nso\", \"sr\", \"si\", \"sd\", \"sk\", \"sl\", \"so\", \"sw\", \"su\", \"tg\", \"th\", \"ta\", \"tt\", \"te\", \"ti\", \"ts\", \"tr\", \"tk\", \"uz\", \"ug\", \"uk\", \"ur\", \"fil\", \"fi\", \"fr\", \"ha\", \"hi\", \"hmn\", \"hr\", \"cs\", \"sv\", \"sn\", \"ee\", \"eo\", \"et\", \"st\", \"jv\", \"ja\", \"kri\"", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "video_id": { + "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nY8Wu4rSNJms", + "type": "string" + } + }, + "type": "object" + } +]
40 tool updates
- Added
batch_get_schema - Added
batch_quote - Changed
batch_use18 fields changed- added
Input schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - removed
Input schema / properties / calls / descriptionRemoved value: -"Up to 20 items of {call_id, operation_id, arguments}; steps at the same execution_level of a plan go in one batch" - added
Input schema / properties / calls / items / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - changed
Input schema / properties / calls / items / additionalPropertiesPrevious value: -trueNew value: +false - added
Input schema / properties / calls / items / propertiesAdded value: +{ + "arguments": { + "additionalProperties": true, + "description": "Strictly schema-compliant arguments using the exact field names and types from this tool's arguments_schema.", + "type": "object" + }, + "call_id": { + "description": "Caller-chosen identifier unique within this batch.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "tool": { + "description": "Exact tool name returned by search or batch_get_schema. Never invent a name.", + "minLength": 1, + "type": "string" + } +} - added
Input schema / properties / calls / items / requiredAdded value: +[ + "call_id", + "tool", + "arguments" +] - added
Input schema / properties / calls / maxItemsAdded value: +20 - added
Input schema / properties / calls / minItemsAdded value: +1 - removed
Input schema / properties / max_price_usdRemoved value: -{ - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "default": null, - "description": "Per-call price cap applied to every item" -} - removed
Input schema / properties / search_id / anyOfRemoved value: -[ - { - "type": "string" - }, - { - "type": "null" - } -] - removed
Input schema / properties / search_id / defaultRemoved value: -null - changed
Input schema / properties / search_id / descriptionPrevious value: -"search_id from the search that found these operations"New value: +"Optional search correlation identifier returned by search." - added
Input schema / properties / search_id / typeAdded value: +"string" - added
Input schema / properties / session_idAdded value: +{ + "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.", + "maxLength": 128, + "pattern": "^[A-Za-z0-9_-]*$", + "type": "string" +} - added
Output schema / $defsAdded value: +{ + "jsonValue": { + "anyOf": [ + { + "additionalProperties": { + "$ref": "#/$defs/jsonValue" + }, + "type": "object" + }, + { + "items": { + "$ref": "#/$defs/jsonValue" + }, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "JSON value returned by the upstream tool." + } +} - added
Output schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - added
Output schema / propertiesAdded value: +{ + "batch_id": { + "type": "string" + }, + "error_count": { + "minimum": 0, + "type": "integer" + }, + "next_steps_guidance": { + "description": "Deterministic next-step instructions derived from this result. Not an authorization grant.", + "items": { + "type": "string" + }, + "type": "array" + }, + "results": { + "items": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "additionalProperties": false, + "properties": { + "call_id": { + "type": "string" + }, + "customer_cost_micros_usd": { + "description": "Actual customer charge settled by AIsaServices, in micro-USD. Omitted when the upstream response does not report it.", + "minimum": 0, + "type": "integer" + }, + "data": { + "$ref": "#/$defs/jsonValue" + }, + "error": { + "anyOf": [ + { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "retryable": { + "type": "boolean" + }, + "status": { + "type": "integer" + }, + "type": { + "enum": [ + "validation", + "authentication", + "payment", + "permission", + "rate_limit", + "upstream", + "timeout", + "internal" + ], + "type": "string" + } + }, + "required": [ + "type", + "status", + "retryable" + ], + "type": "object" + }, + { + "type": "null" + } + ] + }, + "request_id": { + "type": "string" + }, + "successful": { + "type": "boolean" + }, + "tool": { + "type": "string" + }, + "upstream_status": { + "description": "HTTP status returned by AIsaServices when a request was dispatched.", + "type": "integer" + } + }, + "required": [ + "call_id", + "tool", + "successful", + "request_id" + ], + "type": "object" + }, + "type": "array" + }, + "session_id": { + "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[A-Za-z0-9_-]*$", + "type": "string" + }, + "success_count": { + "minimum": 0, + "type": "integer" + }, + "total_count": { + "minimum": 1, + "type": "integer" + } +} - added
Output schema / requiredAdded value: +[ + "session_id", + "batch_id", + "total_count", + "success_count", + "error_count", + "results", + "next_steps_guidance" +]
- Changed
get_dataforseo_serp_baidu_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_baidu_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_baidu_organic_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_baidu_organic_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_baidu_organic_fetch_regular3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_bing_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_bing_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_naver_organic_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_naver_organic_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_naver_organic_fetch_regular3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_seznam_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_seznam_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_seznam_organic_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_seznam_organic_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_seznam_organic_fetch_regular3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_yahoo_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_yahoo_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_youtube_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_youtube_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_details13 fields changed- added
Input schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - removed
Input schema / properties / argumentsRemoved value: -{ - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "default": null, - "description": "The arguments the operation would be called with, for a price that reflects them. Keyed by operation_id for a batch, or passed flat for a single operation_id. Routes whose required parameters are validated before pricing have no price without them." -} - added
Input schema / properties / include_arguments_schemaAdded value: +{ + "default": true, + "description": "Return the complete arguments_schema. Defaults to true.", + "type": "boolean" +} - changed
Input schema / properties / include_documentation / descriptionPrevious value: -"Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged."New value: +"Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support." - added
Input schema / properties / include_response_schemaAdded value: +{ + "default": false, + "description": "Return the complete response_schema. Defaults to false.", + "type": "boolean" +} - removed
Input schema / properties / operation_idRemoved value: -{ - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "description": "One operation_id from search" -} - removed
Input schema / properties / operation_idsRemoved value: -{ - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "default": null, - "description": "Up to 20 operation_ids, for a batch" -} - added
Input schema / properties / session_idAdded value: +{ + "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.", + "maxLength": 128, + "pattern": "^[A-Za-z0-9_-]*$", + "type": "string" +} - added
Input schema / properties / toolsAdded value: +{ + "description": "Exact tool names returned by search whose complete contracts are needed. Never invent tool names.", + "items": { + "minLength": 1, + "pattern": "^\\S(?:.*\\S)?$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true +} - removed
Input schema / properties / with_quoteRemoved value: -{ - "default": true, - "description": "Whether each operation is priced for this account before the answer. One round trip per operation; spends nothing.", - "type": "boolean" -} - added
Input schema / requiredAdded value: +[ + "tools" +] - added
Output schema / propertiesAdded value: +{ + "error_count": { + "type": "integer" + }, + "next_steps_guidance": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "type": "string" + } + }, + "session_id": { + "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[A-Za-z0-9_-]{1,128}$", + "type": "string" + }, + "success_count": { + "type": "integer" + }, + "tools": { + "additionalProperties": { + "additionalProperties": false, + "properties": { + "arguments_schema": { + "additionalProperties": true, + "anyOf": [ + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "canonical_operation_id": { + "type": "string" + }, + "documentation": { + "additionalProperties": true, + "type": "object" + }, + "error": { + "additionalProperties": false, + "anyOf": [ + { + "type": "null" + }, + { + "type": "object" + } + ], + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "execution_supported": { + "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.", + "type": "boolean" + }, + "execution_unsupported_reason": { + "description": "Why execution and quoting remain unavailable through this router.", + "type": "string" + }, + "idempotent": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "boolean" + } + ] + }, + "known_pitfalls": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "type": "string" + } + }, + "read_only": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "boolean" + } + ] + }, + "response_schema": { + "additionalProperties": true, + "anyOf": [ + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "side_effects": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "type": "string" + } + }, + "successful": { + "type": "boolean" + } + }, + "required": [ + "successful" + ], + "type": "object" + }, + "type": "object" + }, + "total_count": { + "type": "integer" + } +} - added
Output schema / requiredAdded value: +[ + "error_count", + "next_steps_guidance", + "session_id", + "success_count", + "tools", + "total_count" +]
- Changed
post_dataforseo_serp_ai_summary7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "fetch_content": true, + "include_links": true, + "prompt": "explain what DataForSEO is", + "task_id": "07031739-1535-0139-0000-9d1e639a5b7d" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "fetch_content": true, + "include_links": true, + "prompt": "explain what DataForSEO is", + "task_id": "07031739-1535-0139-0000-9d1e639a5b7d" + } + ], + "properties": { + "fetch_content": { + "description": "<em>fetch content from pages in SERPs</em><br>optional field<br>if set to <code>true</code>, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_links": { + "description": "<em>include source links in the summary</em><br>optional field<br>if set to <code>true</code>, the <code>summary</code> field in the API response will contain links to sources of the generated summary;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "prompt": { + "description": "<em>AI prompt</em><br>optional field<br>additional task for AI summariser;<br>any form of text, question or information that communicates to AI what response you're looking for;<br>max number of symbols or characters you can specify: <code>2000</code>;<br><strong>note:</strong> your prompt has to be relevant to the keyword specified in the POST request to SERP API", + "type": [ + "string", + "null" + ] + }, + "support_extra": { + "description": "<em>support extra SERP features</em><br>optional field<br>if set to <code>true</code>, the AI model will consider the following extra SERP features, in addition to <code>organic</code> results: <code>answer_box</code>, <code>knowledge_graph</code>, <code>featured_snippet</code>;<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "task_id": { + "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "fetch_content": { - "description": "fetch content from pages in SERPs optional field if set to true, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result; default value: false", - "type": "boolean" - }, - "include_links": { - "description": "include source links in the summary optional field if set to true, the summary field in the API response will contain links to sources of the generated summary; default value: false", - "type": "boolean" - }, - "prompt": { - "description": "AI prompt optional field additional task for AI summariser; any form of text, question or information that communicates to AI what response you're looking for; max number of symbols or characters you can specify: 2000; note: your prompt has to be relevant to the keyword specified in the POST request to SERP API", - "type": "string" - }, - "support_extra": { - "description": "support extra SERP features optional field if set to true, the AI model will consider the following extra SERP features, in addition to organic results: answer_box, knowledge_graph, featured_snippet; default value: true", - "type": "boolean" - }, - "task_id": { - "description": "task identifier required field unique identifier of the associated task in the UUID format you will be able to use it within 30 days to request the results of the task at any time", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "task_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_baidu_organic_submit7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "best iphone ever", + "location_code": 2156, + "priority": 2, + "tag": "some_string_123" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "best iphone ever", + "location_code": 2156, + "priority": 2, + "tag": "some_string_123" + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values: <code>desktop</code>, <code>mobile</code>, <code>tablet</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "get_website_url": { + "description": "<em>include direct URL for each ranked result</em><br>optional field<br>if set to <code>true</code>, the returned results will contain direct URLs of the ranked websites<br>by default, the URLs in Baidu results are encoded by the search engine,<br>for example:<br><code>http://www.baidu.com/link?url=KQt6LSwU5OHnPtB8210R8flBP40grY6lTPxH_0UO7S2kgiZMTmw3ztV0hCo5c1kL</code>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, <strong>the charge per task will be multiplied by 10</strong> as our system runs a separate request for each ranked website to return its direct URL", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code> with the <code>zh_CN</code> language code. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">zh_CN</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><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><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code>. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class=\"long-string\">Chinese (Simplified)</code>", + "type": "string" + }, + "location_code": { + "description": "<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\">2156</code>", + "type": "integer" + }, + "location_coordinate": { + "description": "<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)if you use this field, the returned results will be based on the closest city found for your coordinates. Thus, <strong>we don't recommend</strong> using this field as the results might not be relevant to the specified coordinates<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>", + "type": "string" + }, + "location_name": { + "description": "<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\">New York,New York,United States</code>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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><br>if you specify <code>tablet</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>regular</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/baidu-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "anyOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "parsing depth optional field number of results in SERP default value: 10 max value: 700 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.", - "type": "integer" - }, - "device": { - "description": "device type optional field return results for a specific device type can take the values: desktop, mobile, tablet default value: desktop", - "type": "string" - }, - "keyword": { - "description": "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", - "type": "string" - }, - "language_code": { - "description": "search engine language code required field if you don't specify language_name. Use the AIsa tool [get_dataforseo_serp_baidu_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-baidu-languages) to retrieve supported Baidu languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. note that the only language supported in Baidu search engine is Chinese (Simplified) with the zh_CN language code. However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatory example: zh_CN", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if you don't specify language_code. Use the AIsa tool [get_dataforseo_serp_baidu_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-baidu-languages) to retrieve supported Baidu languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. note that the only language supported in Baidu search engine is Chinese (Simplified). However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatory example: Chinese (Simplified)", - "type": "string" - }, - "location_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_baidu_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-baidu-locations) to retrieve supported Baidu locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2156", - "type": "integer" - }, - "location_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_baidu_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-baidu-locations) to retrieve supported Baidu locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: New York,New York,United States", - "type": "string" - }, - "os": { - "description": "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 if you specify tablet in the device field, choose from the following values: android, ios default value: android", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: regular, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_bing_organic_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "flight ticket new york san francisco", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "flight ticket new york san francisco", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "browser_screen_height": { + "description": "<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_resolution_ratio": { + "description": "<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_width": { + "description": "<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "calculate_rectangles": { + "description": "<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><p>by default, the parameter is set to <code>false</code><p><strong></p>\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", + "type": [ + "boolean", + "null" + ] + }, + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center article</a></p>", + "type": "string" + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "location_code": { + "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_coordinate": { + "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", + "type": "string" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "match_type": { + "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", + "type": "string" + }, + "match_value": { + "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<p><em>additional parameters of the search query</em><p>optional field<p><a href=\"https://dataforseo.com/help-center/bing-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "anyOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop", - "type": "string" - }, - "keyword": { - "description": "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", - "type": "string" - }, - "language_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: en", - "type": "string" - }, - "language_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English", - "type": "string" - }, - "location_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840", - "type": "integer" - }, - "location_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "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", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_bing_organic_live_html7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", + "type": "string" + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "location_code": { + "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_coordinate": { + "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", + "type": "string" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "match_type": { + "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", + "type": "string" + }, + "match_value": { + "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "anyOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop", - "type": "string" - }, - "keyword": { - "description": "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", - "type": "string" - }, - "language_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: en", - "type": "string" - }, - "language_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English", - "type": "string" - }, - "location_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840", - "type": "integer" - }, - "location_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "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", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_bing_organic_live_regular7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/bing-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character '+' will be decoded to a space character)</strong><p>if you need to use the \"%\" character for your <code>keyword</code>, please specify it as \"%25\";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><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></p>", + "type": "string" + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>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><p></em>example:<em><p></em><code class=\"long-string\">en</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>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><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "location_code": { + "description": "<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_coordinate": { + "description": "<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>example:<p><code class=\"long-string\">53.476225,-2.243572</code></p>", + "type": "string" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>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><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "match_type": { + "description": "<p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> – wildcard pattern</p>", + "type": "string" + }, + "match_value": { + "description": "<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>\"match_value\": \"dataforseo.com\"</code>,<p><code>\"match_value\": \"/blog/post-*\"</code></p>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>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></p>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<p><em>additional parameters of the search query</em><p>optional field<p><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></p>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "anyOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><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>;<p><strong><code class=\"long-string\">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class=\"long-string\">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><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>;<p><strong><code class=\"long-string\">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class=\"long-string\">example.com/example-page*</code></strong> - returns results for all domain's URLs that start with the specified string</p>", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class=\"long-string\">https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop", - "type": "string" - }, - "keyword": { - "description": "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", - "type": "string" - }, - "language_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: en", - "type": "string" - }, - "language_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English", - "type": "string" - }, - "location_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840", - "type": "integer" - }, - "location_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "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", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_naver_organic_submit7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "device": "desktop", + "keyword": "albert einstein", + "postback_data": "regular", + "postback_url": "https://your-server.com/postbackscript.php", + "tag": "some_string_123" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "device": "desktop", + "keyword": "albert einstein", + "postback_data": "regular", + "postback_url": "https://your-server.com/postbackscript.php", + "tag": "some_string_123" + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>15</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 15 results;</strong> <br>Setting depth above 15 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 15 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/naver-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.naver.com</em>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "anyOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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<br>in most cases, we wouldn’t recommend using this method;<br>example:<br><code class=\"long-string\">https://search.naver.com/search.naver?where=nexearch&sm=top_hty&fbm=1&ie=utf8&query=iphone</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "parsing depth optional field number of results in SERP default value: 15 max value: 700 Your account will be billed per each SERP containing up to 15 results; Setting depth above 15 may result in additional charges if the search engine returns more than 15 results.", - "type": "integer" - }, - "device": { - "description": "device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop", - "type": "string" - }, - "keyword": { - "description": "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", - "type": "string" - }, - "language_code": { - "description": "Search engine language code", - "type": "string" - }, - "language_name": { - "description": "Full name of search engine language", - "type": "string" - }, - "location_code": { - "description": "Search engine location code", - "type": "integer" - }, - "location_name": { - "description": "Full name of search engine location", - "type": "string" - }, - "os": { - "description": "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", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the function you used for setting a task possible values: regular, advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.", - "type": "integer" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_screenshot7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "browser_screen_scale_factor": 0.5, + "task_id": "06211235-0696-0139-1000-36727fbd3c90" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "browser_screen_scale_factor": 0.5, + "task_id": "06211235-0696-0139-1000-36727fbd3c90" + } + ], + "properties": { + "browser_preset": { + "description": "<em>browser resolution preset</em><br>optional field<br>browser preset associated with a certain device type<br>can take the following values: <code>desktop</code>, <code>tablet</code>, <code>mobile</code> <br><strong>Note:</strong> by default, browser preset corresponds to the device type specified in the POST request", + "type": [ + "string", + "null" + ] + }, + "browser_screen_height": { + "description": "<em>height of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1080<br>default value for <code>mobile</code>: 844<br>default value for <code>table</code>: 1366", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_scale_factor": { + "description": "<em>browser scale factor</em><br>optional field<br>can be specified in the following range: <code>0.5-3</code><br>default value for <code>desktop</code>: 1<br>default value for <code>mobile</code>: 3<br>default value for <code>table</code>: 2", + "type": [ + "number", + "null" + ] + }, + "browser_screen_width": { + "description": "<em>width of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1920<br>default value for <code>mobile</code>: 390<br>default value for <code>table</code>: 1024", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "page": { + "description": "<em>number of SERP pages</em><br>optional field<br>if <code>depth</code> in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot;<br>default value: <code>1</code>", + "type": [ + "integer", + "null" + ] + }, + "task_id": { + "description": "<em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format<br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "browser_preset": { - "description": "browser resolution preset optional field browser preset associated with a certain device type can take the following values: desktop, tablet, mobile Note: by default, browser preset corresponds to the device type specified in the POST request", - "type": "string" - }, - "browser_screen_height": { - "description": "height of the browser resolution optional field can be specified in the following range: 240-9999 default value for desktop: 1080 default value for mobile: 844 default value for table: 1366", - "type": "integer" - }, - "browser_screen_scale_factor": { - "description": "browser scale factor optional field can be specified in the following range: 0.5-3 default value for desktop: 1 default value for mobile: 3 default value for table: 2", - "type": "number" - }, - "browser_screen_width": { - "description": "width of the browser resolution optional field can be specified in the following range: 240-9999 default value for desktop: 1920 default value for mobile: 390 default value for table: 1024", - "type": "integer" - }, - "page": { - "description": "number of SERP pages optional field if depth in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot; default value: 1", - "type": "integer" - }, - "task_id": { - "description": "task identifier required field unique identifier of the associated task in the UUID format you will be able to use it within 7 days to request the results of the task at any time", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "task_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_seznam_organic_submit7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "albert einstein", + "language_code": "cs", + "location_code": 2203 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "cs", + "location_code": 2203 + } + ], + "properties": { + "calculate_rectangles": { + "description": "<em>calculate pixel rankings for SERP elements in advanced results</em><br>optional field<br>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<br><a href=\"https://dataforseo.com/help-center/pixel-ranking-in-serp-api\">Visit Help Center to learn more>></a><br>by default, the parameter is set to <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2", + "type": [ + "boolean", + "null" + ] + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code>;<br>maximum value: <code>500</code>;<br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "type": "string" + }, + "language_code": { + "description": "<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:<em><br></em><code class=\"long-string\">cs</code>n", + "type": "string" + }, + "language_name": { + "description": "<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\">Czech</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>if you use this field, you don't need to specify <code>location_name</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>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>10</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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/seznam-organic-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.seznam.cz</em>", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<em>additional parameters of the search query</em><br>optional field", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "anyOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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;<br>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;<br>in most cases, we wouldn’t recommend using this method.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "parsing depth optional field number of results in SERP default value: 10; maximum value: 500; Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.", - "type": "integer" - }, - "device": { - "description": "device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop", - "type": "string" - }, - "keyword": { - "description": "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", - "type": "string" - }, - "language_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_seznam_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-seznam-languages) to retrieve supported Seznam languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: csn", - "type": "string" - }, - "language_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_seznam_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-seznam-languages) to retrieve supported Seznam languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: Czech", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name. Use the AIsa tool [get_dataforseo_serp_seznam_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-seznam-locations) to retrieve supported Seznam locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code. Use the AIsa tool [get_dataforseo_serp_seznam_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-seznam-locations) to retrieve supported Seznam locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "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", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the function you used for setting a task possible values: regular, advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_yahoo_organic_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>", + "type": "string" + }, + "language_code": { + "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<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>", + "type": "string" + }, + "location_code": { + "description": "<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", + "type": "integer" + }, + "location_coordinate": { + "description": "<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", + "type": "string" + }, + "location_name": { + "description": "<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<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.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<em>additional parameters of the search query</em><br>optional field<br><a href=\"https://dataforseo.com/help-center/yahoo-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "anyOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop", - "type": "string" - }, - "keyword": { - "description": "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", - "type": "string" - }, - "language_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: enn", - "type": "string" - }, - "language_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English", - "type": "string" - }, - "location_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840n", - "type": "integer" - }, - "location_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "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", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_yahoo_organic_live_html7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>", + "type": "string" + }, + "language_code": { + "description": "<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:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<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>", + "type": "string" + }, + "location_code": { + "description": "<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", + "type": "integer" + }, + "location_coordinate": { + "description": "<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", + "type": "string" + }, + "location_name": { + "description": "<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<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.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "anyOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "url": { + "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop", - "type": "string" - }, - "keyword": { - "description": "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", - "type": "string" - }, - "language_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: enn", - "type": "string" - }, - "language_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English", - "type": "string" - }, - "location_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840n", - "type": "integer" - }, - "location_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "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", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_yahoo_organic_live_regular7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<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>", + "type": "string" + }, + "language_code": { + "description": "<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", + "type": "string" + }, + "language_name": { + "description": "<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>", + "type": "string" + }, + "location_code": { + "description": "<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", + "type": "integer" + }, + "location_coordinate": { + "description": "<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", + "type": "string" + }, + "location_name": { + "description": "<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>", + "type": "string" + }, + "max_crawl_pages": { + "description": "<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>", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<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.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "<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>", + "type": [ + "string", + "null" + ] + }, + "stop_crawl_on_match": { + "description": "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets", + "items": { + "anyOf": [ + { + "properties": { + "match_type": { + "description": "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } + ], + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "<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&n=100&vl=lang_en&vc=us&ei=UTF-8</code>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field can take the values:desktop, mobile default value: desktop", - "type": "string" - }, - "keyword": { - "description": "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", - "type": "string" - }, - "language_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: enn", - "type": "string" - }, - "language_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English", - "type": "string" - }, - "location_code": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840n", - "type": "integer" - }, - "location_name": { - "description": "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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "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", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_youtube_organic_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "audi", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "audi", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "block_depth": { + "description": "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 200\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "type": "string" + }, + "language_code": { + "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keyword": { - "description": "Keyword to search for", - "type": "string" - }, - "language_code": { - "description": "Search engine language code", - "type": "string" - }, - "language_name": { - "description": "Full name of search engine language", - "type": "string" - }, - "location_code": { - "description": "Search engine location code", - "type": "integer" - }, - "location_name": { - "description": "Full name of search engine location", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_youtube_video_comments_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_code": "en", + "location_code": 2840, + "video_id": "vQXvyV0zIP4" + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_code" - ] - }, - { - "required": [ - "location_name" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_code" - ] - }, - { - "required": [ - "language_name" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840, + "video_id": "vQXvyV0zIP4" + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>200</code><br><strong>Note:</strong> your account will be billed per each SERP containing up to 20 results;<br>thus, setting a depth above <code>20</code> may result in additional charges if the search engine returns more than 20 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<em>device type</em><br>optional field<br>only value: <code>desktop</code>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<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/youtube/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<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/youtube/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_<br><strong>if you use this field, you don't need to specify <code>location_name</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/youtube/locations</code><br>example:<br><code class=\"long-string\">2840</code>n", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</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/youtube/locations</code><br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "os": { + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<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", + "type": [ + "string", + "null" + ] + }, + "video_id": { + "description": "<em>ID of the video</em><br><strong>required field</strong><br>you can find video ID in the URL or 'youtube_video' item of <a href=\"/v3/serp/youtube/organic/live/advanced/\" rel=\"noopener noreferrer\" target=\"_blank\">YouTube Organic</a> result<br>example:<br><code>vQXvyV0zIP4</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "language_code": { - "description": "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/youtube/languages example: enn", - "type": "string" - }, - "language_name": { - "description": "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/youtube/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don't specify location_name_ if you use this field, you don't need to specify location_name 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/youtube/locations example: 2840n", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code 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/youtube/locations example: United States", - "type": "string" - }, - "video_id": { - "description": "ID of the video required field you can find video ID in the URL or 'youtube_video' item of YouTube Organic result example: vQXvyV0zIP4", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "video_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_youtube_video_info_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_code": "en", + "location_code": 2840, + "video_id": "vQXvyV0zIP4" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840, + "video_id": "vQXvyV0zIP4" + } + ], + "properties": { + "device": { + "description": "device type\noptional field\nonly value: desktop", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "video_id": { + "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field only value: desktop", - "type": "string" - }, - "language_code": { - "description": "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/youtube/languages example: en", - "type": "string" - }, - "language_name": { - "description": "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/youtube/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name 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/youtube/locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code 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/youtube/locations example: United States", - "type": "string" - }, - "video_id": { - "description": "ID of the video required field you can find video ID in the URL or 'youtube_video' item of YouTube Organic result example: vQXvyV0zIP4", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "video_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_youtube_video_subtitles_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_code": "en", + "location_code": 2840, + "video_id": "Y8Wu4rSNJms" + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_code" - ] - }, - { - "required": [ - "location_name" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_code" - ] - }, - { - "required": [ - "language_name" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840, + "video_id": "Y8Wu4rSNJms" + } + ], + "properties": { + "device": { + "description": "device type\noptional field\nonly value: desktop", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou 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/youtube/languages\nexample:\nen", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou 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/youtube/languages\nexample:\nEnglish", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou 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/youtube/locations\nexample:\n2840", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou 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/youtube/locations\nexample:\nUnited States", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows", + "type": [ + "string", + "null" + ] + }, + "subtitles_language": { + "description": "language code of original text\nyou can get the language code from YouTube Video Info result", + "type": [ + "string", + "null" + ] + }, + "subtitles_translate_language": { + "description": "language code of translated text\npossible values:\n\"az\", \"ay\", \"ak\", \"sq\", \"am\", \"en\", \"ar\", \"hy\", \"as\", \"af\", \"eu\", \"be\", \"bn\", \"my\", \"bg\", \"bs\", \"bho\", \"cy\", \"hu\", \"vi\", \"haw\", \"ht\", \"gl\", \"lg\", \"el\", \"ka\", \"gn\", \"gu\", \"gd\", \"da\", \"fy\", \"zu\", \"iw\", \"ig\", \"yi\", \"id\", \"ga\", \"is\", \"es\", \"it\", \"yo\", \"kk\", \"kn\", \"ca\", \"qu\", \"rw\", \"ky\", \"zh-Hant\", \"zh-Hans\", \"ko\", \"co\", \"xh\", \"ku\", \"km\", \"lo\", \"la\", \"lv\", \"ln\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"dv\", \"mt\", \"mi\", \"mr\", \"mn\", \"und\", \"de\", \"ne\", \"nl\", \"no\", \"ny\", \"or\", \"om\", \"pa\", \"fa\", \"pl\", \"pt\", \"ps\", \"ro\", \"ru\", \"sm\", \"sa\", \"ceb\", \"nso\", \"sr\", \"si\", \"sd\", \"sk\", \"sl\", \"so\", \"sw\", \"su\", \"tg\", \"th\", \"ta\", \"tt\", \"te\", \"ti\", \"ts\", \"tr\", \"tk\", \"uz\", \"ug\", \"uk\", \"ur\", \"fil\", \"fi\", \"fr\", \"ha\", \"hi\", \"hmn\", \"hr\", \"cs\", \"sv\", \"sn\", \"ee\", \"eo\", \"et\", \"st\", \"jv\", \"ja\", \"kri\"", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "video_id": { + "description": "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nY8Wu4rSNJms", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "language_code": { - "description": "YouTube interface language code, for example en. Provide this or language_name.", - "type": "string" - }, - "language_name": { - "description": "YouTube interface language name, for example English. Provide this or language_code.", - "type": "string" - }, - "location_code": { - "description": "YouTube location code, for example 2840. Provide this or location_name.", - "type": "integer" - }, - "location_name": { - "description": "YouTube location name, for example United States. Provide this or location_code.", - "type": "string" - }, - "video_id": { - "description": "ID of the video", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "video_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
search17 fields changed- added
Input schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - removed
Input schema / properties / category / anyOfRemoved value: -[ - { - "enum": [ - "seo", - "finance", - "social", - "search", - "sales", - "mail" - ], - "type": "string" - }, - { - "type": "null" - } -] - removed
Input schema / properties / category / defaultRemoved value: -null - changed
Input schema / properties / category / descriptionPrevious value: -"Restrict to one category (seo, finance, social, search, sales, mail). Omit to search everything."New value: +"Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.)" - added
Input schema / properties / category / enumAdded value: +[ + "seo", + "finance", + "social", + "search", + "sales", + "mail" +] - added
Input schema / properties / category / typeAdded value: +"string" - added
Input schema / properties / known_fieldsAdded value: +{ + "additionalProperties": true, + "default": {}, + "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.", + "type": "object" +} - changed
Input schema / properties / limit / descriptionPrevious value: -"Maximum candidates, 1-10"New value: +"Maximum number of additional direct tool candidates." - added
Input schema / properties / limit / maximumAdded value: +20 - added
Input schema / properties / limit / minimumAdded value: +1 - added
Input schema / properties / provider_filtersAdded value: +{ + "default": [], + "description": "Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown.", + "items": { + "type": "string" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true +} - changed
Input schema / properties / query / descriptionPrevious value: -"What you need, in plain language, e.g. 'backlinks of a domain', 'recent tweets by a user', 'insider trades for AAPL'. English works best."New value: +"Natural-language capability or task to discover." - added
Input schema / properties / query / maxLengthAdded value: +2000 - added
Input schema / properties / query / minLengthAdded value: +1 - added
Input schema / properties / session_idAdded value: +{ + "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.", + "maxLength": 128, + "pattern": "^[A-Za-z0-9_-]*$", + "type": "string" +} - added
Output schema / propertiesAdded value: +{ + "next_steps_guidance": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "type": "string" + } + }, + "plan": { + "additionalProperties": false, + "anyOf": [ + { + "type": "null" + }, + { + "type": "object" + } + ], + "properties": { + "canonical_use_case": { + "type": "string" + }, + "description": { + "type": "string" + }, + "known_pitfalls": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "type": "string" + } + }, + "plan_ref": { + "type": "string" + }, + "primary_tools": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "type": "string" + } + }, + "recommended_steps": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "type": "string" + } + }, + "related_tools": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "type": "string" + } + } + }, + "required": [ + "canonical_use_case", + "description", + "known_pitfalls", + "plan_ref", + "primary_tools", + "recommended_steps", + "related_tools" + ] + }, + "retrieval_mode": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string" + } + ] + }, + "search_id": { + "type": "string" + }, + "session_id": { + "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[A-Za-z0-9_-]{1,128}$", + "type": "string" + }, + "tools": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "additionalProperties": false, + "properties": { + "arguments_schema": { + "additionalProperties": true, + "anyOf": [ + { + "type": "null" + }, + { + "type": "object" + } + ] + }, + "description": { + "type": "string" + }, + "execution_supported": { + "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.", + "type": "boolean" + }, + "execution_unsupported_reason": { + "description": "Why execution and quoting remain unavailable through this router.", + "type": "string" + }, + "has_full_schema": { + "type": "boolean" + }, + "match_reasons": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "array" + } + ], + "items": { + "type": "string" + } + }, + "price": { + "additionalProperties": true, + "type": "object" + }, + "retrieval_debug": { + "additionalProperties": false, + "anyOf": [ + { + "type": "null" + }, + { + "type": "object" + } + ], + "properties": { + "fused_rank": { + "type": "integer" + }, + "fused_score": { + "type": "number" + }, + "lexical_rank": { + "type": "integer" + }, + "lexical_score": { + "type": "number" + }, + "rerank_admission_rank": { + "type": "integer" + }, + "rerank_rank": { + "type": "integer" + }, + "rerank_score": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "number" + } + ] + }, + "runtime_availability": { + "type": "string" + }, + "vector_view_ranks": { + "additionalProperties": { + "type": "integer" + }, + "type": "object" + }, + "vector_view_scores": { + "additionalProperties": { + "type": "number" + }, + "type": "object" + } + }, + "required": [ + "fused_rank", + "fused_score", + "lexical_rank", + "lexical_score", + "rerank_admission_rank", + "rerank_rank", + "runtime_availability", + "vector_view_ranks", + "vector_view_scores" + ] + }, + "summary": { + "type": "string" + }, + "tool": { + "type": "string" + } + }, + "required": [ + "description", + "has_full_schema", + "price", + "summary", + "tool" + ], + "type": "object" + } + } +} - added
Output schema / requiredAdded value: +[ + "next_steps_guidance", + "search_id", + "session_id", + "tools" +]
- Changed
use1 field changed- changed
Input schema / properties / max_price_usd / descriptionPrevious value: -"Refuse the call before any spend if it would cost more than this many USD"New value: +"Refuse the call before any spend if its quoted price is above this many USD"
1 tool update
- Changed
get_details1 field changed- added
Input schema / properties / include_documentationAdded value: +{ + "default": false, + "description": "Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged.", + "type": "boolean" +}
9 tool updates
- Changed
post_dataforseo_serp_baidu_organic_submit6 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results in SERP default value: 10 max value: 700 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of results in SERP default value: 10 max value: 700 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results." - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"search engine language code required field if you don't 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/{{low_se_name}}/languagesnote that the only language supported in Baidu search engine is Chinese (Simplified) with the zh_CN language code. However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatory example: zh_CN"New value: +"search engine language code required field if you don't specify language_name. Use the AIsa tool [get_dataforseo_serp_baidu_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-baidu-languages) to retrieve supported Baidu languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. note that the only language supported in Baidu search engine is Chinese (Simplified) with the zh_CN language code. However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatory example: zh_CN" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"full name of search engine language required field if you don't 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/{{low_se_name}}/languagesnote that the only language supported in Baidu search engine is Chinese (Simplified). However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatory example: Chinese (Simplified)"New value: +"full name of search engine language required field if you don't specify language_code. Use the AIsa tool [get_dataforseo_serp_baidu_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-baidu-languages) to retrieve supported Baidu languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. note that the only language supported in Baidu search engine is Chinese (Simplified). However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatory example: Chinese (Simplified)" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"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/{{low_se_name}}/locations example: 2156"New value: +"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. Use the AIsa tool [get_dataforseo_serp_baidu_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-baidu-locations) to retrieve supported Baidu locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2156" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"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/{{low_se_name}}/locations example: New York,New York,United States"New value: +"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. Use the AIsa tool [get_dataforseo_serp_baidu_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-baidu-locations) to retrieve supported Baidu locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: New York,New York,United States" - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_serp_bing_organic_live4 fields changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"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/{{low_se_name}}/languages example: en"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: en" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"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/{{low_se_name}}/languages example: English"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"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/{{low_se_name}}/locations example: 2840"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"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/{{low_se_name}}/locations example: London,England,United Kingdom"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_bing_organic_live_html4 fields changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"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/{{low_se_name}}/languages example: en"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: en" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"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/{{low_se_name}}/languages example: English"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"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/{{low_se_name}}/locations example: 2840"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"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/{{low_se_name}}/locations example: London,England,United Kingdom"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_bing_organic_live_regular4 fields changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"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/{{low_se_name}}/languages example: en"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: en" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"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/{{low_se_name}}/languages example: English"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-languages) to retrieve supported Bing languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"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/{{low_se_name}}/locations example: 2840"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"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/{{low_se_name}}/locations example: London,England,United Kingdom"New value: +"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. Use the AIsa tool [get_dataforseo_serp_bing_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-bing-locations) to retrieve supported Bing locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_naver_organic_submit2 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results in SERP default value: 15 max value: 700 Your account will be billed per each SERP containing up to 15 results; Setting depth above 15 may result in additional charges if the search engine returns more than 15 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of results in SERP default value: 15 max value: 700 Your account will be billed per each SERP containing up to 15 results; Setting depth above 15 may result in additional charges if the search engine returns more than 15 results." - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_serp_seznam_organic_submit6 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results in SERP default value: 10; maximum value: 500; Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of results in SERP default value: 10; maximum value: 500; Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results." - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"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/{{low_se_name}}/languages example: csn"New value: +"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. Use the AIsa tool [get_dataforseo_serp_seznam_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-seznam-languages) to retrieve supported Seznam languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: csn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"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/{{low_se_name}}/languages example: Czech"New value: +"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. Use the AIsa tool [get_dataforseo_serp_seznam_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-seznam-languages) to retrieve supported Seznam languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: Czech" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name 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/{{low_se_name}}/locations example: 2840"New value: +"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name. Use the AIsa tool [get_dataforseo_serp_seznam_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-seznam-locations) to retrieve supported Seznam locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code 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/{{low_se_name}}/locations example: London,England,United Kingdom"New value: +"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code. Use the AIsa tool [get_dataforseo_serp_seznam_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-seznam-locations) to retrieve supported Seznam locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_serp_yahoo_organic_live4 fields changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"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/{{low_se_name}}/languages example: enn"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: enn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"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/{{low_se_name}}/languages example: English"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"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/{{low_se_name}}/locations example: 2840n"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840n" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"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/{{low_se_name}}/locations example: London,England,United Kingdom"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_yahoo_organic_live_html4 fields changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"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/{{low_se_name}}/languages example: enn"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: enn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"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/{{low_se_name}}/languages example: English"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"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/{{low_se_name}}/locations example: 2840n"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840n" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"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/{{low_se_name}}/locations example: London,England,United Kingdom"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_yahoo_organic_live_regular4 fields changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"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/{{low_se_name}}/languages example: enn"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: enn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"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/{{low_se_name}}/languages example: English"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_languages](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-languages) to retrieve supported Yahoo languages. Select a language from the returned list and use its `language_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"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/{{low_se_name}}/locations example: 2840n"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_code` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: 2840n" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"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/{{low_se_name}}/locations example: London,England,United Kingdom"New value: +"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. Use the AIsa tool [get_dataforseo_serp_yahoo_locations](https://aisa.one/docs/api-reference/dataforseo/get_dataforseo-serp-yahoo-locations) to retrieve supported Yahoo locations. Select a location from the returned list and use its `location_name` value exactly. When using MCP, discover this tool through `search` and obtain its schema with `batch_get_schema` if needed. example: London,England,United Kingdom"
22 tool updates
- Changed
get_dataforseo_serp_baidu_organic_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Task identifier in UUID format"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_serp_baidu_organic_fetch_html1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Task identifier in UUID format"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"
- Changed
get_dataforseo_serp_baidu_organic_fetch_regular1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Task identifier in UUID format"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_serp_naver_organic_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Task identifier in UUID format"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_serp_naver_organic_fetch_html1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Task identifier in UUID format"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"
- Changed
get_dataforseo_serp_naver_organic_fetch_regular1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Task identifier in UUID format"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_serp_seznam_organic_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Task identifier in UUID format"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_serp_seznam_organic_fetch_html1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Task identifier in UUID format"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"
- Changed
get_dataforseo_serp_seznam_organic_fetch_regular1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Task identifier in UUID format"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
post_dataforseo_serp_ai_summary5 fields changed- changed
Input schema / properties / body / items / properties / fetch_content / descriptionPrevious value: -"Whether to fetch content from pages in SERPs; default false"New value: +"fetch content from pages in SERPs optional field if set to true, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result; default value: false" - changed
Input schema / properties / body / items / properties / include_links / descriptionPrevious value: -"Whether to include source links in the summary; default false"New value: +"include source links in the summary optional field if set to true, the summary field in the API response will contain links to sources of the generated summary; default value: false" - changed
Input schema / properties / body / items / properties / prompt / descriptionPrevious value: -"Additional AI prompt; maximum 2000 characters"New value: +"AI prompt optional field additional task for AI summariser; any form of text, question or information that communicates to AI what response you're looking for; max number of symbols or characters you can specify: 2000; note: your prompt has to be relevant to the keyword specified in the POST request to SERP API" - changed
Input schema / properties / body / items / properties / support_extra / descriptionPrevious value: -"Whether to consider extra SERP features such as answer_box, knowledge_graph, and featured_snippet; default true"New value: +"support extra SERP features optional field if set to true, the AI model will consider the following extra SERP features, in addition to organic results: answer_box, knowledge_graph, featured_snippet; default value: true" - changed
Input schema / properties / body / items / properties / task_id / descriptionPrevious value: -"Unique identifier of the associated task in UUID format; can be used within 30 days"New value: +"task identifier required field unique identifier of the associated task in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
post_dataforseo_serp_baidu_organic_submit12 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"Parsing depth"New value: +"parsing depth optional field number of results in SERP default value: 10 max value: 700 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page." - changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type"New value: +"device type optional field return results for a specific device type can take the values: desktop, mobile, tablet default value: desktop" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search for"New value: +"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" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"search engine language code required field if you don't 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/{{low_se_name}}/languagesnote that the only language supported in Baidu search engine is Chinese (Simplified) with the zh_CN language code. However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatory example: zh_CN" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language"New value: +"full name of search engine language required field if you don't 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/{{low_se_name}}/languagesnote that the only language supported in Baidu search engine is Chinese (Simplified). However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatory example: Chinese (Simplified)" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code"New value: +"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/{{low_se_name}}/locations example: 2156" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location"New value: +"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/{{low_se_name}}/locations example: New York,New York,United States" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"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 if you specify tablet in the device field, choose from the following values: android, ios default value: android" - changed
Input schema / properties / body / items / properties / pingback_url / descriptionPrevious value: -"Notification URL of a completed task"New value: +"notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center" - changed
Input schema / properties / body / items / properties / postback_data / descriptionPrevious value: -"Postback datatype; possible values: regular, advanced, html"New value: +"postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: regular, html" - changed
Input schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"URL for sending task results"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center" - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"Task priority"New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."
- Changed
post_dataforseo_serp_bing_organic_live7 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type"New value: +"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search for"New value: +"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" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"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/{{low_se_name}}/languages example: en" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language"New value: +"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/{{low_se_name}}/languages example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code"New value: +"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/{{low_se_name}}/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location"New value: +"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/{{low_se_name}}/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"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"
- Changed
post_dataforseo_serp_bing_organic_live_html7 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type"New value: +"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search for"New value: +"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" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"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/{{low_se_name}}/languages example: en" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language"New value: +"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/{{low_se_name}}/languages example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code"New value: +"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/{{low_se_name}}/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location"New value: +"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/{{low_se_name}}/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"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"
- Changed
post_dataforseo_serp_bing_organic_live_regular7 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type"New value: +"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search for"New value: +"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" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"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/{{low_se_name}}/languages example: en" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language"New value: +"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/{{low_se_name}}/languages example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code"New value: +"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/{{low_se_name}}/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location"New value: +"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/{{low_se_name}}/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"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"
- Changed
post_dataforseo_serp_naver_organic_submit8 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"Parsing depth"New value: +"parsing depth optional field number of results in SERP default value: 15 max value: 700 Your account will be billed per each SERP containing up to 15 results; Setting depth above 15 may result in additional charges if the search engine returns more than 15 results; The cost can be calculated on the Pricing page." - changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type"New value: +"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search for"New value: +"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" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"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" - changed
Input schema / properties / body / items / properties / pingback_url / descriptionPrevious value: -"Notification URL of a completed task"New value: +"notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center" - changed
Input schema / properties / body / items / properties / postback_data / descriptionPrevious value: -"Postback datatype; possible values: regular, advanced, html"New value: +"postback_url datatype required field if you specify postback_url corresponds to the function you used for setting a task possible values: regular, advanced, html" - changed
Input schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"URL for sending task results"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center" - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"Task priority"New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."
- Changed
post_dataforseo_serp_screenshot6 fields changed- changed
Input schema / properties / body / items / properties / browser_preset / descriptionPrevious value: -"Browser resolution preset: desktop, tablet, or mobile"New value: +"browser resolution preset optional field browser preset associated with a certain device type can take the following values: desktop, tablet, mobile Note: by default, browser preset corresponds to the device type specified in the POST request" - changed
Input schema / properties / body / items / properties / browser_screen_height / descriptionPrevious value: -"Browser resolution height; range 240-9999"New value: +"height of the browser resolution optional field can be specified in the following range: 240-9999 default value for desktop: 1080 default value for mobile: 844 default value for table: 1366" - changed
Input schema / properties / body / items / properties / browser_screen_scale_factor / descriptionPrevious value: -"Browser scale factor; range 0.5-3"New value: +"browser scale factor optional field can be specified in the following range: 0.5-3 default value for desktop: 1 default value for mobile: 3 default value for table: 2" - changed
Input schema / properties / body / items / properties / browser_screen_width / descriptionPrevious value: -"Browser resolution width; range 240-9999"New value: +"width of the browser resolution optional field can be specified in the following range: 240-9999 default value for desktop: 1920 default value for mobile: 390 default value for table: 1024" - changed
Input schema / properties / body / items / properties / page / descriptionPrevious value: -"SERP page number to screenshot; default 1"New value: +"number of SERP pages optional field if depth in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot; default value: 1" - changed
Input schema / properties / body / items / properties / task_id / descriptionPrevious value: -"Unique identifier of the associated task in UUID format; can be used within 7 days"New value: +"task identifier required field unique identifier of the associated task in the UUID format you will be able to use it within 7 days to request the results of the task at any time"
- Changed
post_dataforseo_serp_seznam_organic_submit12 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"Parsing depth"New value: +"parsing depth optional field number of results in SERP default value: 10; maximum value: 500; Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page." - changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type"New value: +"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search for"New value: +"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" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"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/{{low_se_name}}/languages example: csn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language"New value: +"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/{{low_se_name}}/languages example: Czech" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code"New value: +"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name 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/{{low_se_name}}/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location"New value: +"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code 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/{{low_se_name}}/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"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" - changed
Input schema / properties / body / items / properties / pingback_url / descriptionPrevious value: -"Notification URL of a completed task"New value: +"notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center" - changed
Input schema / properties / body / items / properties / postback_data / descriptionPrevious value: -"Postback datatype; possible values: regular, advanced, html"New value: +"postback_url datatype required field if you specify postback_url corresponds to the function you used for setting a task possible values: regular, advanced, html" - changed
Input schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"URL for sending task results"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center" - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"Task priority"New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."
- Changed
post_dataforseo_serp_yahoo_organic_live7 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type"New value: +"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search for"New value: +"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" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"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/{{low_se_name}}/languages example: enn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language"New value: +"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/{{low_se_name}}/languages example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code"New value: +"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/{{low_se_name}}/locations example: 2840n" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location"New value: +"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/{{low_se_name}}/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"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"
- Changed
post_dataforseo_serp_yahoo_organic_live_html7 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type"New value: +"device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search for"New value: +"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" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"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/{{low_se_name}}/languages example: enn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language"New value: +"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/{{low_se_name}}/languages example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code"New value: +"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/{{low_se_name}}/locations example: 2840n" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location"New value: +"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/{{low_se_name}}/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"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"
- Changed
post_dataforseo_serp_yahoo_organic_live_regular7 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type"New value: +"device type optional field can take the values:desktop, mobile default value: desktop" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search for"New value: +"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" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"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/{{low_se_name}}/languages example: enn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language"New value: +"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/{{low_se_name}}/languages example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code"New value: +"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/{{low_se_name}}/locations example: 2840n" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location"New value: +"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/{{low_se_name}}/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"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"
- Changed
post_dataforseo_serp_youtube_video_comments_live5 fields changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"YouTube interface language code, for example en. Provide this or language_name."New value: +"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/youtube/languages example: enn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"YouTube interface language name, for example English. Provide this or language_code."New value: +"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/youtube/languages example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"YouTube location code, for example 2840. Provide this or location_name."New value: +"search engine location code required field if you don't specify location_name_ if you use this field, you don't need to specify location_name 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/youtube/locations example: 2840n" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"YouTube location name, for example United States. Provide this or location_code."New value: +"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code 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/youtube/locations example: United States" - changed
Input schema / properties / body / items / properties / video_id / descriptionPrevious value: -"ID of the video"New value: +"ID of the video required field you can find video ID in the URL or 'youtube_video' item of YouTube Organic result example: vQXvyV0zIP4"
- Changed
post_dataforseo_serp_youtube_video_info_live6 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type; only desktop is supported"New value: +"device type optional field only value: desktop" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"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/youtube/languages example: en" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language"New value: +"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/youtube/languages example: English" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code"New value: +"search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name 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/youtube/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location"New value: +"full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code 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/youtube/locations example: United States" - changed
Input schema / properties / body / items / properties / video_id / descriptionPrevious value: -"ID of the video"New value: +"ID of the video required field you can find video ID in the URL or 'youtube_video' item of YouTube Organic result example: vQXvyV0zIP4"
39 tool updates
- First observed
batch_use - First observed
get_dataforseo_serp_baidu_languages - First observed
get_dataforseo_serp_baidu_locations - First observed
get_dataforseo_serp_baidu_organic_fetch - First observed
get_dataforseo_serp_baidu_organic_fetch_html - First observed
get_dataforseo_serp_baidu_organic_fetch_regular - First observed
get_dataforseo_serp_bing_languages - First observed
get_dataforseo_serp_bing_locations - First observed
get_dataforseo_serp_naver_organic_fetch - First observed
get_dataforseo_serp_naver_organic_fetch_html - First observed
get_dataforseo_serp_naver_organic_fetch_regular - First observed
get_dataforseo_serp_seznam_languages - First observed
get_dataforseo_serp_seznam_locations - First observed
get_dataforseo_serp_seznam_organic_fetch - First observed
get_dataforseo_serp_seznam_organic_fetch_html - First observed
get_dataforseo_serp_seznam_organic_fetch_regular - First observed
get_dataforseo_serp_yahoo_languages - First observed
get_dataforseo_serp_yahoo_locations - First observed
get_dataforseo_serp_youtube_languages - First observed
get_dataforseo_serp_youtube_locations - First observed
get_details - First observed
list_categories - First observed
post_dataforseo_serp_ai_summary - First observed
post_dataforseo_serp_baidu_organic_submit - First observed
post_dataforseo_serp_bing_organic_live - First observed
post_dataforseo_serp_bing_organic_live_html - First observed
post_dataforseo_serp_bing_organic_live_regular - First observed
post_dataforseo_serp_naver_organic_submit - First observed
post_dataforseo_serp_screenshot - First observed
post_dataforseo_serp_seznam_organic_submit - First observed
post_dataforseo_serp_yahoo_organic_live - First observed
post_dataforseo_serp_yahoo_organic_live_html - First observed
post_dataforseo_serp_yahoo_organic_live_regular - First observed
post_dataforseo_serp_youtube_organic_live - First observed
post_dataforseo_serp_youtube_video_comments_live - First observed
post_dataforseo_serp_youtube_video_info_live - First observed
post_dataforseo_serp_youtube_video_subtitles_live - First observed
search - First observed
use
Publisher details
- Operator
- AIsa · Publisher source
- Operator website
- https://aisa.one
- Vendor relationship
- Independent
- Documentation
- https://mcp.aisa.one/servers
- Trust center
- Not available
- Restrictions
- No paid plan, admin approval, regional limit or custom OAuth app is needed to connect. Sign-in is OAuth against auth.aisa.one with dynamic client registration (RFC 7591), or an Authorization: Bearer AIsa API key. search, get_details and list_categories are free. use and batch_use are billed per call to the caller's own AIsa key, and max_price_usd refuses anything above a cap before any spend. Some operations are subscription-only on the gateway and answer 402 without the Hive GTM Growth plan.
Related MCP Connectors
Your agent needs the Google results page as it actually renders — organic and paid, the AI overview, maps, images, news, jobs and the finance panel — not a scraped guess. **What you can ask for** • "What does the SERP for this keyword look like in Germany, on mobile?" • "Does this query trigger an AI overview, and what does it say?" • "Who is advertising against our brand name?" • "Find local results and the map pack for this phrase." • "Search Google by this image and tell me where else it appears." **How to use it** Point any MCP client at https://mcp.aisa.one/seo-serp/mcp and sign in with OAuth — there is no key to create or paste. 38 tools across Google's surfaces: organic, ads and advertisers, AI mode, autocomplete, images, news, maps and local, events, jobs, datasets, scholar, finance quotes and markets, plus Semrush's organic and paid result sets. **Why this rather than the source** Location and language are parameters, so you can read the page a customer in another country sees. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Read the SERP here, then ask the same agent who links to the winner or how much traffic they get — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo-serp-other-engines/mcp for Bing, Yahoo, Baidu, Naver, Seznam and YouTube. https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Your agent needs the whole search picture — what you rank for, who outranks you, who links to them, what is broken on the site, and whether ChatGPT names you at all. Normally that is three SEO vendors and three subscriptions. **What you can ask for** • "What does this domain rank for, and which competitors take the same keywords?" • "Who links to my competitor and not to me?" • "Crawl this site and list the pages with broken tags or duplicate content." • "Does Perplexity cite us when asked about this category?" • "How hard is this keyword, and what does the SERP look like today?" **How to use it** Point any MCP client at https://mcp.aisa.one/seo/mcp and sign in with OAuth — there is no key to create or paste. 60 tools spanning DataForSEO, Semrush and Ahrefs: SERPs, keywords and difficulty, backlinks and referring domains, on-page crawling, domain authority, and answers from ChatGPT, Claude, Gemini and Perplexity. **Why this rather than the source** Three indexes behind one account, so you can cross-check a number instead of trusting one vendor's version of it. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Check the ranking here, then ask the same agent for that competitor's traffic mix, its ad spend, or the person to email — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** Narrower endpoints: https://mcp.aisa.one/seo-serp/mcp · /seo-keywords/mcp · /seo-backlinks/mcp · /seo-onpage/mcp · /seo-labs/mcp · /seo-ai-visibility/mcp · /seo-content/mcp · /seo-domains/mcp · /seo-business/mcp · /seo-merchant/mcp · /seo-apps/mcp · /seo-serp-other-engines/mcp
Your agent needs the open web — searched by more than one engine, and read as clean markdown rather than raw HTML. **What you can ask for** • "Search this question with two providers and tell me where they disagree." • "Scrape these 40 URLs into markdown, in one batch." • "Crawl this documentation site and give me every page." • "Do deep research on this topic and cite the sources." • "Find the academic papers behind this claim." **How to use it** Point any MCP client at https://mcp.aisa.one/search/mcp and sign in with OAuth — there is no key to create or paste. 30 tools across several independent providers: Tavily and Exa search, answers, contents and agent runs; Firecrawl scrape, batch scrape, crawl, map and search; Perplexity Sonar, Sonar Pro, reasoning and deep research; Oxylabs AI search and LLM jobs; OpenAI and Anthropic web search; and scholarly search. **Why this rather than the source** Several independent indexes behind one account, because one engine's blind spot is not visible from inside it. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Find the page here, then ask the same agent who links to it or how much traffic it gets — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo-serp/mcp for the Google results page itself, https://mcp.aisa.one/seo-serp-other-engines/mcp for Bing, Baidu and Naver.
Your agent needs the derived numbers — domain authority, what a site ranks for, related and relevant keywords, search intent, and who the real competitors are — for Google, Amazon and the app stores. **What you can ask for** • "What is this domain's authority, and how has its rank history moved?" • "Which keywords does this site rank for, and with what intent?" • "Who are this domain's organic competitors, and where do we overlap?" • "Which keywords does this Amazon product rank for?" • "Compare these two domains keyword by keyword." **How to use it** Point any MCP client at https://mcp.aisa.one/seo-labs/mcp and sign in with OAuth — there is no key to create or paste. 46 tools: ranked, related and relevant keywords, keyword ideas and intent, domain authority and rank history, competitor and intersection analysis, bulk metrics, plus the same shapes for Amazon products and Apple and Google Play apps. **Why this rather than the source** Ahrefs domain rating, Semrush rank history and DataForSEO Labs answering the same questions side by side. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Size the competitor here, then ask the same agent for their traffic mix or their contacts — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Related MCP Servers
- AlicenseNot gradedqualityCmaintenanceEnables AI agents to retrieve real-time SERP data from Google, Shopping, Jobs, YouTube, and over 100 engines as structured JSON through MCP tools.MIT
- AlicenseNot gradedqualityBmaintenanceEnables AI agents to perform live Google SERP searches, run on-page and full-site SEO audits with prioritized fixes, and check brand visibility in AI answer engines via four MCP tools.MIT
- AlicenseAqualityCmaintenanceWeb intelligence MCP server for AI agents. 7 tools for SERP analysis, competitor research, market trends, content gap analysis, keyword insights, audience discovery, and citation tracking.72AGPL 3.0

ReefAPI MCPofficial
AlicenseAqualityBmaintenanceOne MCP server providing access to 160+ live web data APIs (search, social media, e-commerce, real estate, jobs, travel, news, finance, and more) using dynamic discovery via 4 generic tools to avoid the agent's tool limit.54MIT
Glama MCP Gateway
Add one secure layer between your agents and this server.