A
licenseNot graded
qualityC
maintenanceEnables AI agents to retrieve real-time SERP data from Google, Shopping, Jobs, YouTube, and over 100 engines as structured JSON through MCP tools.
MIT
AIsa SERP — Google
by one.aisa
Server Details
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.
Ownership verified
- Status
- Healthy
- Uptime
- 93.9% over 42 days
- OAuth
- Works in Glama
- Last Tested
- Transport
- Streamable HTTP · MCP 2025-11-25
- URL
TDQS
C2.6/5.0
Scored across 45 tools
Disambiguation2/5
Many tools are near-identical variants of the same query: post_dataforseo_serp_google_organic_live, _live_html, _live_regular, and the get_/post_ split (e.g. get_dataforseo_serp_google_events_locations vs post_dataforseo_serp_google_events_live) blur the boundary between locations metadata and result retrieval. Several descriptions are blank boilerplate (e.g. gads_advertisers_locations, gads_search_locations, semrush entries) or copy-pasted pricing blocks, so an agent must guess between parsed vs HTML vs regular depth. The deprecated 'use' tool sitting beside batch_use and search/batch_get_schema/batch_quote/batch_use adds another layer of selection risk.
Naming Consistency4/5
The bulk of the surface follows a strict snake_case pattern: get_dataforseo_serp_<engine>_<endpoint> and post_dataforseo_serp_<engine>_<endpoint>, with suffixes (_live, _live_html, _submit, _fetch, _locations) applied predictably. The router tools (search, batch_*, account, list_categories, use) use short, different words but stay in snake_case, and the deprecated 'use' is the only real naming blemish.
Tool Count2/5
45 tools far exceeds a comfortable set for a Google SERP service, and much of the count comes from HTML/regular/advanced variants of the same endpoints rather than distinct capabilities. Pruning the duplicated raw-HTML and depth variants would cut the surface roughly in half without losing functionality.
Completeness4/5
Coverage of the Google SERP domain is broad: organic, news, images, maps, local finder, jobs, events, finance (explore/markets/quote/ticker), datasets, autocomplete, AI mode, ads transparency, search-by-image, plus location and language enumeration and Semrush organic/paid fallbacks. Minor gaps remain (e.g. fetch/HTML only for some async endpoints) but core workflows are covered, and the quote/execute pattern gives cost control.
Available Tools
45 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
A4.7/5.0
Behavior5/5
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.
Conciseness5/5
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.
Completeness5/5
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.
Parameters4/5
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.
Purpose5/5
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.
Usage Guidelines4/5
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
A4.6/5.0
Behavior4/5
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.
Conciseness4/5
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.
Completeness5/5
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.
Parameters4/5
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.
Purpose5/5
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.
Usage Guidelines5/5
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
A4.8/5.0
Behavior5/5
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.
Conciseness4/5
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.
Completeness5/5
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.
Parameters4/5
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.
Purpose5/5
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.
Usage Guidelines5/5
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
A4.1/5.0
Behavior4/5
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.
Conciseness3/5
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.
Completeness4/5
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.
Parameters4/5
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.
Purpose4/5
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.
Usage Guidelines5/5
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_gads_advertisers_locationsList of Google Ads Advertisers Locations for SERP APICRead-onlyIdempotentInspect
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
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
C2/5.0
Behavior2/5
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 only a generic statement about a 'tasks array' in the response, which is redundant given the output schema exists, and discloses nothing about auth, rate limits, or what the locations data represents.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness3/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short, but it is not front-loaded with any purpose and is padded with an unrelated pricing/marketing comment block. The only real sentence is generic response boilerplate rather than a useful lead statement.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness2/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple zero-parameter read tool with a full output schema and annotations, the description still fails to convey what the returned 'locations' actually are or when to call it. The structured fields carry the definition; the description is essentially inert.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters4/5
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. There are no parameter semantics for the description to clarify or omit.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose1/5
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 only says the server returns 'JSON-encoded data containing a tasks array,' which is generic response boilerplate applicable to any endpoint. The actual purpose (listing Google Ads advertiser locations for SERP) is carried entirely by the name and title, not the description.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines1/5
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, what it is for, or how it relates to siblings like get_dataforseo_serp_gads_search_locations or post_dataforseo_serp_gads_advertisers_live. No conditions, prerequisites, or alternatives are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_gads_search_locationsList of Google Ads Search Locations for SERP APIDRead-onlyIdempotentInspect
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
D1.7/5.0
Behavior2/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description's only added context is a cost estimate ($0.012 default) and the caveat that it is not a fixed price, which is genuinely useful but far short of disclosing what the call returns or any lookup semantics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness1/5
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but it is short because it says nothing relevant to tool selection — the entire body is billing boilerplate in HTML comments rather than a front-loaded purpose statement. The content does not earn its place in a tool definition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness1/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-argument lookup tool with an output schema, the agent still needs to know what the returned location list is for and how it pairs with the gads search endpoints. None of that appears; the description is effectively absent as functional documentation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters4/5
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 clarify and the schema is trivially complete. No parameter-related information is missing because no parameters exist.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose1/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description contains no statement of purpose whatsoever — it is entirely a pricing/usage-billing notice wrapped in HTML comments. Only the title hints at the resource ('Google Ads Search Locations'), and the description never says it returns a list of locations usable for gads SERP queries.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines1/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use, when-not-to-use, or alternative guidance is given. Nothing distinguishes it from siblings like get_dataforseo_serp_gads_advertisers_locations or post_dataforseo_serp_gads_search_live, leaving the agent to infer routing 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_google_ai_mode_languagesList of Google AI Mode Languages for SERPBRead-onlyIdempotentInspect
You will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
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
B3/5.0
Behavior3/5
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 adds the response shape (JSON with a tasks array) and, usefully, a billing estimate of ~$0.012 per call with the caveat that it is not a fixed price. Return-format details are redundant given an output schema exists, but the cost note is genuine added context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness3/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose sentence is buried behind filler ('As a response of the API server, you will receive JSON-encoded data containing a tasks array...'), which restates a standard envelope rather than the tool's role. The pricing block is compact but boilerplate; the whole passage could be one lead sentence plus the cost note.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 only needs to say what the languages list is for and how it relates to the live AI Mode endpoints. It supplies neither, leaving the agent to infer the connection from the tool name alone; the pricing note is the only genuinely complete piece of information.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters4/5
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. There is nothing for the description to document, and it introduces no parameter confusion.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose3/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'you will receive the list of languages by calling this API,' which identifies the resource (languages) but does not echo the 'Google AI Mode' specificity of the tool name or distinguish it from the many location/list siblings such as get_dataforseo_serp_google_jobs_locations. An agent can infer this returns supported languages, but nothing states what the languages are for or which endpoint consumes them.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
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 that this is a metadata/reference lookup that feeds post_dataforseo_serp_google_ai_mode_live, and no exclusions against the sibling *_locations or other list tools. The agent is left to guess whether this is a standalone query or a prerequisite lookup.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_google_events_locationsList of Google Events Locations for SERP APICRead-onlyIdempotentInspect
Returns the events Google surfaces for a query on Google. Returns keyword, type, se_domain, location_code, language_code, check_url, datetime, spell, refinement_chips, item_types, items_count and items. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.
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
C2.8/5.0
Behavior4/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive, open-world), so the bar is lower, yet the description adds genuinely useful behavior: the DataForSEO response envelope (data in tasks[0].result, outcome in tasks[0].status_code) and the key fact that a rejected request still returns HTTP 200. That error-handling detail is exactly the kind of signal an agent needs and cannot get from annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness3/5
Is the description appropriately sized, front-loaded, and free of redundancy?
It is front-loaded with the purpose sentence followed by the envelope explanation, which is good ordering. However, the long enumeration of return fields (keyword, se_domain, check_url, spell, refinement_chips, ...) duplicates what the existing output schema already provides, and the pricing comment block is cosmetic boilerplate that does not help invocation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness2/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a no-parameter endpoint with an output schema and full annotation coverage, the description does supply the envelope and billing context. But the central claim — that it returns SERP items for a query — conflicts with the name/title and the empty schema, leaving the agent unclear on what the call will actually produce.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters4/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so per the baseline a 4 applies; with nothing to document there is no semantic gap to compensate for. The description appropriately does not invent parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose2/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description says it returns the events Google surfaces for a query, but the tool name and title describe a list of Google Events *locations*, and with zero parameters a query-driven SERP fetch is not possible. The stated verb+resource is clear in isolation but misaligned with the tool's own identity, so an agent cannot reliably tell what this endpoint actually returns.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this endpoint versus the obvious sibling post_dataforseo_serp_google_events_live, nor versus the other *_locations enumerations (e.g. get_dataforseo_serp_google_jobs_locations). The agent must infer usage entirely on its own.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_google_jobs_fetchGet Google Jobs 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
C2/5.0
Behavior2/5
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 only a pricing note ($0 USD per request), which is marginally useful, but says nothing about retrieval behavior, the fact that it pulls results of a previously submitted task, or the 30-day window (left to 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.
Conciseness2/5
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but the first sentence is pure boilerplate that promises a field description it never delivers, so it does not earn its place. The only substantive content is the pricing comment, and nothing is front-loaded about the tool's function.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness2/5
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 annotations cover safety, but the description omits the essential semantics: that this fetches stored results for a task id obtained from the submit tool. For an id-based fetch tool, that missing context is a real gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With a single parameter and 100% schema description coverage, the schema already fully documents 'id' (UUID task identifier, usable for 30 days). The description adds nothing to parameter meaning, but per the high-coverage baseline a 3 is appropriate since the schema does the work.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose2/5
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 the meta-placeholder 'Description of the fields for sending a request:' and then only contains a pricing comment. The actual purpose is carried entirely by the name/title, so the description itself is effectively empty filler rather than a statement of verb+resource.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines1/5
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, and no differentiation from the closely related siblings such as post_dataforseo_serp_google_jobs_submit (which creates the task) or get_dataforseo_serp_google_jobs_fetch_html. An agent gets zero routing help from this text.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_google_jobs_fetch_htmlGet Google Jobs 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
D1.7/5.0
Behavior2/5
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 adds only a pricing note ($0 USD reference per successful request, account pricing may differ), which is genuine cost context but is generic boilerplate rather than tool-specific behavior. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness2/5
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but brevity is not conciseness here: neither sentence describes the tool, and the purpose is never front-loaded. The stub line plus a pricing comment are filler occupying the entire description.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness2/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists and the single parameter is fully documented, so return values need not be explained. What is missing is the one thing the description alone must supply: what the tool actually does and when to call it instead of the sibling fetch/submit tools.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
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 the schema itself richly documents the UUID format and the 7-day reuse window. The description adds nothing to parameter meaning, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose1/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description is a placeholder stub ("Description of the fields for sending a request:") followed by auto-injected pricing boilerplate. It never states the verb or resource, so an agent gets no confirmation that this fetches stored Google Jobs SERP HTML for a prior task id. It is worse than a tautology because it does not even restate the name or title.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines1/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use, when-not-to-use, or alternative is given, despite siblings like get_dataforseo_serp_google_jobs_fetch and post_dataforseo_serp_google_jobs_submit that an agent must choose between. The only routing signal available is the tool name itself.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_google_jobs_locationsList of Google Jobs Locations for SERP APICRead-onlyIdempotentInspect
Returns the job listings Google surfaces for a query on Google. Returns keyword, type, se_domain, location_code, language_code, check_url, datetime, spell, refinement_chips, item_types, items_count and items. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.
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
C2.6/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, open-world and non-destructive, so safety is covered. The description does add genuine DataForSEO-specific behavior: the tasks[0].result / tasks[0].status_code envelope and the fact that a rejected request still returns HTTP 200. However, that behavioral detail is framed around returning job-listing items rather than locations, so it partly describes the wrong operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness3/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The envelope sentence is compact and front-loaded, but the long enumeration of return fields is largely redundant with the existing output schema and, given the tool mismatch, is likely wasted or misleading text. Size is acceptable; relevance is not.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness2/5
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, yet the description spends most of its length doing exactly that while never clarifying what a 'locations' call actually yields or how it differs from the jobs fetch/submit siblings. For an endpoint whose whole purpose is the location list, the description leaves the core question unanswered.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters4/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has zero parameters, so per the calibration baseline the schema itself is trivially complete and there is no parameter meaning for the description to supply. The field list in the description refers to return values rather than inputs, limiting its usefulness here.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose2/5
Does the description clearly state what the tool does and how it differs from similar tools?
The tool name and title say it lists Google Jobs *locations*, but the description says it 'Returns the job listings Google surfaces for a query on Google' and enumerates item-level result fields (items, item_types, items_count). That describes the sibling fetch tool, not a locations-lookup endpoint, so the stated purpose is misleading relative to the tool's own identity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
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 prerequisites (this is a zero-parameter lookup), and no routing to or away from the many sibling locations/fetch/submit tools. The agent gets no help deciding when this tool applies.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_google_search_by_image_fetchGet Google Search By Image 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
D1.7/5.0
Behavior2/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true and destructiveHint=false, so the safety profile is covered externally. The description adds only a generic pricing note ('$0 USD per successful request') that is qualified as possibly differing, providing minimal extra behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness2/5
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but the content is a broken placeholder plus commented-out pricing markup rather than front-loaded, useful information. Brevity here reflects absent content, not efficient communication.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness2/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple (one parameter, output schema present), so the description need not explain return values. However, it omits the essential fetch semantics — that it returns results for an id from a prior Search-By-Image submission — which is the only non-obvious thing an agent needs to know.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the single id parameter is fully documented in the schema (UUID format, 30-day retrieval window). Per the baseline rule for high coverage, the schema does the heavy lifting even though the description adds nothing about the field it claims to describe.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose1/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description body is a placeholder fragment ('Description of the fields for sending a request:') followed only by pricing boilerplate. It never states that the tool retrieves the results of a previously submitted Google Search-By-Image task by id, leaving the name and title to carry the entire purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines1/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance whatsoever on when to use this versus alternatives such as get_dataforseo_serp_google_search_by_image_fetch_html or the corresponding submit tool. There is no mention of the prerequisite that the id comes from a prior submit call.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_serp_google_search_by_image_fetch_htmlGet Google Search By Image HTML Results by idARead-onlyIdempotentInspect
Retrieves a queued Google search by image result by id as raw HTML. 🔴 Measured at 2.4 MB against 57 KB parsed on the Google organic pair. Free - the charge was on the submit. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Task identifier in UUID format |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
A3.8/5.0
Behavior4/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover readOnly/idempotent/destructive, but the description adds real value: a 2.4 MB vs 57 KB size warning, the fact that fetching is free while the charge was on submit, and the critical quirk that a rejected request still returns HTTP 200 with the error in tasks[0].status_code.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness5/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loads the core action in the first sentence, then layers in size, cost, and envelope details as discrete, non-redundant facts. No filler; every sentence conveys distinct information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness4/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and annotations covering the safety profile, return values needn't be explained, yet the description still documents the envelope shape and the HTTP-200-on-error pitfall. Complete enough for correct invocation; only the when-to-use routing is thin.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the single `id` parameter is fully documented as a UUID in the schema. The description adds only 'by `id`', matching the baseline for a well-covered parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource: 'Retrieves a queued Google search by image result by `id` as raw HTML.' The 'raw HTML' phrasing implicitly distinguishes it from the parsed sibling get_dataforseo_serp_google_search_by_image_fetch, though it never names that sibling explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines3/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
The word 'queued' plus 'the charge was on the submit' imply this is a follow-up to a submit call, giving usable context. But there is no explicit when-to-use statement, no named alternative (e.g. the non-HTML fetch), and no stated exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_semrush_organic_resultsOrganic ResultsDRead-onlyIdempotentInspect
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 |
|---|---|---|---|
| phrase | Yes | ||
| database | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
D1.3/5.0
Behavior2/5
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 does add real cost context (usage-based billing, ~$0.02 default estimate, settlement may differ), which is genuinely useful for an agent, but says nothing about auth, latency, or result shape.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness2/5
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but it is short because it omits its actual job — the only sentences present are a cost disclaimer. Brevity without any statement of purpose is under-specification, not conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness1/5
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 networked, billed search tool the description supplies no purpose, no parameter meaning, and no usage routing. It is wholly inadequate despite the output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters1/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% and the description never mentions 'phrase' (the required keyword) or 'database' (the market selector). With two undocumented parameters and no compensating text, the agent has no basis for supplying them.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose1/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description contains only a pricing/billing banner and never states what the tool does. There is no verb or resource ('fetch SEMrush organic search results'), so an agent must infer everything from the tool name alone and cannot distinguish it from get_semrush_paid_results.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines1/5
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 routing to alternatives such as get_semrush_paid_results or the DataForSEO organic SERP siblings. The only content is billing information.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_semrush_paid_resultsPaid ResultsDRead-onlyIdempotentInspect
Usage-based billing; Default request estimate: $0.04 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| phrase | Yes | ||
| database | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
D1.5/5.0
Behavior3/5
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 covered. The description adds genuinely new behavioral context: that billing is usage-based with a default estimate of $0.04 and that final cost may vary. That cost disclosure is useful beyond the annotations, though return format, result caps and throttling are still unstated.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness2/5
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but the space is spent on HTML-commented pricing boilerplate rather than front-loaded functional content. Nothing in it helps an agent decide or correctly invoke the tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness1/5
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 2-parameter tool with 0% schema coverage the description leaves purpose, parameters and usage entirely unspecified. The pricing note alone is not sufficient context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters1/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Both parameters (required 'phrase' and optional 'database') have 0% schema description coverage, so the description carries the full explanatory burden. It says nothing about what a phrase or database identifier means, valid formats, or accepted values.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose1/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description contains no statement of what the tool does. It only carries a usage-based pricing disclaimer, so an agent must infer the purpose entirely from the name 'get_semrush_paid_results'. It does not distinguish this from sibling get_semrush_organic_results.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines1/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use, when-not-to-use, or alternative guidance is present. The obvious sibling (get_semrush_organic_results) is never mentioned, and nothing indicates when paid results are the right choice over organic ones.
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
A4.1/5.0
Behavior4/5
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.
Conciseness4/5
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.
Completeness5/5
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.
Parameters4/5
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.
Purpose4/5
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.
Usage Guidelines4/5
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_gads_advertisers_liveLive Google Ads Advertisers AdvancedADestructiveInspect
Returns the advertisers matching a query in Google's ads transparency data on Google, synchronously. Returns keyword, type, se_domain, location_code, language_code, check_url, datetime, spell, refinement_chips, item_types, items_count and items. Measured at 57 KB for a ten-result Google query. ⚠️ Three result depths exist for the same query and differ by two orders of magnitude: regular measured 4.8 KB, advanced 57 KB, and html 2.4 MB. advanced is the default choice; take regular when only the ranked list matters and html only to check what the parser dropped. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.
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 | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
A3.9/5.0
Behavior5/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses traits annotations cannot: the DataForSEO envelope layout (data in tasks[0].result, outcome in tasks[0].status_code) and the critical gotcha that a rejected request still returns HTTP 200. It also quantifies payload sizes across the three depth modes (4.8 KB / 57 KB / 2.4 MB) so the agent can predict cost and context consumption. This is exactly the kind of behavioral detail the annotations (readOnlyHint=false, destructiveHint=true, idempotentHint=false) do not convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with purpose, then the high-value caveats (size disparity, HTTP 200 envelope). The enumerated return-field list is somewhat padded given an output schema exists, but every other sentence carries weight.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness4/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a live SERP query tool with an output schema present, the description covers the things the schema cannot: failure semantics, response envelope, and the depth/size tradeoff. The remaining gap is the input side — nothing explains how to build the required `body` array — which keeps it from being fully complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters2/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% for the top-level parameter, and the description does not compensate: the fields it enumerates (keyword, type, se_domain, location_code, language_code, check_url, ...) are described as return values, not inputs. The fact that the request is a required `body` array of task objects, each needing a `keyword`, is left entirely to the schema, so the agent gets no request-shaping help from the prose.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Returns the advertisers matching a query in Google's ads transparency data on Google, synchronously.' An agent can immediately tell what class of data comes back. It does not differentiate itself from the sibling post_dataforseo_serp_gads_search_live, which is the nearest ambiguous alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines4/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit selection guidance for the depth variants ('advanced is the default choice; take regular when only the ranked list matters and html only to check what the parser dropped'), which is real decision support. It never says when to prefer this tool over the sibling gads_search_live or over a non-live endpoint, so it stops short of full when/when-not coverage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_gads_search_liveLive Google Ads Search AdvancedADestructiveInspect
Returns the ads running against a keyword on Google, synchronously. Returns keyword, type, se_domain, location_code, language_code, check_url, datetime, spell, refinement_chips, item_types, items_count and items. Measured at 57 KB for a ten-result Google query. ⚠️ Three result depths exist for the same query and differ by two orders of magnitude: regular measured 4.8 KB, advanced 57 KB, and html 2.4 MB. advanced is the default choice; take regular when only the ranked list matters and html only to check what the parser dropped. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.
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
A3.5/5.0
Behavior4/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds behavior well beyond the annotations: synchronous execution, the DataForSEO envelope (data in tasks[0].result, outcome in tasks[0].status_code), and the crucial detail that a rejected request still returns HTTP 200 — which prevents the agent from trusting the transport status. It also discloses approximate response size and billing. It does not, however, reconcile the read-flavored 'returns ads' semantics with the annotations' destructiveHint=true / idempotentHint=false, leaving a real ambiguity unexplained.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness3/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The field enumeration ('Returns keyword, type, se_domain, ... items_count and items') is pure bloat because an output schema already exists, and it pushes the genuinely valuable depth warning and envelope semantics into the middle of the text. The pricing block and size comparisons do earn their place, but the whole would be tighter and better front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex, billed, enveloped SERP endpoint the description covers the return side well (though the output schema already does that) and flags the critical depth tradeoff. What it omits is the input contract, which is the exact area where schema coverage is zero, plus any explanation of the readOnlyHint=false/destructiveHint=true annotations on what is functionally a search call.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters2/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description carries the burden for the input body — and it fails: it enumerates eleven output fields while saying nothing about the actual inputs (target, advertiser_ids, location_code, location_name, location_coordinate) or the anyOf requirement that one of target/advertiser_ids be supplied. Worse, the description's 'ads running against a keyword' implies a keyword parameter that does not exist in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
Starts with a specific verb+resource: 'Returns the ads running against a keyword on Google, synchronously,' which cleanly separates it from the organic/news/jobs SERP siblings and from get_dataforseo_serp_gads_advertisers_locations. It also implicitly positions itself against the same-family depth variants (regular/advanced/html). It never names a sibling outright, and the 'against a keyword' framing is slightly at odds with the actual input being target/advertiser_ids.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines4/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives concrete selection guidance for the three result depths: 'advanced is the default choice; take regular when only the ranked list matters and html only to check what the parser dropped,' including a quantitative size comparison (4.8 KB / 57 KB / 2.4 MB). However, no guidance is offered on when to use this tool versus sibling tools such as post_dataforseo_serp_gads_advertisers_live or the organic SERP endpoints.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_ai_mode_liveLive Google AI Mode SERPBDestructiveInspect
Google AI Mode SERP API provides search results from the AI Mode feature of Google Search.
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
B3.4/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint, destructiveHint, non-idempotent and non-read-only, so the safety profile is covered. The description adds useful billing context ($0.004 estimate, usage-based) but says nothing about latency, rate limits, or that calculate_rectangles doubles the charge (that detail 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.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short, front-loaded sentences that state purpose then cost. Efficient and free of padding, though leading zero-width characters are noise and the pricing block is boilerplate.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness5/5
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 explanation is unnecessary, and annotations cover the behavior profile. For a one-parameter batch-search endpoint with a richly documented body schema, purpose plus billing is a complete-enough frame.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool's single top-level 'body' parameter has no description here, and the description adds no parameter guidance. However, the nested request-object properties carry extremely detailed schema descriptions (keyword rules, location/language exclusivity, device defaults), so effective parameter semantics are strong even if the prose contributes nothing.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource: it returns search results from Google's AI Mode SERP feature. This distinguishes it from sibling SERP tools by naming the exact Google surface, though it never explicitly contrasts with nearby alternatives like post_dataforseo_serp_ai_summary or post_dataforseo_serp_google_organic_live.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no when-to-use context, no prerequisites, and no routing against the many other SERP/AI siblings. An agent is left to infer when AI Mode results are the right choice versus ai_summary or google_organic_live.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_ai_mode_live_htmlLive Google Ai Mode SERP HTMLBDestructiveInspect
Live SERP HTML provides a raw HTML page of 100 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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already carry the safety profile (destructiveHint=true, openWorldHint=true, readOnlyHint=false), so the bar is lower. The description adds genuinely useful context the annotations lack: the cost estimate (~$0.02 per request) and the output shape (raw HTML, 100 results). However it does not reconcile the read-like "fetch SERP" nature with the destructive annotation, and says nothing about auth or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The substantive sentence is front-loaded and wastes nothing; the pricing block is boilerplate but adds cost context. A leading zero-width character is cosmetic noise, and the block-comment packaging is slightly clunky, but the definition is tight overall.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 explanation is not required, and the description covers the headline output (raw HTML, 100 results) plus cost. What is missing for a one-parameter query tool with rich siblings is route guidance against the non-HTML variant and any note that keyword is effectively required despite the schema's empty required list.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
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. It names the three core fields (keyword, search engine, location) which maps onto keyword/language/location sub-fields, but it omits device, os, tag, and the language_code/language_name alternative, leaving those to the nested schema descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource ("provides a raw HTML page of 100 search engine results") and scopes the query inputs (keyword, search engine, location). It is clear about what the tool returns, but it never distinguishes itself from the structured-data sibling post_dataforseo_serp_google_ai_mode_live, leaving sibling selection to be inferred 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.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use the HTML variant versus the non-HTML post_dataforseo_serp_google_ai_mode_live sibling, nor any prerequisites or exclusions. The agent is told what the tool does but not when it is the right choice over the ~40 sibling SERP tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_autocomplete_liveLive Google Autocomplete AdvancedCDestructiveInspect
Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client.
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
C2.7/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnly=false, destructive=true, openWorld=true, idempotent=false), so the bar is lower. The description adds a useful cost disclosure ('Usage-based billing; Default request estimate: $0.02 USD') and notes that autocomplete output varies by client, but offers no auth, rate-limit, or response-shape context. Note the annotations label this data-retrieval tool as destructive/non-readOnly, which the description neither supports nor contradicts.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness3/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short, but its lead sentence is a generic definition of Google Autocomplete rather than a tool-specific action, and the injected pricing HTML comment breaks the flow. Some sentences do not earn their place relative to the tool's actual contract.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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. For a single-parameter, multi-field data-fetch tool the description covers the concept but omits usage conditions, parameter meaning, and any sibling disambiguation, leaving it only partially complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters2/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is 0%, so per the rules the description should compensate for parameter meaning, which it does not — it names no parameters. The nested body schema does carry detailed enum and format notes (client values, keyword encoding rules, cursor_pointer examples), but that value lives in the schema, not the description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose3/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description explains that Google Autocomplete completes typed searches and that the API returns suggestions, cursor pointer position, and search client, so the resource is identifiable. However, it reads as a general explainer of the autocomplete feature rather than a specific statement of what this tool does, and it never distinguishes itself from the many sibling SERP tools (google_organic_live, google_maps_live, etc.).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
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 alternatives named. The text describes the feature itself rather than the conditions under which an agent should pick this tool over another SERP or keyword-suggestion sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_dataset_info_liveLive Google Dataset Info AdvancedBDestructiveInspect
Live Google Dataset Info provides real-time data on the dataset you specify in the request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP.
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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The pricing block adds genuine behavioral context ($0.02 estimate, usage-based billing, settlement may differ) and the description describes the returned content. However, it never discloses that this is a live POST endpoint keyed on dataset_id, nor how that id is obtained, and there is noticeable tension between the 'provides real-time data' framing and annotations declaring destructiveHint=true / readOnlyHint=false.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Three short, front-loaded sentences that state the purpose before the pricing boilerplate. Minor noise from the stray zero-width character and the HTML-comment wrapper, but nothing that wastes an agent's attention.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 detail is not required, and cost is covered. Still missing for a live-fetch endpoint: how to acquire dataset_id, the relationship to the dataset_search sibling, and any indication that a POST body is the calling convention.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema description coverage is 0% and the description adds no parameter meaning at all (no mention of dataset_id, language_code, device, os, or tag). The nested schema properties do carry their own descriptions and an example, and dataset_id is flagged there as required despite an empty required array — a discrepancy the description could have resolved but does not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource: retrieves real-time data for a specified Google dataset, enumerating the payload (content, authors, licenses, description) and noting it is displayed separately from the SERP. It never names or contrasts with the obvious sibling post_dataforseo_serp_google_dataset_search_live, so an agent cannot tell which of the two dataset endpoints to pick from the text alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no prerequisites, no alternatives. The only usage-adjacent statement is 'the dataset you specify in the request,' which does not tell the agent under what conditions to choose this over dataset_search or any other SERP endpoint.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_dataset_search_liveLive Google Dataset Search AdvancedBDestructiveInspect
Live Google Dataset Search provides real-time data on the top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally.
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
B3.2/5.0
Behavior4/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations cover safety profile (destructiveHint=true, openWorldHint=true, non-idempotent), and the description adds useful behavioral context beyond them: real-time retrieval, a fixed result count (top 20), and usage-based billing with a ~$0.02 request estimate plus settlement caveats. It does not contradict the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The core purpose sentence is front-loaded and compact, and the billing note is clearly demarcated. The leading zero-width character is noise and the billing block is somewhat long, but overall it is efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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, but the description omits that 'keyword' is effectively required despite the empty required array, and gives no coverage of the many nested body parameters for a paid, non-idempotent call.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters2/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema description coverage is 0%, so the description must compensate yet only mentions 'top 20 results' and 'other parameters optionally.' It clarifies nothing about keyword, depth, topics, os/device, or language fields; the '20' loosely maps to the depth default but no syntax or enum guidance is added.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb+resource: real-time retrieval of top-20 Google Dataset Search results for a keyword. It is clear what the tool does, though it does not explicitly differentiate itself from the numerous sibling SERP tools (e.g., post_dataforseo_serp_google_dataset_info_live).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
Aside from 'You can specify other parameters optionally,' there is no guidance on when to use this versus alternatives such as google_dataset_info_live or google_organic_live, no prerequisites, and no exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_events_liveLive Google Events SERP AdvancedADestructiveInspect
Returns the events Google surfaces for a query on Google, synchronously. Returns keyword, type, se_domain, location_code, language_code, check_url, datetime, spell, refinement_chips, item_types, items_count and items. Measured at 57 KB for a ten-result Google query. ⚠️ Three result depths exist for the same query and differ by two orders of magnitude: regular measured 4.8 KB, advanced 57 KB, and html 2.4 MB. advanced is the default choice; take regular when only the ranked list matters and html only to check what the parser dropped. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200.
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 | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
A3.5/5.0
Behavior4/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations only declare generic flags (readOnlyHint=false, destructiveHint=true, openWorldHint=true), so the description carries the useful burden it does: the DataForSEO envelope layout (data in tasks[0].result, outcome in tasks[0].status_code), the critical fact that a rejected request still returns HTTP 200, and a per-request billing estimate. These are exactly the operational facts an agent needs and cannot get from the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with purpose, then the envelope and sizing caveat; each sentence carries information. It is on the long side and the pricing boilerplate plus the enumeration of return fields are partially redundant against the output schema, but nothing is outright filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness4/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so the return-field list is not strictly required, but the description adds the pieces it must: envelope shape, non-obvious HTTP 200 failure behavior, cost, and payload size tradeoffs. The gaps are the unaddressed input parameters and the depth instruction that has no corresponding schema control.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters2/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% and the description never explains the input fields (keyword, language_code, location_code, location_name, location_coordinate) nor that body is an array allowing multiple tasks. Worse, it instructs the agent to choose a result-depth mode ('take regular when...') that is not present in the schema, so the guidance cannot be acted on and may mislead.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: returns the events Google surfaces for a query, synchronously, and names the returned payload fields. The resource (Events SERP) is inherently distinct from siblings like google_news_live or google_organic_live, though no sibling is named explicitly to reinforce the distinction.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines3/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives real selection guidance for result depth (advanced is default, regular when only the ranked list matters, html only to inspect parser drops) and implies synchronous use vs task-based flows. However, that guidance refers to a depth control that does not appear anywhere in the input schema, and it never states when to call this tool instead of get_dataforseo_serp_google_events_locations or the other live SERP endpoints.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_finance_explore_liveLive Google Finance Explore AdvancedBDestructiveInspect
Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
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
B3/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds genuinely useful behavioral context beyond the annotations: real-time/live nature, location+language scoping, and an explicit billing disclosure (default ~$0.02, usage-based, not a fixed price, account-specific settlement). That is real value the annotations do not carry. However, it never explains the destructive/non-idempotent/readOnly=false annotation profile, so an agent gains no insight into why a SERP retrieval is flagged as destructive, nor any rate-limit or retry behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose is front-loaded in a single tight sentence, followed by a scoping sentence; nothing is wordy. The pricing block is boilerplate but short and clearly delimited, so it costs little.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The output schema exists, so return values need not be described, and the pricing note covers billing. What is missing is usage context (when to choose this over sibling finance endpoints) and any explanation of the unusual array-wrapped request body, which leaves the definition only minimally adequate for a tool with this many sibling endpoints.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters2/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema signal reports 0% description coverage at the top level, and the single required parameter 'body' is an array of objects whose shape is never explained in the description — an agent must open the schema to know whether to send one object or a list. The description only names location and language, omitting other meaningful fields such as news_type (which doubles the charge), device, os, and tag, so it does not compensate for the coverage gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific resource (the 'Explore' tab of Google Finance) and states that it returns real-time data, which is more than a restatement of the name. However, it does not distinguish this tool from closely named finance siblings such as post_dataforseo_serp_google_finance_markets_live, quote_live, or ticker_search_live, leaving the agent to 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.
Usage Guidelines2/5
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 when to prefer the _html sibling, and no indication of when an agent should pick Explore versus Markets/Quote/Ticker Search. The only contextual hint is that results depend on location and language, which is a scoping fact rather than usage direction.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_finance_explore_live_htmlLive Google Finance Explore SERP HTMLBDestructiveInspect
Live SERP HTML provides raw HTML page from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
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
B3.3/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, openWorldHint=true, so the safety profile is covered structurally. The description adds pricing context (usage-based, ~$0.02 estimate) but omits the live-task/POST semantics, latency, or rate-limit behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness3/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded and short, but begins with a stray zero-width character and is padded by an injected pricing comment block that isn't part of the tool's semantics.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists and annotations carry the safety profile, so the burden is reduced. Still, for a paid live endpoint the description leaves unclear what the raw HTML contains and how the single body parameter is structured.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema coverage is reported as 0% for the single 'body' parameter, so the schema does relatively little at the top level. The description compensates partially by naming location and language as the request-specific parameters but adds no format or interaction detail.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: it returns the raw HTML page from the 'Explore' tab of Google Finance. It distinguishes itself from the sibling post_dataforseo_serp_google_finance_explore_live by naming the HTML output, though it doesn't explicitly contrast with it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines3/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies use when raw HTML is wanted and notes results depend on the location and language parameters, but gives no explicit when-to-use versus the JSON sibling or when this is preferable over other SERP endpoints.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_finance_markets_liveLive Google Finance Markets AdvancedBDestructiveInspect
Live Google Finance Markets provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type.
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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, openWorldHint=true, and non-idempotent behavior, so the safety/mutation profile is covered. The description adds genuinely useful behavioral context in the form of usage-based billing with a $0.02 default estimate, which annotations do not convey, but it stays silent on auth requirements and the cost implications of the 'destructive' flag.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short, front-loaded sentences followed by an explicitly delimited pricing block. No filler; the only noise is the leading zero-width character and the boilerplate comment markers around the pricing note.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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. However, the description omits that the tool is a POST taking a JSON array body (relevant for invocation), and gives no guidance on the default market_type behavior or the existence of a _html sibling. Adequate but with clear gaps for a dataforseo SERP endpoint.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is reported as 0% by the context signal, so the description must carry weight; it names location, language, and market_type, but does not explain the code-vs-name union pattern (location_code/location_name, language_code/language_name) or that all fields are individually optional. It adds partial, not full, compensation for the coverage gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific resource and scope: real-time data from the 'Markets' tab of Google Finance, scoped by location, language, and market_type. An agent can distinguish it from finance_quote and finance_explore siblings by the 'Markets' tab anchor, though the description never names those alternatives to make the boundary explicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
It notes that results depend on the specified parameters, which is a scope statement rather than usage guidance. There is no indication of when to choose this over post_dataforseo_serp_google_finance_quote_live, finance_explore_live, or the _html variant, all of which are adjacent siblings with overlapping subject matter.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_finance_markets_live_htmlLive Google Finance Markets SERP HTMLBDestructiveInspect
Live SERP HTML provides raw HTML from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds genuinely useful behavioral context beyond the annotations: the output is unparsed raw HTML and the request is billed on usage (~$0.02 default estimate, account-specific). However, it does not reconcile its read-like nature ('provides raw HTML') with the annotations' destructiveHint=true / readOnlyHint=false, which is a notable unresolved gap for an agent deciding whether the call is safe and repeatable.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with the resource and scope, with no filler prose about returns. The embedded pricing marker block and a stray leading whitespace character add minor noise but the core text is tight.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 is not required, and pricing plus the HTML-vs-JSON distinction are covered. What is missing is routing guidance among the many sibling SERP endpoints and any note on the annotation mismatch, leaving an agent to infer which variant to pick.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description calls out location and language as the request-defining parameters, which maps to location_code/location_name and language_code/language_name. It adds nothing about market_type (the most consequential enum, defaulting to most-active), device, os, or tag, so compensation for the sparse top-level schema is only partial.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
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 returns raw HTML from the 'Markets' tab of Google Finance. The 'raw HTML' framing implicitly distinguishes it from the sibling post_dataforseo_serp_google_finance_markets_live (structured variant), but it never names that sibling explicitly, so differentiation relies on the reader comparing names in the list.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
It only states that results depend on the location and language parameters, which is a scoping fact rather than guidance. There is no when-to-use, no when-not-to-use, and no mention of choosing the HTML variant over the structured JSON sibling or vice versa.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_finance_quote_liveLive Google Finance Quote AdvancedBDestructiveInspect
Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
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
B3/5.0
Behavior1/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description frames the tool as a passive data retrieval ('provides real-time data', 'these results are specific to the parameters'), while the annotations declare readOnlyHint=false, destructiveHint=true and idempotentHint=false. Nothing in the description explains what makes the call destructive or non-idempotent, so an agent reading both is left with a direct conflict rather than usable behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded in the first sentence, followed by the parameter-scoping sentence and a clearly delimited pricing block. It is appropriately short with no filler, though the stray leading zero-width character and the raw HTML-comment pricing wrapper make it slightly noisy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 description covers what data is produced and roughly how it is priced. However, for a paid, open-world, externally-hitting call it omits prerequisites (credentials, any required location/language pairing) and any reconciliation of the destructive/idempotency annotations, leaving meaningful gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single top-level 'body' parameter has no schema description (reported coverage 0%), but the nested properties carry very detailed descriptions (keyword/ticker, window, device, language_code/name, location_code/name, tag). The description only restates that the ticker goes in the keyword field and that location/language matter, adding little beyond the nested schema text; it does not mention the required-field semantics of keyword or the doubled charge for non-1D windows.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the specific data source and scope: real-time data from the 'Quote' tab of Google Finance, driven by ticker (keyword), location and language. This distinguishes it from nearby siblings like google_finance_explore_live, google_finance_markets_live and google_finance_ticker_search_live by tab and parameter set, though none of those siblings are named explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines3/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: you call it with a ticker when you want a live quote for a specific listed security. There is no explicit when-to-use/when-not guidance and no routing between this tool and the finance siblings (quote_live_html, ticker_search, markets, explore), which all sound plausible for similar requests.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_finance_quote_live_htmlLive Google Finance Quote SERP HTMLBDestructiveInspect
Live SERP HTML provides raw HTML from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=true, openWorldHint=true, idempotentHint=false). The description adds genuinely useful context not in the annotations: the response is raw (unstructured) HTML and a per-request billing estimate of ~$0.02. It does not address auth, rate limits, or why a pure data fetch is flagged destructive, leaving a mild tension between the 'provides' framing and the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Two front-loaded sentences state the output and the parameter dependence with no wasted prose. The injected pricing comment block is boilerplate rather than useful scope information, a minor blemish on an otherwise tight description.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return structure needn't be explained, and the description does cover the output medium (raw HTML) and the key inputs. However, it omits any guidance on choosing this over the structured quote tool and leaves the required-parameter picture ambiguous (nested keyword reads as required while top-level required is empty).
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema coverage is 0% (the single 'body' array param is undocumented at that level), though nested fields carry descriptions. The description compensates partially by mapping the conceptual inputs the caller cares about — ticker to the 'keyword' field, plus location and language — which helps navigate the nested body. It says nothing about the remaining fields (window, device, os, tag).
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific action and resource: it 'provides raw HTML from the Quote tab of Google Finance.' The word 'HTML'/raw output implicitly differentiates it from the structured sibling (post_dataforseo_serp_google_finance_quote_live), but that sibling is never named or contrasted, so the agent must infer the split from the tool name. Clear purpose, weak explicit sibling differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
The second sentence only restates which request parameters shape the results ('ticker in the keyword field, location and language'). There is no indication of when to pick this HTML endpoint over the structured quote endpoint, no prerequisites, and no exclusions. Usage must be inferred 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.
post_dataforseo_serp_google_finance_ticker_search_liveLive Google Finance Ticker Search AdvancedCDestructiveInspect
Live Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language.
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
C2.7/5.0
Behavior1/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description frames this purely as a 'search' (read semantics), while annotations declare readOnlyHint=false and destructiveHint=true — a direct conflict on the read/write axis. The only extra behavioral fact it supplies is the usage-based billing estimate, which does not resolve the mutability contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness3/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Two functional sentences, reasonably front-loaded, but the payload is padded with a zero-width character and a boilerplate HTML-comment pricing block that occupies a third of the text. The core content itself is efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 billing is disclosed. However, for an open-world, credit-charging endpoint sitting among a dozen near-identical Google finance SERP siblings, the description lacks the routing and input-requirement detail an agent needs.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema coverage is 0% (the single 'body' array is undocumented), so the description must carry the load. It partially does by naming the semantic inputs keyword, location, and language, but omits category, tag, the required-pair rules for language/location, and the fact that keyword is required.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a clear verb+resource ('search for financial instruments available on Google Finance') and names the driving inputs (keyword, location, language). It stops short of differentiating from close siblings such as post_dataforseo_serp_google_finance_quote_live, _markets_live, or _explore_live, so an agent cannot tell from the text alone which finance endpoint it wants.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
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 statement of when ticker search beats the quote/markets/explore siblings, no prerequisites, and no exclusion criteria. The only routing-like sentence ('the result is specific to the parameters you specify') describes input sensitivity, not tool 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_google_images_liveLive Google Images SERPBDestructiveInspect
Live Google Images SERP provides real-time data on top 100 images 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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, openWorldHint=true, so the safety profile is covered by structured data. The description's real added value is the billing disclosure ($0.02 default estimate, usage-based, settlement may differ), a genuinely useful behavioral trait beyond the annotations; it stops short of describing latency or result-return behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
One core sentence front-loads the purpose, followed by a short bracketed pricing note. The HTML-comment-wrapped pricing block is boilerplate but informative and does not bury the main statement; nothing is padded or redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 pricing note covers cost. However, for a tool with an oddly strong destructiveHint and a desktop-only limitation, the description omits any usage framing or cautions, leaving it adequate but not fully rounded.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level coverage is 0% (the body array is undocumented), but the nested body properties carry very rich schema descriptions for keyword, language, location, depth, and billing multipliers. The description only loosely gestures at 'keyword, search engine, and location' and adds no syntax or constraint detail beyond the schema, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: provides real-time top-100 image results for a given keyword, search engine, and location. The 'Google Images' qualifier cleanly distinguishes it from the ~30 organic/news/maps/finance SERP siblings, though it does not differentiate from the near-identical post_dataforseo_serp_google_images_live_html variant.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, prerequisites, or alternatives are given. It never mentions the _html sibling or other image-oriented tools (e.g., google_search_by_image), nor when a live request is preferable to a queued/task-based flow, leaving selection to inference 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.
post_dataforseo_serp_google_images_live_htmlLive Google Images SERP HTMLBDestructiveInspect
Live SERP HTML provides a raw HTML page of 100 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
B3.4/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, openWorldHint=true and idempotentHint=false, so the safety profile is carried by structured data. The description's genuine additions are the 100-result scope and the billing estimate ($0.02, not fixed), which is useful cost context an agent should see before calling. It adds nothing about auth requirements or why a fetch 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.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
One front-loaded sentence that states scope, followed by a clearly delimited boilerplate pricing block. No wasted prose, though the pricing block is template text rather than tool-specific guidance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness5/5
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 nested input schema fully documents every field. Given that support, the description covers what an agent must know to call it: it returns raw HTML, and it costs money. The only omission is which SERP type this is, which is recoverable from the name.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level coverage is 0% because the single 'body' array parameter carries no description, but the nested object properties are documented exhaustively in the schema (keyword, depth, location_*, language_*, se_domain, search_param, max_crawl_pages). The description only names 'keyword, search engine, and location', roughly matching the key fields, and does not compensate for the undocumented array-wrapping shape. Schema does the heavy lifting, so baseline 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a concrete verb and resource: it returns a raw HTML page of search results for a keyword, search engine, and location. However, it never says this is the *Images* SERP specifically, which is the single fact that distinguishes it from the many sibling *_live_html tools (organic, news, local finder, finance). Clear purpose, but no sibling differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
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 prerequisites, and no pointer to the alternatives an agent should weigh — e.g. the structured-data sibling post_dataforseo_serp_google_images_live, which is presumably the right call when raw HTML is not needed. The only implied usage is 'if you want raw HTML'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_jobs_submitSetting Google Jobs TasksCDestructiveInspect
This endpoint will provide you with SERP data from the Google Jobs search engine. The returned results are specific to the keyword as well as the language and location parameters of the POST request.
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
C2.7/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, openWorldHint=true and idempotentHint=false, covering the safety profile. The description adds useful billing context ($0.02 estimate, account-specific variance), but omits the critical behavioral trait of an async submit endpoint: it enqueues a task and returns an identifier rather than the SERP data itself. With annotations covering safety, this partial disclosure earns 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.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short and front-loads the core statement about Google Jobs SERP data. The billing note is clearly demarcated and compact. There is a stray leading character and the content is thin, but there is no wasted prose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness2/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a task-submission endpoint in a family that includes fetch and live variants, and with an output schema present (so return values need not be explained), the definition still omits the essential async workflow and the submit-vs-fetch decision. It leaves an agent unable to call the tool correctly without external knowledge.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters2/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is reported at 0% for the single 'body' wrapper parameter. The description only vaguely references 'keyword', 'language' and 'location' parameters without adding format, defaults, or constraints. Although the nested item schema documents sub-fields richly, the description does not compensate for the top-level coverage gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose3/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the resource (Google Jobs SERP data) and ties results to keyword/language/location, so the general subject is identifiable. However, it never states that this is a task-submission endpoint whose results must be retrieved later (via get_dataforseo_serp_google_jobs_fetch), so it blurs the distinction from its fetch and live siblings. Purpose is recognizable but not sharply differentiated.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
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. It does not explain when to choose submit vs the fetch or live Google Jobs siblings, nor does it mention that a subsequent retrieval step is required. The only added context is a billing estimate, 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_google_local_finder_liveLive Google Local Finder SERPBDestructiveInspect
Live Google Local_finder SERP provides real-time search engine results for the specified keyword 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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint=true, idempotentHint=false, and destructiveHint=true, so the safety/behavior profile is largely structured. The description adds genuinely useful cost context (usage-based billing, ~$0.02 estimate, non-fixed price), which is behavioral value beyond the schema. It does not address the odd tension between a live retrieval tool and the destructive/non-readOnly annotations, but it does not explicitly assert read-only either, so this is a gap rather than a contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose sentence is front-loaded and concise, and the billing note is compact. Minor noise: leading zero-width characters and an HTML-comment pricing block add clutter without carrying agent-relevant content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 annotations carry the safety profile; the description therefore covers purpose plus cost. What remains missing is sibling differentiation against the many other SERP tools, which an agent needs to invoke the correct one.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is reported at 0% for the single body parameter, so nominally the description should compensate. It only vaguely references "keyword and location," adding no syntax, defaults, or constraints. Mitigating this, the nested body schema actually documents keyword, language_code, location_code, device, depth, and priority in rich detail, so the effective documentation burden is lighter than the 0% figure suggests.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ("provides real-time search engine results") scoped to keyword and location for the Google Local Finder SERP. Clear on its own, but does not differentiate it from close siblings such as post_dataforseo_serp_google_maps_live or post_dataforseo_serp_google_organic_live, so an agent cannot easily tell which local-SERP variant to pick.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description only restates the input scope ("for the specified keyword and location") and gives no when-to-use, when-not-to-use, or alternative guidance. With several overlapping SERP siblings in the toolset, the absence of routing guidance is a real gap.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_local_finder_live_htmlLive Google Local Finder SERP HTMLBDestructiveInspect
Live Google Local Finder SERP HTML provides a raw HTML page of the 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
B3.1/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare non-read-only, non-idempotent, open-world, and destructive behavior, so the description need not restate those traits. It adds useful billing context with the usage-based estimate, but it does not explain the destructive flag or what side effects a live call may have beyond cost.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness5/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The core sentence is front-loaded and compact, and the pricing note is short and relevant. There is no redundant explanation or filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the purpose and cost estimate, and the output schema handles return-value details. However, for a live billed SERP endpoint with a complex nested request body and 0% top-level schema coverage, it omits key invocation context such as body array structure and required parameter combinations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters2/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is reported at 0%, and the description only mentions keyword, search engine, and location without explaining the body array wrapper, device/os coupling, depth, filters, or required location/language alternatives. It adds little semantic guidance beyond what an agent can already see in the nested schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: it provides a raw HTML page of SERP results for a keyword, search engine, and location. The title and name make the Google Local Finder scope clear, and 'raw HTML' distinguishes it from non-HTML siblings, though no sibling is named explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no explicit when-to-use guidance, no exclusions, and no comparison with the non-HTML local finder endpoint or other SERP tools. An agent must infer that this is for raw HTML output rather than structured JSON.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_maps_liveLive Google Maps SERPBDestructiveInspect
Live Google Maps SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location.
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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=true, openWorldHint=true). The description adds genuinely useful context the annotations lack: usage-based billing with a $0.002 default request estimate and the caveat that settlement may differ. It does not explain auth needs or rate limits, and does not reconcile the surprising destructiveHint=true.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded one-sentence purpose followed by a compact pricing note. The HTML-comment pricing block is boilerplate but short and relevant to a billed API call; no wasted prose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 the schema documents the nested request fields thoroughly. What remains missing is usage routing against the many SERP siblings and any note on the surprising destructive annotation — adequate but with clear gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema coverage is 0% for the single 'body' param, but the nested field descriptions inside the schema are extremely rich (device, depth, location_code, search_places, etc.). The description adds only a high-level pointer (keyword, search engine, location) and no field-level syntax, so it neither compensates nor detracts.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb (provides real-time data) and resource (top 100 Google Maps SERP results) with scope bounded by keyword, search engine, and location. It distinguishes itself from the many other SERP siblings by naming Google Maps specifically, though it never names an alternative tool.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use or when-not-to-use guidance. With siblings like post_dataforseo_serp_google_local_finder_live and post_dataforseo_serp_google_organic_live in the list, the agent gets no help deciding which SERP endpoint fits a given intent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_news_liveLive Google News SERPCDestructiveInspect
Live Google News SERP provides real-time data on top 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
C2.9/5.0
Behavior2/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already carry the safety profile (readOnlyHint false, destructiveHint true, openWorldHint true, non-idempotent), and the description adds only a generic templated billing estimate ($0.02). It never addresses the confusing part of the annotations — it reads like a passive data-retrieval call but is flagged destructive/non-read-only, and the description does nothing to clarify what side effects or prerequisites actually exist. No auth, rate-limit, or rollback context is given.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
One front-loaded sentence states the purpose immediately, followed by a compact pricing block. There is little waste, though the injected pricing marker is boilerplate rather than tool-specific guidance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 nested schema documents the arguments. What is missing for a billing-charged live SERP endpoint is usage context — required credentials, cost multipliers (depth >10, calculate_rectangles), and how to choose it over sibling SERP tools.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single top-level 'body' parameter has no description (metric reports 0% coverage), and the description does not explain that the body is an array wrapping one object, which is a genuine invocation hazard. It does name keyword/search engine/location, which hints at the core fields, and the nested schema fields are documented richly, so the schema largely carries the load — a baseline 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific resource (Live Google News SERP results) and scope (real-time, for a keyword, search engine, and location), which is clear enough to distinguish it from a generic search tool. It does not, however, differentiate itself from the numerous SERP siblings (google_organic_live, bing_organic_live, google_maps_live, youtube_organic_live, google_autocomplete_live), so an agent must rely on the tool name alone to pick the right one.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit when-to-use or when-not-to-use guidance, and no alternative sibling is named. The closest thing to routing is the word 'News' in the title, which is not reinforced or contrasted with the other SERP endpoints in the description. Usage is only implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_news_live_htmlLive Google News SERP HTMLCDestructiveInspect
Live SERP HTML provides a raw HTML page of 10 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
C2.8/5.0
Behavior2/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint=true and, oddly, readOnlyHint=false / destructiveHint=true for what is described as a read-style HTML fetch; the description never addresses that tension. It adds only a templated pricing line ($0.02 estimate) and no operational behavior such as per-request billing multipliers, rate limits, or that the output is unparsed HTML.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
One front-loaded sentence stating scope plus a compact pricing note; nothing is padded. Minor flaw: a stray zero-width character and the hard-coded "10 results," which is misleading given depth defaults to 10 but can reach 200.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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 input schema documents nested properties richly. Still missing is what an agent needs to choose this tool correctly: its relationship to the JSON sibling, the fact that the payload is raw HTML requiring parsing, and any cost/idempotency caveats beyond the boilerplate pricing line.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters2/5
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 must carry the load, and it names only three inputs (keyword, search engine, location). It omits the required keyword field's 700-character limit, the language_code/language_name requirement, and the depth-based billing semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
Specific verb and resource: "provides a raw HTML page of 10 search engine results for the specified keyword, search engine, and location." An agent knows it fetches a Google News SERP. However it never differentiates itself from the sibling post_dataforseo_serp_google_news_live (the parsed/JSON variant), which is the one distinction that actually matters for selection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
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 non-HTML alternative it is paired with. The only context is the implied inputs, leaving the agent to guess why it would choose raw HTML over the structured sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_organic_liveLive Google Organic SERP AdvancedBDestructiveInspect
Live SERP provides real-time data on top 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. for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?bash'
Usage-based billing; Default request estimate: $0.0175 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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description surfaces the billing model (usage-based, default estimate $0.0175 per request), which is useful context that the annotations do not convey and partially explains the destructiveHint=true / readOnlyHint=false flags on what is otherwise a data-fetch call. It does not disclose rate limits, whether the call is synchronous 'live' versus queued, or that charges scale with depth/pages; with annotations present, the bar is lower, so this is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose is front-loaded in the first sentence, followed by one sentence on the advanced SERP extras, a docs link, and a short billing block. Nothing is bloated, though the boilerplate pricing block and the raw docs URL consume space without adding agent-facing value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
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, and annotations cover the safety profile, so the description is not obliged to do more there. The remaining gap is family-level routing: for a tool sitting among a dozen SERP siblings, the definition never says when this endpoint is the right pick, leaving the agent to infer from the name.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The reported schema description coverage is 0% at the top level (the single 'body' parameter carries no description), but the nested property schema itself documents each field (keyword, depth, location_code, stop_crawl_on_match, calculate_rectangles, etc.) in detail, so the parameters are documented somewhere. The description adds no parameter-level meaning of its own, neither syntax nor defaults, so it earns only the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a concrete verb and resource: it returns real-time top search engine results for a given keyword, engine and location, and calls out featured snippets plus other SERP extras. It is clear about what the tool does, but it never names Google specifically nor distinguishes itself from the many sibling SERP endpoints (bing_organic, youtube_organic, google_ai_mode, google_local_finder), so differentiation relies on 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.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance and no alternatives are named. An agent choosing between this and post_dataforseo_serp_bing_organic_live, post_dataforseo_serp_google_ai_mode_live, or the non-live/queued variants gets no routing signal from the description.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_organic_live_htmlLive Google Organic SERP HTMLBDestructiveInspect
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
B3.2/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare destructiveHint=true, readOnlyHint=false, openWorldHint=true and idempotentHint=false, so the safety profile is largely covered by structured data. The description adds genuinely useful behavioral context the annotations do not carry: usage-based billing and a ~$0.02 default request estimate. It does not explain why the call is flagged destructive (cost per SERP/page) or mention auth requirements, so it is additive but incomplete.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
One functional sentence, front-loaded, followed by a clearly delimited pricing block. Nearly every line earns its place, though the leading zero-width artifact is noise and the pricing boilerplate is not tool-specific.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness3/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-format explanation is unnecessary, and the pricing context is a real plus. However, for a ~20-parameter scraping endpoint that shares a name prefix with a JSON sibling, the description omits the HTML-vs-structured distinction and any cost-control framing around depth/max_crawl_pages, leaving the agent to reconstruct intent from the schema alone.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is 0% because the single 'body' wrapper is undocumented, but the nested properties carry extensive inline descriptions (depth/billing, match_type/match_value, crawl-control flags). The description names only keyword, search engine, and location, adding nothing beyond the most obvious inputs and failing to compensate for the wrapper gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: it returns a 'raw HTML page of search engine results' for a given keyword, search engine, and location. That is clear enough to distinguish it from most siblings, but it never explicitly contrasts with the non-HTML sibling post_dataforseo_serp_google_organic_live, so the agent must infer the difference between the raw-HTML and parsed variants.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
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 when this HTML variant is preferable to the structured JSON sibling, and no prerequisites. The only contextual cue is the billing note, which is about cost rather than 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_google_organic_live_regularLive Google Organic SERP RegularBDestructiveInspect
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.008 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
B3.1/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already flag openWorldHint=true, destructiveHint=true, and idempotentHint=false, and the description adds useful cost context ($0.008 estimate, usage-based billing) that the annotations do not carry. It does not explain that this is a live, per-request-billed, potentially amplified-charge operation, nor does it contradict the annotations — a 3 fits given annotations carry the safety profile.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness4/5
Is the description appropriately sized, front-loaded, and free of redundancy?
One front-loaded sentence stating the operation, followed by a compact machine-readable pricing block. Nothing is wasted, though the sentence largely restates the tool name and could have spent its words on sibling/cost guidance instead.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness2/5
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with ~20 nested options, several cost-multiplying parameters, and many near-identical siblings, the description is far too thin. It never mentions the required keyword/language/location combination or the crawl-control workflow, so an agent must reverse-engineer invocation entirely from the schema and example.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters3/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description names only three conceptual inputs (keyword, search engine, location), while the nested body schema carries extremely rich per-field documentation (depth, device, target, crawl controls). The description adds almost nothing beyond the schema, so it sits at the baseline for well-covered parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose4/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear operation — retrieving real-time Google organic SERP results for a keyword, search engine, and location — so an agent knows what the call produces. However, it never distinguishes this 'regular' variant from the near-identical siblings post_dataforseo_serp_google_organic_live and ..._live_html, which is the main ambiguity the agent faces.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no when-not-to-use, and no pointer to alternatives despite ~40 SERP siblings. It also omits that a keyword is the practical required input (the top-level schema lists no required fields), leaving the agent to infer the minimal viable call from the example only.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_serp_google_search_by_image_submitSetting Google Search By Image SERP TasksCDestructiveInspect
Google Search By Image SERP API provides up to top 100 search engine results based on the image you specified. 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
C2.9/5.0
Behavior3/5
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, openWorldHint=true, and idempotentHint=false, so the safety profile is covered. The description adds genuine value with the usage-based billing note ($0.02 default estimate, non-fixed), but omits the async task-creation behavior and the fact that flags like priority=2 or calculate_rectangles multiply the charge — cost-relevant behavior an agent should know before calling a destructive, billable endpoint. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Conciseness3/5
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short blocks: a product blurb that reads as copied DataForSEO marketing text, and a pricing comment block. Nothing is padded, but the first paragraph spends its only sentence describing the API catalogue entry rather than the tool's submit action, so it is front-loaded on the wrong information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Completeness2/5
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. But for a destructive, billable, non-idempotent task-submission endpoint with ~16 optional fields, the description omits the most decision-relevant fact — that this creates a task whose results must be fetched separately — leaving the agent's workflow understanding incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Parameters4/5
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level coverage is reported as 0% for the single 'body' parameter, but the nested item schema documents every field extensively (image_url marked required, the location_code/location_name/location_coordinate mutual exclusivity, language_code/language_name pairing, max_crawl_pages limits). The description only echoes 'the image you specified' plus location and language, adding little — the schema itself carries nearly all parameter semantics, which keeps this near the high-coverage baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Purpose3/5
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the resource and scope ('up to top 100 search engine results based on the image you specified', location/language-specific), so the domain is clear. However, it describes the DataForSEO product rather than this specific tool: it never states that this endpoint SUBMITS an asynchronous task, nor distinguishes itself from the sibling get_dataforseo_serp_google_search_by_image_fetch, which is the natural pairing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Usage Guidelines2/5
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 that this is the submission half of a submit/fetch workflow, no indication that results must be retrieved via the _fetch or _fetch_html siblings, and no exclusions. An agent reading only this would reasonably expect results in the response.
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
A4.5/5.0
Behavior4/5
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.
Conciseness4/5
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.
Completeness4/5
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.
Parameters4/5
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.
Purpose5/5
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.
Usage Guidelines5/5
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
C2.8/5.0
Behavior2/5
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.
Conciseness4/5
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.
Completeness2/5
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.
Parameters3/5
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.
Purpose2/5
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.
Usage Guidelines4/5
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.
26 tool updates
- Added
account - Removed
get_details - Changed
post_dataforseo_serp_google_ai_mode_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "what is google ai mode", - "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>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "boolean", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>required field if you don't specify <code>language_name</code>;<p>if you use this field, you don't need to specify <code>language_name</code>;<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/google/ai_mode/languages</code></p>", - "type": "string" - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p>required field if you don't specify <code>language_code</code>;<p>if you use this field, you don't need to specify <code>language_code</code>;<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/google/ai_mode/languages</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,18z</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>", - "type": "string" - }, - "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" - ] - }, - "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" - ] - } - }, - "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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "boolean", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>required field if you don't specify <code>language_name</code>;<p>if you use this field, you don't need to specify <code>language_name</code>;<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/google/ai_mode/languages</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>required field if you don't specify <code>language_code</code>;<p>if you use this field, you don't need to specify <code>language_code</code>;<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/google/ai_mode/languages</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,18z</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>", + "type": "string" + }, + "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" + ] + }, + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_ai_mode_live_html1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "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”;", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br>required field if you don't specify <code>language_name</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</code>n", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br>required field if you don't specify <code>language_code</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</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" - }, - "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" - ] - }, - "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": { + "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”;", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br>required field if you don't specify <code>language_name</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br>required field if you don't specify <code>language_code</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</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" + }, + "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" + ] + }, + "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_google_autocomplete_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "client": "gws-wiz-serp", - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "client": { - "description": "<p><em>search client for autocomplete</em><p>optional field<p>autocomplete results may differ depending on the search client;<p>possible values:<p><code>chrome</code> — used when google search is opened in google chrome;<p><code>chrome-omni</code> — used in the address bar in chrome;<p><code>gws-wiz</code> — used in google search home page;<p><code>gws-wiz-serp</code> — used in google search engine results page;<p><code>safari</code> — used when google search is opened in safari browser;<p><code>firefox</code> — used when google search is opened in firefox browser;<p><code>psy-ab</code> — may be used when google search is opened in google chrome browser;<p><code>toolbar</code> — returns XML;<p><code>youtube</code> — returns JSONP;<p><code>gws-wiz-local</code> — used in google local;<p><code>img</code> — used in google's image search;<p><code>products-cc</code> — used in google shopping search</p>", - "type": [ - "string", - "null" - ] - }, - "cursor_pointer": { - "description": "<p><em>search bar cursor pointer</em><p>optional field<p>the horizontal numerical position of the cursor pointer within the keyword in the search bar;<p>by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;<p>minimal value: <code>0</code><p>default value: the number of the last character of the specified <code>keyword</code><p>example:<p><code>|which query are s</code> - <code>\"cursor_pointer\": 0</code><p><code>which query is s|</code> - <code>\"cursor_pointer\": 16</code><p><code>which que|ry is s</code> - <code>\"cursor_pointer\": 9</code></p>", - "type": [ - "integer", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "client": { + "description": "<p><em>search client for autocomplete</em><p>optional field<p>autocomplete results may differ depending on the search client;<p>possible values:<p><code>chrome</code> — used when google search is opened in google chrome;<p><code>chrome-omni</code> — used in the address bar in chrome;<p><code>gws-wiz</code> — used in google search home page;<p><code>gws-wiz-serp</code> — used in google search engine results page;<p><code>safari</code> — used when google search is opened in safari browser;<p><code>firefox</code> — used when google search is opened in firefox browser;<p><code>psy-ab</code> — may be used when google search is opened in google chrome browser;<p><code>toolbar</code> — returns XML;<p><code>youtube</code> — returns JSONP;<p><code>gws-wiz-local</code> — used in google local;<p><code>img</code> — used in google's image search;<p><code>products-cc</code> — used in google shopping search</p>", + "type": [ + "string", + "null" + ] + }, + "cursor_pointer": { + "description": "<p><em>search bar cursor pointer</em><p>optional field<p>the horizontal numerical position of the cursor pointer within the keyword in the search bar;<p>by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;<p>minimal value: <code>0</code><p>default value: the number of the last character of the specified <code>keyword</code><p>example:<p><code>|which query are s</code> - <code>\"cursor_pointer\": 0</code><p><code>which query is s|</code> - <code>\"cursor_pointer\": 16</code><p><code>which que|ry is s</code> - <code>\"cursor_pointer\": 9</code></p>", + "type": [ + "integer", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_dataset_info_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "dataset_id": "L2cvMTFqbl85ZHN6MQ==" - } - ], - "properties": { - "dataset_id": { - "description": "<p><em>ID of the dataset</em><p><strong>required field</strong><p>you can find dataset ID in the dataset URL or <code>dataset</code> item of <a href=\"https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced\">Google Dataset Search</a> result<p>example:<p><code>L2cvMTFqbl85ZHN6MQ==</code></p>", - "type": "string" - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p>optional field<p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "dataset_id": { + "description": "<p><em>ID of the dataset</em><p><strong>required field</strong><p>you can find dataset ID in the dataset URL or <code>dataset</code> item of <a href=\"https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced\">Google Dataset Search</a> result<p>example:<p><code>L2cvMTFqbl85ZHN6MQ==</code></p>", + "type": "string" + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p>optional field<p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_dataset_search_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "file_formats": [ - "archive", - "image" - ], - "is_free": true, - "keyword": "water quality", - "last_updated": "1m", - "topics": [ - "natural_sciences", - "geo" - ], - "usage_rights": "noncommercial" - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>20</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "file_formats": { - "description": "<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "is_free": { - "description": "<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>", - "type": [ - "boolean", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>optional field if you don't specify <code>language_name</code><p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", - "type": [ - "string", - "null" - ] - }, - "last_updated": { - "description": "<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - }, - "topics": { - "description": "<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "usage_rights": { - "description": "<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</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>20</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "file_formats": { + "description": "<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "is_free": { + "description": "<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>", + "type": [ + "boolean", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>optional field if you don't specify <code>language_name</code><p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", + "type": [ + "string", + "null" + ] + }, + "last_updated": { + "description": "<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "topics": { + "description": "<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "usage_rights": { + "description": "<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_explore_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code></strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "news_type": { - "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code><p><strong>Note:</strong> if you specify <code>local_market</code> or <code>world_markets</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code></strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "news_type": { + "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code><p><strong>Note:</strong> if you specify <code>local_market</code> or <code>world_markets</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_explore_live_html1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "news_type": { - "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "news_type": { + "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_markets_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "market_type": { - "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "market_type": { + "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_markets_live_html1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "market_type": { - "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "market_type": { + "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_quote_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "CLW00:NYMEX", - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - }, - "window": { - "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code><p><strong>Note:</strong> if you specify a value that is different from <code>1D</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "window": { + "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code><p><strong>Note:</strong> if you specify a value that is different from <code>1D</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_quote_live_html1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "NASDAQ-100", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - }, - "window": { - "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "window": { + "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_ticker_search_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "category": "all", - "keyword": "DJ", - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "category": { - "description": "<p><em>category of financial instruments to search for</em><p>optional field<p>possible values: <code>all</code>, <code>stock</code>, <code>index</code>, <code>mutual_fund</code>, <code>currency</code>, <code>futures</code><p>default value: <code>all</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>company or financial instrument name</em><p><strong>required field</strong><p>in this field, you can enter the name of a company or financial instrument to search for relevant tickers;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "category": { + "description": "<p><em>category of financial instruments to search for</em><p>optional field<p>possible values: <code>all</code>, <code>stock</code>, <code>index</code>, <code>mutual_fund</code>, <code>currency</code>, <code>futures</code><p>default value: <code>all</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>company or financial instrument name</em><p><strong>required field</strong><p>in this field, you can enter the name of a company or financial instrument to search for relevant tickers;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_images_live1 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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>We choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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" - ] - }, - "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>We choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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" + ] + }, + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_images_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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", - "type": [ - "string", - "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_jobs_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": ".net developer", - "language_code": "en", - "location_code": 2840 - }, - { - "keyword": ".net developer", - "language_name": "English", - "location_name": "United States", - "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", - "tag": "some_string_123" - } - ], - "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "employment_type": { - "description": "<p><em>employment contract type</em><p>optional field<p>type of employment contract for which the search results will be returned;<p>possible values:<p><code>fulltime</code>, <code>partime</code>, <code>contractor</code>, <code>intern</code></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><strong>Note:</strong> the keyword you specify must indicate the job title;<p>example: <code>.net developer</code></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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "location_radius": { - "description": "<p><em>location search radius</em><p>optional field<p>location search radius in kilometers;<p><strong>Note:</strong> for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by <code>1.609</code>;<p>if value is not specified, search is executed anywhere within the specified location;<p>maximal value: <code>300</code><p>minimal value: <code>> 0</code></p>", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>", - "type": "string" - }, - "postback_url": { - "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page", - "type": [ - "integer", - "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" - ] - } - }, - "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "employment_type": { + "description": "<p><em>employment contract type</em><p>optional field<p>type of employment contract for which the search results will be returned;<p>possible values:<p><code>fulltime</code>, <code>partime</code>, <code>contractor</code>, <code>intern</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><strong>Note:</strong> the keyword you specify must indicate the job title;<p>example: <code>.net developer</code></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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "location_radius": { + "description": "<p><em>location search radius</em><p>optional field<p>location search radius in kilometers;<p><strong>Note:</strong> for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by <code>1.609</code>;<p>if value is not specified, search is executed anywhere within the specified location;<p>maximal value: <code>300</code><p>minimal value: <code>> 0</code></p>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>", + "type": "string" + }, + "postback_url": { + "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page", + "type": [ + "integer", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_local_finder_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "local nail services", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results respectively;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" - }, - "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" - ] - }, - "priority": { - "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results respectively;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" + }, + "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" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_local_finder_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<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", - "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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" - }, - "min_rating": { - "description": "<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>", - "type": [ - "string", - "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" - ] - }, - "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" - ] - }, - "time_filter": { - "description": "<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>\"open_now\"</code>, <code>\"24_hours\"</code>, <code>\"$day_value\"</code>, <code>\"$day_value;$time_value\"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>\"monday\"</code>, <code>\"tuesday\"</code>, <code>\"wednesday\"</code>, <code>\"thursday\"</code>, <code>\"friday\"</code>, <code>\"saturday\"</code>, <code>\"sunday\"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>\"00\"</code>, <code>\"01\"</code>, <code>\"02\"</code>, <code>\"03\"</code>, <code>\"04\"</code>, <code>\"05\"</code>, <code>\"06\"</code>, <code>\"07\"</code>, <code>\"08\"</code>, <code>\"09\"</code>, <code>\"10\"</code>, <code>\"11\"</code>, <code>\"12\"</code>, <code>\"13\"</code>, <code>\"14\"</code>, <code>\"15\"</code>, <code>\"16\"</code>, <code>\"17\"</code>, <code>\"18\"</code>, <code>\"19\"</code>, <code>\"20\"</code>, <code>\"21\"</code>, <code>\"22\"</code>, <code>\"23\"</code><p>example: <code class=\"long-string\">\"tuesday;18\"</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<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" + }, + "min_rating": { + "description": "<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>", + "type": [ + "string", + "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" + ] + }, + "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" + ] + }, + "time_filter": { + "description": "<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>\"open_now\"</code>, <code>\"24_hours\"</code>, <code>\"$day_value\"</code>, <code>\"$day_value;$time_value\"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>\"monday\"</code>, <code>\"tuesday\"</code>, <code>\"wednesday\"</code>, <code>\"thursday\"</code>, <code>\"friday\"</code>, <code>\"saturday\"</code>, <code>\"sunday\"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>\"00\"</code>, <code>\"01\"</code>, <code>\"02\"</code>, <code>\"03\"</code>, <code>\"04\"</code>, <code>\"05\"</code>, <code>\"06\"</code>, <code>\"07\"</code>, <code>\"08\"</code>, <code>\"09\"</code>, <code>\"10\"</code>, <code>\"11\"</code>, <code>\"12\"</code>, <code>\"13\"</code>, <code>\"14\"</code>, <code>\"15\"</code>, <code>\"16\"</code>, <code>\"17\"</code>, <code>\"18\"</code>, <code>\"19\"</code>, <code>\"20\"</code>, <code>\"21\"</code>, <code>\"22\"</code>, <code>\"23\"</code><p>example: <code class=\"long-string\">\"tuesday;18\"</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_maps_live1 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>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 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 100 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-maps-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><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>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/google/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/google/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/google/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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 3z<p>the maximum value for <em>\"zoom\"</em>: 21z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>", - "type": [ - "string", - "null" - ] - }, - "search_places": { - "description": "<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;</p><br><p>default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>", - "type": [ - "boolean", - "null" - ] - }, - "search_this_area": { - "description": "<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code></p><br><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off</p><br><p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>", - "type": [ - "boolean", - "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://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</code>.", - "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>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 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 100 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-maps-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><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>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/google/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/google/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/google/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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 3z<p>the maximum value for <em>\"zoom\"</em>: 21z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>", + "type": [ + "string", + "null" + ] + }, + "search_places": { + "description": "<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;</p><br><p>default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>", + "type": [ + "boolean", + "null" + ] + }, + "search_this_area": { + "description": "<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code></p><br><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off</p><br><p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>", + "type": [ + "boolean", + "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://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</code>.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_news_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keyword": "android", - "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", - "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">Get the list of available parameters and additional details here.</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">Get the list of available parameters and additional details here.</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_news_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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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 locations 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 locations 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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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" - ] - }, - "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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 locations 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 locations 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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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" + ] + }, + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_organic_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "calculate_rectangles": true, - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "browser_screen_height": { - "description": "browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_resolution_ratio": { - "description": "browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_width": { - "description": "browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", - "format": "int64", - "type": [ - "integer", - "null" - ] - }, - "calculate_rectangles": { - "description": "calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;\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": "parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your 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.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop", - "type": [ - "string", - "null" - ] - }, - "find_targets_in": { - "description": "SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:\"find_targets_in\": [\"organic\", \"featured_snippet\"]learn more about this parameter on our Help Center", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "group_organic_results": { - "description": "display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true", - "type": [ - "boolean", - "null" - ] - }, - "ignore_targets_in": { - "description": "SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:\"ignore_targets_in\": [\"paid\", \"images\"]learn more about this parameter on our Help Center", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "keyword": { - "description": "keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## 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”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn 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 codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou 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/google/languagesexample:en", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou 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/google/languagesexample:English", - "type": [ - "string", - "null" - ] - }, - "load_async_ai_overview": { - "description": "load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseif the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", - "type": [ - "boolean", - "null" - ] - }, - "location_code": { - "description": "search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou 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/google/locationsexample:2840", - "type": [ - "integer", - "null" - ] - }, - "location_coordinate": { - "description": "GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" formatthe maximum number of decimal digits for \"latitude\" and \"longitude\": 7the minimum value for \"radius\": 199 (mm)the maximum value for \"radius\": 199999 (mm)example:53.476225,-2.243572,200", - "type": [ - "string", - "null" - ] - }, - "location_name": { - "description": "full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou 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/google/locationsexample:London,England,United Kingdom", - "type": [ - "string", - "null" - ] - }, - "match_type": { - "description": "target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: \"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"", - "type": [ - "string", - "null" - ] - }, - "max_crawl_pages": { - "description": "page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android", - "type": [ - "string", - "null" - ] - }, - "people_also_ask_click_depth": { - "description": "clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", - "type": [ - "integer", - "null" - ] - }, - "remove_from_url": { - "description": "remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:\"remove_from_url\": [\"srsltid\"]Note: if the target field is specified, the specified URL parameters will be removed before the search", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "se_domain": { - "description": "search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "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": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string", - "type": [ - "string", - "null" - ] - }, - "target_search_mode": { - "description": "target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "browser_screen_height": { + "description": "browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_resolution_ratio": { + "description": "browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_width": { + "description": "browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "calculate_rectangles": { + "description": "calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;Note: provider usage may increase for using this parameter\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": "parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your 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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop", + "type": [ + "string", + "null" + ] + }, + "find_targets_in": { + "description": "SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:\"find_targets_in\": [\"organic\", \"featured_snippet\"]learn more about this parameter on our Help Center", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "group_organic_results": { + "description": "display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true", + "type": [ + "boolean", + "null" + ] + }, + "ignore_targets_in": { + "description": "SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:\"ignore_targets_in\": [\"paid\", \"images\"]learn more about this parameter on our Help Center", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "keyword": { + "description": "keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## 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”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn 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 codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou 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/google/languagesexample:en", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou 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/google/languagesexample:English", + "type": [ + "string", + "null" + ] + }, + "load_async_ai_overview": { + "description": "load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote: provider usage may increase for using this parameter;if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", + "type": [ + "boolean", + "null" + ] + }, + "location_code": { + "description": "search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou 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/google/locationsexample:2840", + "type": [ + "integer", + "null" + ] + }, + "location_coordinate": { + "description": "GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" formatthe maximum number of decimal digits for \"latitude\" and \"longitude\": 7the minimum value for \"radius\": 199 (mm)the maximum value for \"radius\": 199999 (mm)example:53.476225,-2.243572,200", + "type": [ + "string", + "null" + ] + }, + "location_name": { + "description": "full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou 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/google/locationsexample:London,England,United Kingdom", + "type": [ + "string", + "null" + ] + }, + "match_type": { + "description": "target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: \"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"", + "type": [ + "string", + "null" + ] + }, + "max_crawl_pages": { + "description": "page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android", + "type": [ + "string", + "null" + ] + }, + "people_also_ask_click_depth": { + "description": "clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", + "type": [ + "integer", + "null" + ] + }, + "remove_from_url": { + "description": "remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:\"remove_from_url\": [\"srsltid\"]Note: if the target field is specified, the specified URL parameters will be removed before the search", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "se_domain": { + "description": "search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "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": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string", + "type": [ + "string", + "null" + ] + }, + "target_search_mode": { + "description": "target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_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><strong>default value: <code>10</code></strong><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/google-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" - ] - }, - "expand_ai_overview": { - "description": "<p><em>expand ai overview</em><p>optional field<p>set to <code>true</code> to expand the <code>ai_overview</code> item;<p>default value: <code>false</code></p>", - "type": [ - "boolean", - "null" - ] - }, - "find_targets_in": { - "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "ignore_targets_in": { - "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", - "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/google/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/google/languages</code><p>example:<p><code class=\"long-string\">English</code></p>", - "type": "string" - }, - "load_async_ai_overview": { - "description": "<p><em>load asynchronous ai overview</em><p>optional field<p>set to <code>true</code> to obtain <code>ai_overview</code> items is SERPs even if they are loaded asynchronously;<p>if set to <code>false</code>, you will only obtain <code>ai_overview</code> items from cache;<p>default value: <code>false</code><p><strong><p>if the element is absent or contains <code>\"asynchronous_ai_overview\": false</code>, all extra charges will be returned to your account balance</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" - ] - }, - "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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "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_search_mode": { - "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "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><strong>default value: <code>10</code></strong><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/google-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" + ] + }, + "expand_ai_overview": { + "description": "<p><em>expand ai overview</em><p>optional field<p>set to <code>true</code> to expand the <code>ai_overview</code> item;<p>default value: <code>false</code></p>", + "type": [ + "boolean", + "null" + ] + }, + "find_targets_in": { + "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "ignore_targets_in": { + "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", + "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/google/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/google/languages</code><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "load_async_ai_overview": { + "description": "<p><em>load asynchronous ai overview</em><p>optional field<p>set to <code>true</code> to obtain <code>ai_overview</code> items is SERPs even if they are loaded asynchronously;<p>if set to <code>false</code>, you will only obtain <code>ai_overview</code> items from cache;<p>default value: <code>false</code><p><strong><p>if the element is absent or contains <code>\"asynchronous_ai_overview\": false</code>, all extra charges will be returned to your account balance</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" + ] + }, + "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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "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_search_mode": { + "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_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><strong>default value: <code>10</code></strong><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/google-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" - ] - }, - "find_targets_in": { - "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "group_organic_results": { - "description": "<p><em>display related results</em><p>optional field<p>if set to <code>true</code>, the <code>related_result</code> element in the response will be provided as a snippet of its parent organic result;<p>if set to <code>false</code>, the <code>related_result</code> element will be provided as a separate organic result;<p>default value: <code>true</code></p>", - "type": [ - "boolean", - "null" - ] - }, - "ignore_targets_in": { - "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", - "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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "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" - ] - }, - "target_search_mode": { - "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "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><strong>default value: <code>10</code></strong><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/google-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" + ] + }, + "find_targets_in": { + "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "group_organic_results": { + "description": "<p><em>display related results</em><p>optional field<p>if set to <code>true</code>, the <code>related_result</code> element in the response will be provided as a snippet of its parent organic result;<p>if set to <code>false</code>, the <code>related_result</code> element will be provided as a separate organic result;<p>default value: <code>true</code></p>", + "type": [ + "boolean", + "null" + ] + }, + "ignore_targets_in": { + "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", + "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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "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" + ] + }, + "target_search_mode": { + "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_search_by_image_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png", - "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "boolean", - "null" - ] - }, - "image_url": { - "description": "<p><em>URL of the image</em><p><strong>required field</strong><p>the results will be based on the image you specified in this field<p>example:<p><code class=\"long-string\">https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg</code></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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a></p>", - "type": [ - "integer", - "null" - ] - }, - "pingback_url": { - "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>", - "type": "string" - }, - "postback_url": { - "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-search-by-image-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", - "type": [ - "string", - "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" - ] - } - }, - "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "boolean", + "null" + ] + }, + "image_url": { + "description": "<p><em>URL of the image</em><p><strong>required field</strong><p>the results will be based on the image you specified in this field<p>example:<p><code class=\"long-string\">https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg</code></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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a></p>", + "type": [ + "integer", + "null" + ] + }, + "pingback_url": { + "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>", + "type": "string" + }, + "postback_url": { + "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-search-by-image-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
24 tool updates
- Changed
post_dataforseo_serp_google_ai_mode_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "what is google ai mode", - "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>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "boolean", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>required field if you don't specify <code>language_name</code>;<p>if you use this field, you don't need to specify <code>language_name</code>;<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/google/ai_mode/languages</code></p>", - "type": "string" - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p>required field if you don't specify <code>language_code</code>;<p>if you use this field, you don't need to specify <code>language_code</code>;<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/google/ai_mode/languages</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,18z</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>", - "type": "string" - }, - "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" - ] - }, - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "what is google ai mode", + "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>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "boolean", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>required field if you don't specify <code>language_name</code>;<p>if you use this field, you don't need to specify <code>language_name</code>;<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/google/ai_mode/languages</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>required field if you don't specify <code>language_code</code>;<p>if you use this field, you don't need to specify <code>language_code</code>;<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/google/ai_mode/languages</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,18z</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>", + "type": "string" + }, + "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" + ] + }, + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_ai_mode_live_html2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "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”;", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br>required field if you don't specify <code>language_name</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</code>n", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br>required field if you don't specify <code>language_code</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</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" - }, - "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" - ] - }, - "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": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "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”;", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br>required field if you don't specify <code>language_name</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br>required field if you don't specify <code>language_code</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</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" + }, + "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" + ] + }, + "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_google_autocomplete_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "client": "gws-wiz-serp", - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "client": { - "description": "<p><em>search client for autocomplete</em><p>optional field<p>autocomplete results may differ depending on the search client;<p>possible values:<p><code>chrome</code> — used when google search is opened in google chrome;<p><code>chrome-omni</code> — used in the address bar in chrome;<p><code>gws-wiz</code> — used in google search home page;<p><code>gws-wiz-serp</code> — used in google search engine results page;<p><code>safari</code> — used when google search is opened in safari browser;<p><code>firefox</code> — used when google search is opened in firefox browser;<p><code>psy-ab</code> — may be used when google search is opened in google chrome browser;<p><code>toolbar</code> — returns XML;<p><code>youtube</code> — returns JSONP;<p><code>gws-wiz-local</code> — used in google local;<p><code>img</code> — used in google's image search;<p><code>products-cc</code> — used in google shopping search</p>", - "type": [ - "string", - "null" - ] - }, - "cursor_pointer": { - "description": "<p><em>search bar cursor pointer</em><p>optional field<p>the horizontal numerical position of the cursor pointer within the keyword in the search bar;<p>by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;<p>minimal value: <code>0</code><p>default value: the number of the last character of the specified <code>keyword</code><p>example:<p><code>|which query are s</code> - <code>\"cursor_pointer\": 0</code><p><code>which query is s|</code> - <code>\"cursor_pointer\": 16</code><p><code>which que|ry is s</code> - <code>\"cursor_pointer\": 9</code></p>", - "type": [ - "integer", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "client": "gws-wiz-serp", + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "client": { + "description": "<p><em>search client for autocomplete</em><p>optional field<p>autocomplete results may differ depending on the search client;<p>possible values:<p><code>chrome</code> — used when google search is opened in google chrome;<p><code>chrome-omni</code> — used in the address bar in chrome;<p><code>gws-wiz</code> — used in google search home page;<p><code>gws-wiz-serp</code> — used in google search engine results page;<p><code>safari</code> — used when google search is opened in safari browser;<p><code>firefox</code> — used when google search is opened in firefox browser;<p><code>psy-ab</code> — may be used when google search is opened in google chrome browser;<p><code>toolbar</code> — returns XML;<p><code>youtube</code> — returns JSONP;<p><code>gws-wiz-local</code> — used in google local;<p><code>img</code> — used in google's image search;<p><code>products-cc</code> — used in google shopping search</p>", + "type": [ + "string", + "null" + ] + }, + "cursor_pointer": { + "description": "<p><em>search bar cursor pointer</em><p>optional field<p>the horizontal numerical position of the cursor pointer within the keyword in the search bar;<p>by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;<p>minimal value: <code>0</code><p>default value: the number of the last character of the specified <code>keyword</code><p>example:<p><code>|which query are s</code> - <code>\"cursor_pointer\": 0</code><p><code>which query is s|</code> - <code>\"cursor_pointer\": 16</code><p><code>which que|ry is s</code> - <code>\"cursor_pointer\": 9</code></p>", + "type": [ + "integer", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_dataset_info_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "dataset_id": "L2cvMTFqbl85ZHN6MQ==" - } - ], - "properties": { - "dataset_id": { - "description": "<p><em>ID of the dataset</em><p><strong>required field</strong><p>you can find dataset ID in the dataset URL or <code>dataset</code> item of <a href=\"https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced\">Google Dataset Search</a> result<p>example:<p><code>L2cvMTFqbl85ZHN6MQ==</code></p>", - "type": "string" - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p>optional field<p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "dataset_id": "L2cvMTFqbl85ZHN6MQ==" + } + ], + "properties": { + "dataset_id": { + "description": "<p><em>ID of the dataset</em><p><strong>required field</strong><p>you can find dataset ID in the dataset URL or <code>dataset</code> item of <a href=\"https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced\">Google Dataset Search</a> result<p>example:<p><code>L2cvMTFqbl85ZHN6MQ==</code></p>", + "type": "string" + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p>optional field<p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_dataset_search_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "file_formats": [ - "archive", - "image" - ], - "is_free": true, - "keyword": "water quality", - "last_updated": "1m", - "topics": [ - "natural_sciences", - "geo" - ], - "usage_rights": "noncommercial" - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>20</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "file_formats": { - "description": "<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "is_free": { - "description": "<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>", - "type": [ - "boolean", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>optional field if you don't specify <code>language_name</code><p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", - "type": [ - "string", - "null" - ] - }, - "last_updated": { - "description": "<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - }, - "topics": { - "description": "<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "usage_rights": { - "description": "<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "file_formats": [ + "archive", + "image" + ], + "is_free": true, + "keyword": "water quality", + "last_updated": "1m", + "topics": [ + "natural_sciences", + "geo" + ], + "usage_rights": "noncommercial" + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>20</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "file_formats": { + "description": "<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "is_free": { + "description": "<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>", + "type": [ + "boolean", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>optional field if you don't specify <code>language_name</code><p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", + "type": [ + "string", + "null" + ] + }, + "last_updated": { + "description": "<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "topics": { + "description": "<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "usage_rights": { + "description": "<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_explore_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code></strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "news_type": { - "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code><p><strong>Note:</strong> if you specify <code>local_market</code> or <code>world_markets</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code></strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "news_type": { + "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code><p><strong>Note:</strong> if you specify <code>local_market</code> or <code>world_markets</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_explore_live_html2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "news_type": { - "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "news_type": { + "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_markets_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "market_type": { - "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "market_type": { + "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_markets_live_html2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "market_type": { - "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "market_type": { + "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_quote_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "CLW00:NYMEX", - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - }, - "window": { - "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code><p><strong>Note:</strong> if you specify a value that is different from <code>1D</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "CLW00:NYMEX", + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "window": { + "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code><p><strong>Note:</strong> if you specify a value that is different from <code>1D</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_quote_live_html2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "NASDAQ-100", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - }, - "window": { - "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "NASDAQ-100", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "window": { + "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_finance_ticker_search_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "category": "all", - "keyword": "DJ", - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "category": { - "description": "<p><em>category of financial instruments to search for</em><p>optional field<p>possible values: <code>all</code>, <code>stock</code>, <code>index</code>, <code>mutual_fund</code>, <code>currency</code>, <code>futures</code><p>default value: <code>all</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>company or financial instrument name</em><p><strong>required field</strong><p>in this field, you can enter the name of a company or financial instrument to search for relevant tickers;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "category": "all", + "keyword": "DJ", + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "category": { + "description": "<p><em>category of financial instruments to search for</em><p>optional field<p>possible values: <code>all</code>, <code>stock</code>, <code>index</code>, <code>mutual_fund</code>, <code>currency</code>, <code>futures</code><p>default value: <code>all</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>company or financial instrument name</em><p><strong>required field</strong><p>in this field, you can enter the name of a company or financial instrument to search for relevant tickers;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_images_live2 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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>We choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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" - ] - }, - "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>We choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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" + ] + }, + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_images_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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", - "type": [ - "string", - "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_jobs_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": ".net developer", - "language_code": "en", - "location_code": 2840 - }, - { - "keyword": ".net developer", - "language_name": "English", - "location_name": "United States", - "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", - "tag": "some_string_123" - } - ], - "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "employment_type": { - "description": "<p><em>employment contract type</em><p>optional field<p>type of employment contract for which the search results will be returned;<p>possible values:<p><code>fulltime</code>, <code>partime</code>, <code>contractor</code>, <code>intern</code></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><strong>Note:</strong> the keyword you specify must indicate the job title;<p>example: <code>.net developer</code></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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "location_radius": { - "description": "<p><em>location search radius</em><p>optional field<p>location search radius in kilometers;<p><strong>Note:</strong> for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by <code>1.609</code>;<p>if value is not specified, search is executed anywhere within the specified location;<p>maximal value: <code>300</code><p>minimal value: <code>> 0</code></p>", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>", - "type": "string" - }, - "postback_url": { - "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page", - "type": [ - "integer", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": ".net developer", + "language_code": "en", + "location_code": 2840 + }, + { + "keyword": ".net developer", + "language_name": "English", + "location_name": "United States", + "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", + "tag": "some_string_123" + } + ], + "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "employment_type": { + "description": "<p><em>employment contract type</em><p>optional field<p>type of employment contract for which the search results will be returned;<p>possible values:<p><code>fulltime</code>, <code>partime</code>, <code>contractor</code>, <code>intern</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><strong>Note:</strong> the keyword you specify must indicate the job title;<p>example: <code>.net developer</code></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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "location_radius": { + "description": "<p><em>location search radius</em><p>optional field<p>location search radius in kilometers;<p><strong>Note:</strong> for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by <code>1.609</code>;<p>if value is not specified, search is executed anywhere within the specified location;<p>maximal value: <code>300</code><p>minimal value: <code>> 0</code></p>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>", + "type": "string" + }, + "postback_url": { + "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page", + "type": [ + "integer", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_local_finder_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "local nail services", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results respectively;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" - }, - "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" - ] - }, - "priority": { - "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "local nail services", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results respectively;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" + }, + "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" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_local_finder_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<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", - "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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" - }, - "min_rating": { - "description": "<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>", - "type": [ - "string", - "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" - ] - }, - "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" - ] - }, - "time_filter": { - "description": "<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>\"open_now\"</code>, <code>\"24_hours\"</code>, <code>\"$day_value\"</code>, <code>\"$day_value;$time_value\"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>\"monday\"</code>, <code>\"tuesday\"</code>, <code>\"wednesday\"</code>, <code>\"thursday\"</code>, <code>\"friday\"</code>, <code>\"saturday\"</code>, <code>\"sunday\"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>\"00\"</code>, <code>\"01\"</code>, <code>\"02\"</code>, <code>\"03\"</code>, <code>\"04\"</code>, <code>\"05\"</code>, <code>\"06\"</code>, <code>\"07\"</code>, <code>\"08\"</code>, <code>\"09\"</code>, <code>\"10\"</code>, <code>\"11\"</code>, <code>\"12\"</code>, <code>\"13\"</code>, <code>\"14\"</code>, <code>\"15\"</code>, <code>\"16\"</code>, <code>\"17\"</code>, <code>\"18\"</code>, <code>\"19\"</code>, <code>\"20\"</code>, <code>\"21\"</code>, <code>\"22\"</code>, <code>\"23\"</code><p>example: <code class=\"long-string\">\"tuesday;18\"</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<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" + }, + "min_rating": { + "description": "<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>", + "type": [ + "string", + "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" + ] + }, + "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" + ] + }, + "time_filter": { + "description": "<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>\"open_now\"</code>, <code>\"24_hours\"</code>, <code>\"$day_value\"</code>, <code>\"$day_value;$time_value\"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>\"monday\"</code>, <code>\"tuesday\"</code>, <code>\"wednesday\"</code>, <code>\"thursday\"</code>, <code>\"friday\"</code>, <code>\"saturday\"</code>, <code>\"sunday\"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>\"00\"</code>, <code>\"01\"</code>, <code>\"02\"</code>, <code>\"03\"</code>, <code>\"04\"</code>, <code>\"05\"</code>, <code>\"06\"</code>, <code>\"07\"</code>, <code>\"08\"</code>, <code>\"09\"</code>, <code>\"10\"</code>, <code>\"11\"</code>, <code>\"12\"</code>, <code>\"13\"</code>, <code>\"14\"</code>, <code>\"15\"</code>, <code>\"16\"</code>, <code>\"17\"</code>, <code>\"18\"</code>, <code>\"19\"</code>, <code>\"20\"</code>, <code>\"21\"</code>, <code>\"22\"</code>, <code>\"23\"</code><p>example: <code class=\"long-string\">\"tuesday;18\"</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_maps_live2 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>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 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 100 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-maps-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><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>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/google/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/google/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/google/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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 3z<p>the maximum value for <em>\"zoom\"</em>: 21z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>", - "type": [ - "string", - "null" - ] - }, - "search_places": { - "description": "<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;</p><br><p>default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>", - "type": [ - "boolean", - "null" - ] - }, - "search_this_area": { - "description": "<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code></p><br><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off</p><br><p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>", - "type": [ - "boolean", - "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://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</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": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 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 100 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-maps-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><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>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/google/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/google/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/google/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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 3z<p>the maximum value for <em>\"zoom\"</em>: 21z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>", + "type": [ + "string", + "null" + ] + }, + "search_places": { + "description": "<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;</p><br><p>default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>", + "type": [ + "boolean", + "null" + ] + }, + "search_this_area": { + "description": "<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code></p><br><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off</p><br><p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>", + "type": [ + "boolean", + "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://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</code>.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_news_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "android", - "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", - "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">Get the list of available parameters and additional details here.</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "android", + "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">Get the list of available parameters and additional details here.</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_news_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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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 locations 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 locations 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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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" - ] - }, - "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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 locations 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 locations 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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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" + ] + }, + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_organic_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "calculate_rectangles": true, - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "browser_screen_height": { - "description": "browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_resolution_ratio": { - "description": "browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_width": { - "description": "browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", - "format": "int64", - "type": [ - "integer", - "null" - ] - }, - "calculate_rectangles": { - "description": "calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;\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": "parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your 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.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop", - "type": [ - "string", - "null" - ] - }, - "find_targets_in": { - "description": "SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:\"find_targets_in\": [\"organic\", \"featured_snippet\"]learn more about this parameter on our Help Center", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "group_organic_results": { - "description": "display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true", - "type": [ - "boolean", - "null" - ] - }, - "ignore_targets_in": { - "description": "SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:\"ignore_targets_in\": [\"paid\", \"images\"]learn more about this parameter on our Help Center", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "keyword": { - "description": "keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## 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”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn 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 codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou 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/google/languagesexample:en", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou 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/google/languagesexample:English", - "type": [ - "string", - "null" - ] - }, - "load_async_ai_overview": { - "description": "load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseif the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", - "type": [ - "boolean", - "null" - ] - }, - "location_code": { - "description": "search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou 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/google/locationsexample:2840", - "type": [ - "integer", - "null" - ] - }, - "location_coordinate": { - "description": "GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" formatthe maximum number of decimal digits for \"latitude\" and \"longitude\": 7the minimum value for \"radius\": 199 (mm)the maximum value for \"radius\": 199999 (mm)example:53.476225,-2.243572,200", - "type": [ - "string", - "null" - ] - }, - "location_name": { - "description": "full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou 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/google/locationsexample:London,England,United Kingdom", - "type": [ - "string", - "null" - ] - }, - "match_type": { - "description": "target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: \"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"", - "type": [ - "string", - "null" - ] - }, - "max_crawl_pages": { - "description": "page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android", - "type": [ - "string", - "null" - ] - }, - "people_also_ask_click_depth": { - "description": "clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", - "type": [ - "integer", - "null" - ] - }, - "remove_from_url": { - "description": "remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:\"remove_from_url\": [\"srsltid\"]Note: if the target field is specified, the specified URL parameters will be removed before the search", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "se_domain": { - "description": "search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "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": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string", - "type": [ - "string", - "null" - ] - }, - "target_search_mode": { - "description": "target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "calculate_rectangles": true, + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "browser_screen_height": { + "description": "browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_resolution_ratio": { + "description": "browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_width": { + "description": "browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "calculate_rectangles": { + "description": "calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;\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": "parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your 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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop", + "type": [ + "string", + "null" + ] + }, + "find_targets_in": { + "description": "SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:\"find_targets_in\": [\"organic\", \"featured_snippet\"]learn more about this parameter on our Help Center", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "group_organic_results": { + "description": "display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true", + "type": [ + "boolean", + "null" + ] + }, + "ignore_targets_in": { + "description": "SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:\"ignore_targets_in\": [\"paid\", \"images\"]learn more about this parameter on our Help Center", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "keyword": { + "description": "keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## 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”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn 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 codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou 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/google/languagesexample:en", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou 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/google/languagesexample:English", + "type": [ + "string", + "null" + ] + }, + "load_async_ai_overview": { + "description": "load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseif the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", + "type": [ + "boolean", + "null" + ] + }, + "location_code": { + "description": "search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou 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/google/locationsexample:2840", + "type": [ + "integer", + "null" + ] + }, + "location_coordinate": { + "description": "GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" formatthe maximum number of decimal digits for \"latitude\" and \"longitude\": 7the minimum value for \"radius\": 199 (mm)the maximum value for \"radius\": 199999 (mm)example:53.476225,-2.243572,200", + "type": [ + "string", + "null" + ] + }, + "location_name": { + "description": "full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou 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/google/locationsexample:London,England,United Kingdom", + "type": [ + "string", + "null" + ] + }, + "match_type": { + "description": "target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: \"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"", + "type": [ + "string", + "null" + ] + }, + "max_crawl_pages": { + "description": "page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android", + "type": [ + "string", + "null" + ] + }, + "people_also_ask_click_depth": { + "description": "clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", + "type": [ + "integer", + "null" + ] + }, + "remove_from_url": { + "description": "remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:\"remove_from_url\": [\"srsltid\"]Note: if the target field is specified, the specified URL parameters will be removed before the search", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "se_domain": { + "description": "search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "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": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string", + "type": [ + "string", + "null" + ] + }, + "target_search_mode": { + "description": "target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_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><strong>default value: <code>10</code></strong><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/google-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" - ] - }, - "expand_ai_overview": { - "description": "<p><em>expand ai overview</em><p>optional field<p>set to <code>true</code> to expand the <code>ai_overview</code> item;<p>default value: <code>false</code></p>", - "type": [ - "boolean", - "null" - ] - }, - "find_targets_in": { - "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "ignore_targets_in": { - "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", - "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/google/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/google/languages</code><p>example:<p><code class=\"long-string\">English</code></p>", - "type": "string" - }, - "load_async_ai_overview": { - "description": "<p><em>load asynchronous ai overview</em><p>optional field<p>set to <code>true</code> to obtain <code>ai_overview</code> items is SERPs even if they are loaded asynchronously;<p>if set to <code>false</code>, you will only obtain <code>ai_overview</code> items from cache;<p>default value: <code>false</code><p><strong><p>if the element is absent or contains <code>\"asynchronous_ai_overview\": false</code>, all extra charges will be returned to your account balance</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" - ] - }, - "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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "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_search_mode": { - "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</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": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p><strong>default value: <code>10</code></strong><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/google-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" + ] + }, + "expand_ai_overview": { + "description": "<p><em>expand ai overview</em><p>optional field<p>set to <code>true</code> to expand the <code>ai_overview</code> item;<p>default value: <code>false</code></p>", + "type": [ + "boolean", + "null" + ] + }, + "find_targets_in": { + "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "ignore_targets_in": { + "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", + "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/google/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/google/languages</code><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "load_async_ai_overview": { + "description": "<p><em>load asynchronous ai overview</em><p>optional field<p>set to <code>true</code> to obtain <code>ai_overview</code> items is SERPs even if they are loaded asynchronously;<p>if set to <code>false</code>, you will only obtain <code>ai_overview</code> items from cache;<p>default value: <code>false</code><p><strong><p>if the element is absent or contains <code>\"asynchronous_ai_overview\": false</code>, all extra charges will be returned to your account balance</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" + ] + }, + "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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "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_search_mode": { + "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_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><strong>default value: <code>10</code></strong><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/google-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" - ] - }, - "find_targets_in": { - "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "group_organic_results": { - "description": "<p><em>display related results</em><p>optional field<p>if set to <code>true</code>, the <code>related_result</code> element in the response will be provided as a snippet of its parent organic result;<p>if set to <code>false</code>, the <code>related_result</code> element will be provided as a separate organic result;<p>default value: <code>true</code></p>", - "type": [ - "boolean", - "null" - ] - }, - "ignore_targets_in": { - "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", - "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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "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" - ] - }, - "target_search_mode": { - "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</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": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p><strong>default value: <code>10</code></strong><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/google-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" + ] + }, + "find_targets_in": { + "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "group_organic_results": { + "description": "<p><em>display related results</em><p>optional field<p>if set to <code>true</code>, the <code>related_result</code> element in the response will be provided as a snippet of its parent organic result;<p>if set to <code>false</code>, the <code>related_result</code> element will be provided as a separate organic result;<p>default value: <code>true</code></p>", + "type": [ + "boolean", + "null" + ] + }, + "ignore_targets_in": { + "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", + "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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "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" + ] + }, + "target_search_mode": { + "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_serp_google_search_by_image_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png", - "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "boolean", - "null" - ] - }, - "image_url": { - "description": "<p><em>URL of the image</em><p><strong>required field</strong><p>the results will be based on the image you specified in this field<p>example:<p><code class=\"long-string\">https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg</code></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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a></p>", - "type": [ - "integer", - "null" - ] - }, - "pingback_url": { - "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>", - "type": "string" - }, - "postback_url": { - "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-search-by-image-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png", + "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "boolean", + "null" + ] + }, + "image_url": { + "description": "<p><em>URL of the image</em><p><strong>required field</strong><p>the results will be based on the image you specified in this field<p>example:<p><code class=\"long-string\">https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg</code></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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a></p>", + "type": [ + "integer", + "null" + ] + }, + "pingback_url": { + "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>", + "type": "string" + }, + "postback_url": { + "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-search-by-image-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +]
38 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_gads_advertisers_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_gads_search_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_google_ai_mode_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_google_jobs_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_google_jobs_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_google_search_by_image_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_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
get_semrush_organic_results4 fields changed- removed
Input schema / properties / database / defaultRemoved value: -"us" - removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code. Defaults to `us`." - removed
Input schema / properties / phrase / descriptionRemoved value: -"Keyword phrase. URL-encode spaces as `%20` or `+`." - removed
Input schema / properties / phrase / exampleRemoved value: -"seo tools"
- Changed
get_semrush_paid_results4 fields changed- removed
Input schema / properties / database / defaultRemoved value: -"us" - removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code. Defaults to `us`." - removed
Input schema / properties / phrase / descriptionRemoved value: -"Keyword phrase. URL-encode spaces as `%20` or `+`." - removed
Input schema / properties / phrase / exampleRemoved value: -"seo tools"
- Changed
post_dataforseo_serp_google_ai_mode_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "what is google ai mode", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "what is google ai mode", + "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>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "boolean", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>required field if you don't specify <code>language_name</code>;<p>if you use this field, you don't need to specify <code>language_name</code>;<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/google/ai_mode/languages</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>required field if you don't specify <code>language_code</code>;<p>if you use this field, you don't need to specify <code>language_code</code>;<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/google/ai_mode/languages</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,18z</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>", + "type": "string" + }, + "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" + ] + }, + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "browser_screen_height": { - "description": "browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1080 for desktop; 640 for mobile on android; 812 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true", - "type": "integer" - }, - "browser_screen_resolution_ratio": { - "description": "browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: 0.5-3; by default, the parameter is set to: 1 for desktop; 3 for mobile on android; 3 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true", - "type": "number" - }, - "browser_screen_width": { - "description": "browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1920 for desktop; 360 for mobile on android; 375 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true", - "type": "integer" - }, - "calculate_rectangles": { - "description": "calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false Note: if set to true, the charge per task will be multiplied by 2", - "type": "boolean" - }, - "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; 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/google/ai_mode/languages", - "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/google/ai_mode/languages;", - "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 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/google/locations Note: check Google Search Help for the list of countries where AI Mode is currently available", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,18z", - "type": "string" - }, - "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 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/google/locations Note: check Google Search Help for the list of countries where AI Mode is currently available", - "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_google_ai_mode_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": { + "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”;", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br>required field if you don't specify <code>language_name</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br>required field if you don't specify <code>language_code</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</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" + }, + "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" + ] + }, + "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: -{ - "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”;", - "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/google/ai_mode/languagesn", - "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/google/ai_mode/languages;", - "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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200n", - "type": "string" - }, - "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 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", - "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_google_autocomplete_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "client": "gws-wiz-serp", + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "client": "gws-wiz-serp", + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "client": { + "description": "<p><em>search client for autocomplete</em><p>optional field<p>autocomplete results may differ depending on the search client;<p>possible values:<p><code>chrome</code> — used when google search is opened in google chrome;<p><code>chrome-omni</code> — used in the address bar in chrome;<p><code>gws-wiz</code> — used in google search home page;<p><code>gws-wiz-serp</code> — used in google search engine results page;<p><code>safari</code> — used when google search is opened in safari browser;<p><code>firefox</code> — used when google search is opened in firefox browser;<p><code>psy-ab</code> — may be used when google search is opened in google chrome browser;<p><code>toolbar</code> — returns XML;<p><code>youtube</code> — returns JSONP;<p><code>gws-wiz-local</code> — used in google local;<p><code>img</code> — used in google's image search;<p><code>products-cc</code> — used in google shopping search</p>", + "type": [ + "string", + "null" + ] + }, + "cursor_pointer": { + "description": "<p><em>search bar cursor pointer</em><p>optional field<p>the horizontal numerical position of the cursor pointer within the keyword in the search bar;<p>by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;<p>minimal value: <code>0</code><p>default value: the number of the last character of the specified <code>keyword</code><p>example:<p><code>|which query are s</code> - <code>\"cursor_pointer\": 0</code><p><code>which query is s|</code> - <code>\"cursor_pointer\": 16</code><p><code>which que|ry is s</code> - <code>\"cursor_pointer\": 9</code></p>", + "type": [ + "integer", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "client": { - "description": "search client for autocomplete optional field autocomplete results may differ depending on the search client; possible values: chrome — used when google search is opened in google chrome; chrome-omni — used in the address bar in chrome; gws-wiz — used in google search home page; gws-wiz-serp — used in google search engine results page; safari — used when google search is opened in safari browser; firefox — used when google search is opened in firefox browser; psy-ab — may be used when google search is opened in google chrome browser; toolbar — returns XML; youtube — returns JSONP; gws-wiz-local — used in google local; img — used in google's image search; products-cc — used in google shopping search", - "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; 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/google/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 https://api.dataforseo.com/v3/serp/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don't 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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/autocomplete/locations example: London,England,United Kingdom", - "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_google_dataset_info_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "dataset_id": "L2cvMTFqbl85ZHN6MQ==" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "dataset_id": "L2cvMTFqbl85ZHN6MQ==" + } + ], + "properties": { + "dataset_id": { + "description": "<p><em>ID of the dataset</em><p><strong>required field</strong><p>you can find dataset ID in the dataset URL or <code>dataset</code> item of <a href=\"https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced\">Google Dataset Search</a> result<p>example:<p><code>L2cvMTFqbl85ZHN6MQ==</code></p>", + "type": "string" + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p>optional field<p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "dataset_id": { - "description": "ID of the dataset required field you can find dataset ID in the dataset URL or dataset item of Google Dataset Search result example: L2cvMTFqbl85ZHN6MQ==", - "type": "string" - }, - "device": { - "description": "device type optional field return results for a specific device type possible value: desktop", - "type": "string" - }, - "language_code": { - "description": "search engine language code optional field if you use this field, you don't need to specify language_name possible value: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language optional field if you use this field, you don't need to specify language_code possible value: English", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "dataset_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_google_dataset_search_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "file_formats": [ + "archive", + "image" + ], + "is_free": true, + "keyword": "water quality", + "last_updated": "1m", + "topics": [ + "natural_sciences", + "geo" + ], + "usage_rights": "noncommercial" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "file_formats": [ + "archive", + "image" + ], + "is_free": true, + "keyword": "water quality", + "last_updated": "1m", + "topics": [ + "natural_sciences", + "geo" + ], + "usage_rights": "noncommercial" + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>20</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "file_formats": { + "description": "<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "is_free": { + "description": "<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>", + "type": [ + "boolean", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>optional field if you don't specify <code>language_name</code><p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", + "type": [ + "string", + "null" + ] + }, + "last_updated": { + "description": "<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "topics": { + "description": "<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "usage_rights": { + "description": "<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "file_formats": { - "description": "file formats of the dataset optional field possible values: other, archive, text, image, document, tabular", - "items": { - "type": "string" - }, - "type": "array" - }, - "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 optional field if you don't specify language_name if you use this field, you don't need to specify language_name possible value: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language optional field if you use this field, you don't need to specify language_code possible value: English", - "type": "string" - }, - "last_updated": { - "description": "last time the dataset was updated optional field possible values: 1m, 1y, 3y", - "type": "string" - }, - "os": { - "description": "device operating system optional field choose from the following values: windows, macos default value: windows", - "type": "string" - }, - "usage_rights": { - "description": "usage rights of the dataset optional field possible values: commercial, noncommercial", - "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_google_finance_explore_live5 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_name": "English", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code></strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "news_type": { + "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code><p><strong>Note:</strong> if you specify <code>local_market</code> or <code>world_markets</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field return results for a specific device type possible 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_google_finance_explore_live_html5 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "news_type": { + "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field possible 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_google_finance_markets_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_name": "English", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "market_type": { + "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "market_type": { - "description": "type of google finance market optional field possible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currencies default value: most-active", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "market_type" -] - 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_google_finance_markets_live_html7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "market_type": { + "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "market_type": { - "description": "type of google finance market optional field possible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currencies default value: most-active", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "market_type" -] - 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_google_finance_quote_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "CLW00:NYMEX", + "language_name": "English", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "CLW00:NYMEX", + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "window": { + "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code><p><strong>Note:</strong> if you specify a value that is different from <code>1D</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keyword": { - "description": "ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; 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 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "device operating system optional field possible values: windows", - "type": "string" - }, - "window": { - "description": "time window for google_finance_quote graph optional field possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX default value: 1D Note: if you specify a value that is different from 1D, the charge per task will be multiplied by 2", - "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_google_finance_quote_live_html7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "NASDAQ-100", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "NASDAQ-100", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "window": { + "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keyword": { - "description": "ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; 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 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "device operating system optional field possible values: windows", - "type": "string" - }, - "window": { - "description": "time window for google_finance_quote graph optional field possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX default value: 1D", - "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_google_finance_ticker_search_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "category": "all", + "keyword": "DJ", + "language_name": "English", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "category": "all", + "keyword": "DJ", + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "category": { + "description": "<p><em>category of financial instruments to search for</em><p>optional field<p>possible values: <code>all</code>, <code>stock</code>, <code>index</code>, <code>mutual_fund</code>, <code>currency</code>, <code>futures</code><p>default value: <code>all</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>company or financial instrument name</em><p><strong>required field</strong><p>in this field, you can enter the name of a company or financial instrument to search for relevant tickers;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keyword": { - "description": "company or financial instrument name required field in this field, you can enter the name of a company or financial instrument to search for relevant tickers; 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 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "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_google_images_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": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>We choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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" + ] + }, + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "Device type: desktop or mobile", - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 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/google/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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "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_google_images_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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "Device type: desktop or mobile", - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 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/google/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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "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_google_jobs_submit7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": ".net developer", + "language_code": "en", + "location_code": 2840 + }, + { + "keyword": ".net developer", + "language_name": "English", + "location_name": "United States", + "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", + "tag": "some_string_123" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": ".net developer", + "language_code": "en", + "location_code": 2840 + }, + { + "keyword": ".net developer", + "language_name": "English", + "location_name": "United States", + "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", + "tag": "some_string_123" + } + ], + "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "employment_type": { + "description": "<p><em>employment contract type</em><p>optional field<p>type of employment contract for which the search results will be returned;<p>possible values:<p><code>fulltime</code>, <code>partime</code>, <code>contractor</code>, <code>intern</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><strong>Note:</strong> the keyword you specify must indicate the job title;<p>example: <code>.net developer</code></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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "location_radius": { + "description": "<p><em>location search radius</em><p>optional field<p>location search radius in kilometers;<p><strong>Note:</strong> for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by <code>1.609</code>;<p>if value is not specified, search is executed anywhere within the specified location;<p>maximal value: <code>300</code><p>minimal value: <code>> 0</code></p>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>", + "type": "string" + }, + "postback_url": { + "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page", + "type": [ + "integer", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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”; Note: the keyword you specify must indicate the job title; example:.net developer 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; 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/google/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 https://api.dataforseo.com/v3/serp/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don't 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 https://api.dataforseo.com/v3/serp/google/jobs/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location", - "type": "string" - }, - "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 https://api.dataforseo.com/v3/serp/google/jobs/locations example: London,England,United Kingdom", - "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, 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_google_local_finder_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "local nail services", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "local nail services", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results respectively;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" + }, + "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" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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 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", - "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/{{low_se_name}}/languages 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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,20z", - "type": "string" - }, - "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 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", - "type": "string" - }, - "min_rating": { - "description": "filter results by minimum rating optional field possible values for desktop: 3.5, 4, 4.5; possible values for mobile: 2, 2.5, 3, 3.5, 4, 4.5", - "type": "number" - }, - "time_filter": { - "description": "filter results by open hours optional field using this field, you can filter places in the results by the time a place is open for visitors note that Google may also provide results that do not match this filter possible values: \"open_now\", \"24_hours\", \"$day_value\", \"$day_value;$time_value\"; instead of $day_value use one of these values: \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\", \"sunday\"; instead of $time_value use one of these values: \"00\", \"01\", \"02\", \"03\", \"04\", \"05\", \"06\", \"07\", \"08\", \"09\", \"10\", \"11\", \"12\", \"13\", \"14\", \"15\", \"16\", \"17\", \"18\", \"19\", \"20\", \"21\", \"22\", \"23\" example: \"tuesday;18\"", - "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_google_local_finder_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<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" + }, + "min_rating": { + "description": "<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>", + "type": [ + "string", + "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" + ] + }, + "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" + ] + }, + "time_filter": { + "description": "<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>\"open_now\"</code>, <code>\"24_hours\"</code>, <code>\"$day_value\"</code>, <code>\"$day_value;$time_value\"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>\"monday\"</code>, <code>\"tuesday\"</code>, <code>\"wednesday\"</code>, <code>\"thursday\"</code>, <code>\"friday\"</code>, <code>\"saturday\"</code>, <code>\"sunday\"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>\"00\"</code>, <code>\"01\"</code>, <code>\"02\"</code>, <code>\"03\"</code>, <code>\"04\"</code>, <code>\"05\"</code>, <code>\"06\"</code>, <code>\"07\"</code>, <code>\"08\"</code>, <code>\"09\"</code>, <code>\"10\"</code>, <code>\"11\"</code>, <code>\"12\"</code>, <code>\"13\"</code>, <code>\"14\"</code>, <code>\"15\"</code>, <code>\"16\"</code>, <code>\"17\"</code>, <code>\"18\"</code>, <code>\"19\"</code>, <code>\"20\"</code>, <code>\"21\"</code>, <code>\"22\"</code>, <code>\"23\"</code><p>example: <code class=\"long-string\">\"tuesday;18\"</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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”", - "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/{{low_se_name}}/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/{{low_se_name}}/languages 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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,20z", - "type": "string" - }, - "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 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", - "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_google_maps_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": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 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 100 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-maps-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><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>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/google/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/google/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/google/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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 3z<p>the maximum value for <em>\"zoom\"</em>: 21z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>", + "type": [ + "string", + "null" + ] + }, + "search_places": { + "description": "<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;</p><br><p>default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>", + "type": [ + "boolean", + "null" + ] + }, + "search_this_area": { + "description": "<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code></p><br><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off</p><br><p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>", + "type": [ + "boolean", + "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://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</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: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", - "type": "integer" - }, - "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 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/google/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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 17z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 3z the maximum value for \"zoom\": 21z example: 52.6178549,-155.352142,20z", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "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_google_news_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "android", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "android", + "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">Get the list of available parameters and additional details here.</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "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: 200 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; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", - "type": "integer" - }, - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 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", - "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/{{low_se_name}}/languages 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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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", - "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_google_news_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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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 locations 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 locations 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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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" + ] + }, + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 you can receive the list of available locations 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", - "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 locations 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", - "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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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", - "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_google_organic_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "calculate_rectangles": true, + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "calculate_rectangles": true, + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "browser_screen_height": { + "description": "browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_resolution_ratio": { + "description": "browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_width": { + "description": "browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "calculate_rectangles": { + "description": "calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;\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": "parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your 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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop", + "type": [ + "string", + "null" + ] + }, + "find_targets_in": { + "description": "SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:\"find_targets_in\": [\"organic\", \"featured_snippet\"]learn more about this parameter on our Help Center", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "group_organic_results": { + "description": "display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true", + "type": [ + "boolean", + "null" + ] + }, + "ignore_targets_in": { + "description": "SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:\"ignore_targets_in\": [\"paid\", \"images\"]learn more about this parameter on our Help Center", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "keyword": { + "description": "keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## 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”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn 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 codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou 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/google/languagesexample:en", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou 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/google/languagesexample:English", + "type": [ + "string", + "null" + ] + }, + "load_async_ai_overview": { + "description": "load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseif the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", + "type": [ + "boolean", + "null" + ] + }, + "location_code": { + "description": "search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou 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/google/locationsexample:2840", + "type": [ + "integer", + "null" + ] + }, + "location_coordinate": { + "description": "GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" formatthe maximum number of decimal digits for \"latitude\" and \"longitude\": 7the minimum value for \"radius\": 199 (mm)the maximum value for \"radius\": 199999 (mm)example:53.476225,-2.243572,200", + "type": [ + "string", + "null" + ] + }, + "location_name": { + "description": "full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou 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/google/locationsexample:London,England,United Kingdom", + "type": [ + "string", + "null" + ] + }, + "match_type": { + "description": "target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: \"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"", + "type": [ + "string", + "null" + ] + }, + "max_crawl_pages": { + "description": "page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android", + "type": [ + "string", + "null" + ] + }, + "people_also_ask_click_depth": { + "description": "clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.", + "type": [ + "integer", + "null" + ] + }, + "remove_from_url": { + "description": "remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:\"remove_from_url\": [\"srsltid\"]Note: if the target field is specified, the specified URL parameters will be removed before the search", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "se_domain": { + "description": "search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "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": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string", + "type": [ + "string", + "null" + ] + }, + "target_search_mode": { + "description": "target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "calculate_rectangles": { - "description": "calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false; Note: you will be charged extra for using this parameter", - "type": "boolean" - }, - "depth": { - "description": "parsing depth optional field number of results in SERP default value: 10 max value: 200 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”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5 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 optional field if you 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/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language optional field if you 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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location optional field if you specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "max_crawl_pages": { - "description": "page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center", - "type": "integer" - }, - "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" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "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_google_organic_live_html5 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><strong>default value: <code>10</code></strong><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/google-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" + ] + }, + "expand_ai_overview": { + "description": "<p><em>expand ai overview</em><p>optional field<p>set to <code>true</code> to expand the <code>ai_overview</code> item;<p>default value: <code>false</code></p>", + "type": [ + "boolean", + "null" + ] + }, + "find_targets_in": { + "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "ignore_targets_in": { + "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", + "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/google/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/google/languages</code><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "load_async_ai_overview": { + "description": "<p><em>load asynchronous ai overview</em><p>optional field<p>set to <code>true</code> to obtain <code>ai_overview</code> items is SERPs even if they are loaded asynchronously;<p>if set to <code>false</code>, you will only obtain <code>ai_overview</code> items from cache;<p>default value: <code>false</code><p><strong><p>if the element is absent or contains <code>\"asynchronous_ai_overview\": false</code>, all extra charges will be returned to your account balance</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" + ] + }, + "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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "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_search_mode": { + "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</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: 10 max value: 200 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" - }, - "expand_ai_overview": { - "description": "expand ai overview optional field set to true to expand the ai_overview item; default value: false", - "type": "boolean" - }, - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5", - "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/google/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/google/languages example: English", - "type": "string" - }, - "load_async_ai_overview": { - "description": "load asynchronous ai overview optional field set to true to obtain ai_overview items is SERPs even if they are loaded asynchronously; if set to false, you will only obtain ai_overview items from cache; default value: false Note your account will be billed extra for each request; if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance", - "type": "boolean" - }, - "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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "max_crawl_pages": { - "description": "page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center", - "type": "integer" - }, - "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" - }, - "se_domain": { - "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.", - "type": "string" - }, - "search_param": { - "description": "additional parameters of the search query optional field get the list of available parameters and additional details here Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "type": "string" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - }, - "url": { - "description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_google_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><strong>default value: <code>10</code></strong><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/google-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" + ] + }, + "find_targets_in": { + "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "group_organic_results": { + "description": "<p><em>display related results</em><p>optional field<p>if set to <code>true</code>, the <code>related_result</code> element in the response will be provided as a snippet of its parent organic result;<p>if set to <code>false</code>, the <code>related_result</code> element will be provided as a separate organic result;<p>default value: <code>true</code></p>", + "type": [ + "boolean", + "null" + ] + }, + "ignore_targets_in": { + "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", + "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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "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" + ] + }, + "target_search_mode": { + "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</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: 10 max value: 200 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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:', the charge per task will be multiplied by 5", - "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/google/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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "max_crawl_pages": { - "description": "page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center", - "type": "integer" - }, - "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" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "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_google_search_by_image_submit7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png", + "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "boolean", + "null" + ] + }, + "image_url": { + "description": "<p><em>URL of the image</em><p><strong>required field</strong><p>the results will be based on the image you specified in this field<p>example:<p><code class=\"long-string\">https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg</code></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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a></p>", + "type": [ + "integer", + "null" + ] + }, + "pingback_url": { + "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>", + "type": "string" + }, + "postback_url": { + "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-search-by-image-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "image_url": { - "description": "URL of the image required field the results will be based on the image you specified in this field example: https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg", - "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/{{low_se_name}}/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/{{low_se_name}}/languages 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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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", - "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: 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: -[ - "image_url" -] - 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"
38 tool updates
- Removed
batch_get_schema - Removed
batch_quote - Changed
batch_use18 fields changed- removed
Input schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - added
Input schema / properties / calls / descriptionAdded value: +"Up to 20 items of {call_id, operation_id, arguments}; steps at the same execution_level of a plan go in one batch" - removed
Input schema / properties / calls / items / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - changed
Input schema / properties / calls / items / additionalPropertiesPrevious value: -falseNew value: +true - removed
Input schema / properties / calls / items / propertiesRemoved 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" - } -} - removed
Input schema / properties / calls / items / requiredRemoved value: -[ - "call_id", - "tool", - "arguments" -] - removed
Input schema / properties / calls / maxItemsRemoved value: -20 - removed
Input schema / properties / calls / minItemsRemoved value: -1 - added
Input schema / properties / max_price_usdAdded value: +{ + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "default": null, + "description": "Per-call price cap applied to every item" +} - added
Input schema / properties / search_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - added
Input schema / properties / search_id / defaultAdded value: +null - changed
Input schema / properties / search_id / descriptionPrevious value: -"Optional search correlation identifier returned by search."New value: +"search_id from the search that found these operations" - removed
Input schema / properties / search_id / typeRemoved value: -"string" - removed
Input schema / properties / session_idRemoved 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" -} - removed
Output schema / $defsRemoved 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." - } -} - removed
Output schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - removed
Output schema / propertiesRemoved 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" - } -} - removed
Output schema / requiredRemoved value: -[ - "session_id", - "batch_id", - "total_count", - "success_count", - "error_count", - "results", - "next_steps_guidance" -]
- Changed
get_dataforseo_serp_gads_advertisers_locations1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_serp_gads_search_locations1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_serp_google_ai_mode_languages1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_serp_google_jobs_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious 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"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" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_serp_google_jobs_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious 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"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" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_serp_google_search_by_image_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious 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"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" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_details13 fields changed- removed
Input schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - added
Input schema / properties / argumentsAdded 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." +} - removed
Input schema / properties / include_arguments_schemaRemoved value: -{ - "default": true, - "description": "Return the complete arguments_schema. Defaults to true.", - "type": "boolean" -} - changed
Input schema / properties / include_documentation / descriptionPrevious value: -"Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support."New value: +"Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged." - removed
Input schema / properties / include_response_schemaRemoved value: -{ - "default": false, - "description": "Return the complete response_schema. Defaults to false.", - "type": "boolean" -} - added
Input schema / properties / operation_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "description": "One operation_id from search" +} - added
Input schema / properties / operation_idsAdded value: +{ + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "default": null, + "description": "Up to 20 operation_ids, for a batch" +} - removed
Input schema / properties / session_idRemoved 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" -} - removed
Input schema / properties / toolsRemoved 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 -} - added
Input schema / properties / with_quoteAdded value: +{ + "default": true, + "description": "Whether each operation is priced for this account before the answer. One round trip per operation; spends nothing.", + "type": "boolean" +} - removed
Input schema / requiredRemoved value: -[ - "tools" -] - removed
Output schema / propertiesRemoved 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" - } -} - removed
Output schema / requiredRemoved value: -[ - "error_count", - "next_steps_guidance", - "session_id", - "success_count", - "tools", - "total_count" -]
- Changed
get_semrush_organic_results4 fields changed- added
Input schema / properties / database / defaultAdded value: +"us" - added
Input schema / properties / database / descriptionAdded value: +"Regional database / country code. Defaults to `us`." - added
Input schema / properties / phrase / descriptionAdded value: +"Keyword phrase. URL-encode spaces as `%20` or `+`." - added
Input schema / properties / phrase / exampleAdded value: +"seo tools"
- Changed
get_semrush_paid_results4 fields changed- added
Input schema / properties / database / defaultAdded value: +"us" - added
Input schema / properties / database / descriptionAdded value: +"Regional database / country code. Defaults to `us`." - added
Input schema / properties / phrase / descriptionAdded value: +"Keyword phrase. URL-encode spaces as `%20` or `+`." - added
Input schema / properties / phrase / exampleAdded value: +"seo tools"
- Changed
post_dataforseo_serp_google_ai_mode_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "what is google ai mode", - "language_code": "en", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "what is google ai mode", - "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>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "boolean", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>required field if you don't specify <code>language_name</code>;<p>if you use this field, you don't need to specify <code>language_name</code>;<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/google/ai_mode/languages</code></p>", - "type": "string" - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p>required field if you don't specify <code>language_code</code>;<p>if you use this field, you don't need to specify <code>language_code</code>;<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/google/ai_mode/languages</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,18z</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>", - "type": "string" - }, - "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" - ] - }, - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "browser_screen_height": { + "description": "browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1080 for desktop; 640 for mobile on android; 812 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true", + "type": "integer" + }, + "browser_screen_resolution_ratio": { + "description": "browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: 0.5-3; by default, the parameter is set to: 1 for desktop; 3 for mobile on android; 3 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true", + "type": "number" + }, + "browser_screen_width": { + "description": "browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1920 for desktop; 360 for mobile on android; 375 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true", + "type": "integer" + }, + "calculate_rectangles": { + "description": "calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false Note: if set to true, the charge per task will be multiplied by 2", + "type": "boolean" + }, + "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; 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/google/ai_mode/languages", + "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/google/ai_mode/languages;", + "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 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/google/locations Note: check Google Search Help for the list of countries where AI Mode is currently available", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,18z", + "type": "string" + }, + "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 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/google/locations Note: check Google Search Help for the list of countries where AI Mode is currently available", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_ai_mode_live_html7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "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”;", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br>required field if you don't specify <code>language_name</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</code>n", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br>required field if you don't specify <code>language_code</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</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" - }, - "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" - ] - }, - "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 / propertiesAdded 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”;", + "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/google/ai_mode/languagesn", + "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/google/ai_mode/languages;", + "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 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", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200n", + "type": "string" + }, + "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 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", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_autocomplete_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "client": "gws-wiz-serp", - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "client": "gws-wiz-serp", - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "client": { - "description": "<p><em>search client for autocomplete</em><p>optional field<p>autocomplete results may differ depending on the search client;<p>possible values:<p><code>chrome</code> — used when google search is opened in google chrome;<p><code>chrome-omni</code> — used in the address bar in chrome;<p><code>gws-wiz</code> — used in google search home page;<p><code>gws-wiz-serp</code> — used in google search engine results page;<p><code>safari</code> — used when google search is opened in safari browser;<p><code>firefox</code> — used when google search is opened in firefox browser;<p><code>psy-ab</code> — may be used when google search is opened in google chrome browser;<p><code>toolbar</code> — returns XML;<p><code>youtube</code> — returns JSONP;<p><code>gws-wiz-local</code> — used in google local;<p><code>img</code> — used in google's image search;<p><code>products-cc</code> — used in google shopping search</p>", - "type": [ - "string", - "null" - ] - }, - "cursor_pointer": { - "description": "<p><em>search bar cursor pointer</em><p>optional field<p>the horizontal numerical position of the cursor pointer within the keyword in the search bar;<p>by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;<p>minimal value: <code>0</code><p>default value: the number of the last character of the specified <code>keyword</code><p>example:<p><code>|which query are s</code> - <code>\"cursor_pointer\": 0</code><p><code>which query is s|</code> - <code>\"cursor_pointer\": 16</code><p><code>which que|ry is s</code> - <code>\"cursor_pointer\": 9</code></p>", - "type": [ - "integer", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "client": { + "description": "search client for autocomplete optional field autocomplete results may differ depending on the search client; possible values: chrome — used when google search is opened in google chrome; chrome-omni — used in the address bar in chrome; gws-wiz — used in google search home page; gws-wiz-serp — used in google search engine results page; safari — used when google search is opened in safari browser; firefox — used when google search is opened in firefox browser; psy-ab — may be used when google search is opened in google chrome browser; toolbar — returns XML; youtube — returns JSONP; gws-wiz-local — used in google local; img — used in google's image search; products-cc — used in google shopping search", + "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; 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/google/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 https://api.dataforseo.com/v3/serp/google/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don't 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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/autocomplete/locations example: London,England,United Kingdom", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_dataset_info_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "dataset_id": "L2cvMTFqbl85ZHN6MQ==" - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "dataset_id": "L2cvMTFqbl85ZHN6MQ==" - } - ], - "properties": { - "dataset_id": { - "description": "<p><em>ID of the dataset</em><p><strong>required field</strong><p>you can find dataset ID in the dataset URL or <code>dataset</code> item of <a href=\"https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced\">Google Dataset Search</a> result<p>example:<p><code>L2cvMTFqbl85ZHN6MQ==</code></p>", - "type": "string" - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p>optional field<p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "dataset_id": { + "description": "ID of the dataset required field you can find dataset ID in the dataset URL or dataset item of Google Dataset Search result example: L2cvMTFqbl85ZHN6MQ==", + "type": "string" + }, + "device": { + "description": "device type optional field return results for a specific device type possible value: desktop", + "type": "string" + }, + "language_code": { + "description": "search engine language code optional field if you use this field, you don't need to specify language_name possible value: en", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language optional field if you use this field, you don't need to specify language_code possible value: English", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "dataset_id" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_dataset_search_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "file_formats": [ - "archive", - "image" - ], - "is_free": true, - "keyword": "water quality", - "last_updated": "1m", - "topics": [ - "natural_sciences", - "geo" - ], - "usage_rights": "noncommercial" - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "file_formats": [ - "archive", - "image" - ], - "is_free": true, - "keyword": "water quality", - "last_updated": "1m", - "topics": [ - "natural_sciences", - "geo" - ], - "usage_rights": "noncommercial" - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>20</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "file_formats": { - "description": "<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "is_free": { - "description": "<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>", - "type": [ - "boolean", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>optional field if you don't specify <code>language_name</code><p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", - "type": [ - "string", - "null" - ] - }, - "last_updated": { - "description": "<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - }, - "topics": { - "description": "<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "usage_rights": { - "description": "<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "file_formats": { + "description": "file formats of the dataset optional field possible values: other, archive, text, image, document, tabular", + "items": { + "type": "string" + }, + "type": "array" + }, + "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 optional field if you don't specify language_name if you use this field, you don't need to specify language_name possible value: en", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language optional field if you use this field, you don't need to specify language_code possible value: English", + "type": "string" + }, + "last_updated": { + "description": "last time the dataset was updated optional field possible values: 1m, 1y, 3y", + "type": "string" + }, + "os": { + "description": "device operating system optional field choose from the following values: windows, macos default value: windows", + "type": "string" + }, + "usage_rights": { + "description": "usage rights of the dataset optional field possible values: commercial, noncommercial", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_finance_explore_live5 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "language_name": "English", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code></strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "news_type": { - "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code><p><strong>Note:</strong> if you specify <code>local_market</code> or <code>world_markets</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "device": { + "description": "device type optional field return results for a specific device type possible 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", + "type": "string" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_finance_explore_live_html5 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "language_code": "en", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "news_type": { - "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "device": { + "description": "device type optional field possible 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", + "type": "string" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_finance_markets_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "language_name": "English", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "market_type": { - "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", + "type": "string" + }, + "market_type": { + "description": "type of google finance market optional field possible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currencies default value: most-active", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "market_type" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_finance_markets_live_html7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "language_code": "en", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "market_type": { - "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", - "type": [ - "string", - "null" - ] - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", + "type": "string" + }, + "market_type": { + "description": "type of google finance market optional field possible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currencies default value: most-active", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "market_type" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_finance_quote_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "CLW00:NYMEX", - "language_name": "English", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "CLW00:NYMEX", - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - }, - "window": { - "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code><p><strong>Note:</strong> if you specify a value that is different from <code>1D</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "keyword": { + "description": "ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; 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 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", + "type": "string" + }, + "os": { + "description": "device operating system optional field possible values: windows", + "type": "string" + }, + "window": { + "description": "time window for google_finance_quote graph optional field possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX default value: 1D Note: if you specify a value that is different from 1D, the charge per task will be multiplied by 2", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_finance_quote_live_html7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "NASDAQ-100", - "language_code": "en", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "NASDAQ-100", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "device": { - "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "os": { - "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", - "type": [ - "string", - "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" - ] - }, - "window": { - "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "keyword": { + "description": "ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; 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 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", + "type": "string" + }, + "os": { + "description": "device operating system optional field possible values: windows", + "type": "string" + }, + "window": { + "description": "time window for google_finance_quote graph optional field possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX default value: 1D", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_finance_ticker_search_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "category": "all", - "keyword": "DJ", - "language_name": "English", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "category": "all", - "keyword": "DJ", - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "category": { - "description": "<p><em>category of financial instruments to search for</em><p>optional field<p>possible values: <code>all</code>, <code>stock</code>, <code>index</code>, <code>mutual_fund</code>, <code>currency</code>, <code>futures</code><p>default value: <code>all</code></p>", - "type": [ - "string", - "null" - ] - }, - "keyword": { - "description": "<p><em>company or financial instrument name</em><p><strong>required field</strong><p>in this field, you can enter the name of a company or financial instrument to search for relevant tickers;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "location_name": { - "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "keyword": { + "description": "company or financial instrument name required field in this field, you can enter the name of a company or financial instrument to search for relevant tickers; 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 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_images_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - 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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>We choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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" - ] - }, - "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "device": { + "description": "Device type: desktop or mobile", + "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 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/google/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/google/languages 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 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/google/locations example: 2840", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", + "type": "string" + }, + "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 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/google/locations example: London,England,United Kingdom", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_images_live_html7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - 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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", - "type": [ - "string", - "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "device": { + "description": "Device type: desktop or mobile", + "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 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/google/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/google/languages 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 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/google/locations example: 2840", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", + "type": "string" + }, + "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 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/google/locations example: London,England,United Kingdom", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_jobs_submit7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": ".net developer", - "language_code": "en", - "location_code": 2840 - }, - { - "keyword": ".net developer", - "language_name": "English", - "location_name": "United States", - "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", - "tag": "some_string_123" - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": ".net developer", - "language_code": "en", - "location_code": 2840 - }, - { - "keyword": ".net developer", - "language_name": "English", - "location_name": "United States", - "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", - "tag": "some_string_123" - } - ], - "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "employment_type": { - "description": "<p><em>employment contract type</em><p>optional field<p>type of employment contract for which the search results will be returned;<p>possible values:<p><code>fulltime</code>, <code>partime</code>, <code>contractor</code>, <code>intern</code></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><strong>Note:</strong> the keyword you specify must indicate the job title;<p>example: <code>.net developer</code></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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", - "type": "integer" - }, - "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", - "type": "string" - }, - "location_radius": { - "description": "<p><em>location search radius</em><p>optional field<p>location search radius in kilometers;<p><strong>Note:</strong> for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by <code>1.609</code>;<p>if value is not specified, search is executed anywhere within the specified location;<p>maximal value: <code>300</code><p>minimal value: <code>> 0</code></p>", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>", - "type": "string" - }, - "postback_url": { - "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page", - "type": [ - "integer", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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”; Note: the keyword you specify must indicate the job title; example:.net developer 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; 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/google/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 https://api.dataforseo.com/v3/serp/google/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don't 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 https://api.dataforseo.com/v3/serp/google/jobs/locations example: 2840", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location", + "type": "string" + }, + "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 https://api.dataforseo.com/v3/serp/google/jobs/locations example: London,England,United Kingdom", + "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, 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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_local_finder_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "local nail services", - "language_code": "en", - "location_code": 2840, - "min_rating": 4.5, - "time_filter": "monday" - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "local nail services", - "language_code": "en", - "location_code": 2840, - "min_rating": 4.5, - "time_filter": "monday" - } - ], - "properties": { - "depth": { - "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results respectively;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" - }, - "min_rating": { - "description": "<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>", - "format": "double", - "type": [ - "number", - "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" - ] - }, - "priority": { - "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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" - ] - }, - "time_filter": { - "description": "<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>\"open_now\"</code>, <code>\"24_hours\"</code>, <code>\"$day_value\"</code>, <code>\"$day_value;$time_value\"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>\"monday\"</code>, <code>\"tuesday\"</code>, <code>\"wednesday\"</code>, <code>\"thursday\"</code>, <code>\"friday\"</code>, <code>\"saturday\"</code>, <code>\"sunday\"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>\"00\"</code>, <code>\"01\"</code>, <code>\"02\"</code>, <code>\"03\"</code>, <code>\"04\"</code>, <code>\"05\"</code>, <code>\"06\"</code>, <code>\"07\"</code>, <code>\"08\"</code>, <code>\"09\"</code>, <code>\"10\"</code>, <code>\"11\"</code>, <code>\"12\"</code>, <code>\"13\"</code>, <code>\"14\"</code>, <code>\"15\"</code>, <code>\"16\"</code>, <code>\"17\"</code>, <code>\"18\"</code>, <code>\"19\"</code>, <code>\"20\"</code>, <code>\"21\"</code>, <code>\"22\"</code>, <code>\"23\"</code><p>example: <code class=\"long-string\">\"tuesday;18\"</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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 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", + "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/{{low_se_name}}/languages 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 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", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,20z", + "type": "string" + }, + "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 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", + "type": "string" + }, + "min_rating": { + "description": "filter results by minimum rating optional field possible values for desktop: 3.5, 4, 4.5; possible values for mobile: 2, 2.5, 3, 3.5, 4, 4.5", + "type": "number" + }, + "time_filter": { + "description": "filter results by open hours optional field using this field, you can filter places in the results by the time a place is open for visitors note that Google may also provide results that do not match this filter possible values: \"open_now\", \"24_hours\", \"$day_value\", \"$day_value;$time_value\"; instead of $day_value use one of these values: \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\", \"sunday\"; instead of $time_value use one of these values: \"00\", \"01\", \"02\", \"03\", \"04\", \"05\", \"06\", \"07\", \"08\", \"09\", \"10\", \"11\", \"12\", \"13\", \"14\", \"15\", \"16\", \"17\", \"18\", \"19\", \"20\", \"21\", \"22\", \"23\" example: \"tuesday;18\"", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_local_finder_live_html7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - 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<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", - "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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" - }, - "min_rating": { - "description": "<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>", - "type": [ - "string", - "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" - ] - }, - "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" - ] - }, - "time_filter": { - "description": "<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>\"open_now\"</code>, <code>\"24_hours\"</code>, <code>\"$day_value\"</code>, <code>\"$day_value;$time_value\"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>\"monday\"</code>, <code>\"tuesday\"</code>, <code>\"wednesday\"</code>, <code>\"thursday\"</code>, <code>\"friday\"</code>, <code>\"saturday\"</code>, <code>\"sunday\"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>\"00\"</code>, <code>\"01\"</code>, <code>\"02\"</code>, <code>\"03\"</code>, <code>\"04\"</code>, <code>\"05\"</code>, <code>\"06\"</code>, <code>\"07\"</code>, <code>\"08\"</code>, <code>\"09\"</code>, <code>\"10\"</code>, <code>\"11\"</code>, <code>\"12\"</code>, <code>\"13\"</code>, <code>\"14\"</code>, <code>\"15\"</code>, <code>\"16\"</code>, <code>\"17\"</code>, <code>\"18\"</code>, <code>\"19\"</code>, <code>\"20\"</code>, <code>\"21\"</code>, <code>\"22\"</code>, <code>\"23\"</code><p>example: <code class=\"long-string\">\"tuesday;18\"</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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”", + "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/{{low_se_name}}/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/{{low_se_name}}/languages 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 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", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,20z", + "type": "string" + }, + "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 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", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_maps_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - 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>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 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 100 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-maps-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><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>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/google/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/google/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/google/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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 3z<p>the maximum value for <em>\"zoom\"</em>: 21z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>", - "type": [ - "string", - "null" - ] - }, - "search_places": { - "description": "<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;</p><br><p>default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>", - "type": [ - "boolean", - "null" - ] - }, - "search_this_area": { - "description": "<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code></p><br><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off</p><br><p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>", - "type": [ - "boolean", - "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://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</code>.", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "depth": { + "description": "parsing depth optional field number of results in SERP default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", + "type": "integer" + }, + "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 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/google/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/google/languages 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 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/google/locations example: 2840", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 17z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 3z the maximum value for \"zoom\": 21z example: 52.6178549,-155.352142,20z", + "type": "string" + }, + "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 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/google/locations example: London,England,United Kingdom", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_news_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "android", - "language_code": "en", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "android", - "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", - "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">Get the list of available parameters and additional details here.</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "depth": { + "description": "parsing depth optional field number of results in SERP default value: 10 max value: 200 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; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", + "type": "integer" + }, + "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 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", + "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/{{low_se_name}}/languages 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 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", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", + "type": "string" + }, + "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 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", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_news_live_html7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - 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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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 locations 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 locations 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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", - "type": [ - "string", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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" - ] - }, - "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 you can receive the list of available locations 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", + "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 locations 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", + "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 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", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", + "type": "string" + }, + "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 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", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_organic_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "calculate_rectangles": true, - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "calculate_rectangles": true, - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "browser_screen_height": { - "description": "browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_resolution_ratio": { - "description": "browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", - "type": [ - "integer", - "null" - ] - }, - "browser_screen_width": { - "description": "browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", - "format": "int64", - "type": [ - "integer", - "null" - ] - }, - "calculate_rectangles": { - "description": "calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;Note: you will be charged extra $0.002 for using this parameter", - "type": [ - "boolean", - "null" - ] - }, - "depth": { - "description": "parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your 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.", - "type": [ - "integer", - "null" - ] - }, - "device": { - "description": "device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop", - "type": [ - "string", - "null" - ] - }, - "find_targets_in": { - "description": "SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:\"find_targets_in\": [\"organic\", \"featured_snippet\"]learn more about this parameter on our Help Center", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "group_organic_results": { - "description": "display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true", - "type": [ - "boolean", - "null" - ] - }, - "ignore_targets_in": { - "description": "SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:\"ignore_targets_in\": [\"paid\", \"images\"]learn more about this parameter on our Help Center", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "keyword": { - "description": "keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## 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”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn 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 codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou 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/google/languagesexample:en", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou 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/google/languagesexample:English", - "type": [ - "string", - "null" - ] - }, - "load_async_ai_overview": { - "description": "load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote: you will be charged extra $0.002 for using this parameter;if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance", - "type": [ - "boolean", - "null" - ] - }, - "location_code": { - "description": "search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou 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/google/locationsexample:2840", - "type": [ - "integer", - "null" - ] - }, - "location_coordinate": { - "description": "GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" formatthe maximum number of decimal digits for \"latitude\" and \"longitude\": 7the minimum value for \"radius\": 199 (mm)the maximum value for \"radius\": 199999 (mm)example:53.476225,-2.243572,200", - "type": [ - "string", - "null" - ] - }, - "location_name": { - "description": "full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou 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/google/locationsexample:London,England,United Kingdom", - "type": [ - "string", - "null" - ] - }, - "match_type": { - "description": "target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern", - "type": [ - "string", - "null" - ] - }, - "match_value": { - "description": "target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: \"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"", - "type": [ - "string", - "null" - ] - }, - "max_crawl_pages": { - "description": "page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center", - "type": [ - "integer", - "null" - ] - }, - "os": { - "description": "device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android", - "type": [ - "string", - "null" - ] - }, - "people_also_ask_click_depth": { - "description": "clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;Note your account will be billed $0.00015 extra for each click;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4", - "type": [ - "integer", - "null" - ] - }, - "remove_from_url": { - "description": "remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:\"remove_from_url\": [\"srsltid\"]Note: if the target field is specified, the specified URL parameters will be removed before the search", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "se_domain": { - "description": "search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.", - "type": [ - "string", - "null" - ] - }, - "search_param": { - "description": "additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "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": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - }, - "target": { - "description": "target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string", - "type": [ - "string", - "null" - ] - }, - "target_search_mode": { - "description": "target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center", - "type": [ - "string", - "null" - ] - }, - "url": { - "description": "direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "calculate_rectangles": { + "description": "calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false; Note: you will be charged extra for using this parameter", + "type": "boolean" + }, + "depth": { + "description": "parsing depth optional field number of results in SERP default value: 10 max value: 200 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”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5 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 optional field if you 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/google/languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language optional field if you 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/google/languages 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 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/google/locations example: 2840", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location optional field if you specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", + "type": "string" + }, + "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 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/google/locations example: London,England,United Kingdom", + "type": "string" + }, + "max_crawl_pages": { + "description": "page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center", + "type": "integer" + }, + "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" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_organic_live_html5 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - 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><strong>default value: <code>10</code></strong><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/google-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" - ] - }, - "expand_ai_overview": { - "description": "<p><em>expand ai overview</em><p>optional field<p>set to <code>true</code> to expand the <code>ai_overview</code> item;<p>default value: <code>false</code></p>", - "type": [ - "boolean", - "null" - ] - }, - "find_targets_in": { - "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "ignore_targets_in": { - "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", - "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/google/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/google/languages</code><p>example:<p><code class=\"long-string\">English</code></p>", - "type": "string" - }, - "load_async_ai_overview": { - "description": "<p><em>load asynchronous ai overview</em><p>optional field<p>set to <code>true</code> to obtain <code>ai_overview</code> items is SERPs even if they are loaded asynchronously;<p>if set to <code>false</code>, you will only obtain <code>ai_overview</code> items from cache;<p>default value: <code>false</code><p><strong>Note</strong> your account will be billed $0.002 extra for each request;<p>if the element is absent or contains <code>\"asynchronous_ai_overview\": false</code>, all extra charges will be returned to your account balance</p>", - "type": [ - "boolean", - "null" - ] - }, - "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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "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_search_mode": { - "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "depth": { + "description": "parsing depth optional field number of results in SERP default value: 10 max value: 200 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" + }, + "expand_ai_overview": { + "description": "expand ai overview optional field set to true to expand the ai_overview item; default value: false", + "type": "boolean" + }, + "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5", + "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/google/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/google/languages example: English", + "type": "string" + }, + "load_async_ai_overview": { + "description": "load asynchronous ai overview optional field set to true to obtain ai_overview items is SERPs even if they are loaded asynchronously; if set to false, you will only obtain ai_overview items from cache; default value: false Note your account will be billed extra for each request; if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance", + "type": "boolean" + }, + "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 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/google/locations example: 2840", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", + "type": "string" + }, + "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 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/google/locations example: London,England,United Kingdom", + "type": "string" + }, + "max_crawl_pages": { + "description": "page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center", + "type": "integer" + }, + "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" + }, + "se_domain": { + "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.", + "type": "string" + }, + "search_param": { + "description": "additional parameters of the search query optional field get the list of available parameters and additional details here Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "type": "string" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + }, + "url": { + "description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "type": "string" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_organic_live_regular7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "albert einstein", - "language_code": "en", - "location_code": 2840 - } -] - 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><strong>default value: <code>10</code></strong><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/google-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" - ] - }, - "find_targets_in": { - "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "group_organic_results": { - "description": "<p><em>display related results</em><p>optional field<p>if set to <code>true</code>, the <code>related_result</code> element in the response will be provided as a snippet of its parent organic result;<p>if set to <code>false</code>, the <code>related_result</code> element will be provided as a separate organic result;<p>default value: <code>true</code></p>", - "type": [ - "boolean", - "null" - ] - }, - "ignore_targets_in": { - "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", - "items": { - "type": "string" - }, - "type": [ - "array", - "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", - "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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "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" - ] - }, - "target_search_mode": { - "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "depth": { + "description": "parsing depth optional field number of results in SERP default value: 10 max value: 200 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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:', the charge per task will be multiplied by 5", + "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/google/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/google/languages 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 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/google/locations example: 2840", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", + "type": "string" + }, + "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 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/google/locations example: London,England,United Kingdom", + "type": "string" + }, + "max_crawl_pages": { + "description": "page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center", + "type": "integer" + }, + "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" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_serp_google_search_by_image_submit7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png", - "language_code": "en", - "location_code": 2840 - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png", - "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", - "type": [ - "boolean", - "null" - ] - }, - "image_url": { - "description": "<p><em>URL of the image</em><p><strong>required field</strong><p>the results will be based on the image you specified in this field<p>example:<p><code class=\"long-string\">https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg</code></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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" - }, - "max_crawl_pages": { - "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a></p>", - "type": [ - "integer", - "null" - ] - }, - "pingback_url": { - "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>", - "type": "string" - }, - "postback_url": { - "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-search-by-image-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "se_domain": { - "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", - "type": [ - "string", - "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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "image_url": { + "description": "URL of the image required field the results will be based on the image you specified in this field example: https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg", + "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/{{low_se_name}}/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/{{low_se_name}}/languages 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 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", + "type": "integer" + }, + "location_coordinate": { + "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", + "type": "string" + }, + "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 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", + "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: 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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "image_url" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
search17 fields changed- removed
Input schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - added
Input schema / properties / category / anyOfAdded value: +[ + { + "enum": [ + "seo", + "finance", + "social", + "search", + "sales", + "mail" + ], + "type": "string" + }, + { + "type": "null" + } +] - added
Input schema / properties / category / defaultAdded value: +null - changed
Input schema / properties / category / descriptionPrevious value: -"Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.)"New value: +"Restrict to one category (seo, finance, social, search, sales, mail). Omit to search everything." - removed
Input schema / properties / category / enumRemoved value: -[ - "seo", - "finance", - "social", - "search", - "sales", - "mail" -] - removed
Input schema / properties / category / typeRemoved value: -"string" - removed
Input schema / properties / known_fieldsRemoved 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 number of additional direct tool candidates."New value: +"Maximum candidates, 1-10" - removed
Input schema / properties / limit / maximumRemoved value: -20 - removed
Input schema / properties / limit / minimumRemoved value: -1 - removed
Input schema / properties / provider_filtersRemoved 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: -"Natural-language capability or task to discover."New 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." - removed
Input schema / properties / query / maxLengthRemoved value: -2000 - removed
Input schema / properties / query / minLengthRemoved value: -1 - removed
Input schema / properties / session_idRemoved 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" -} - removed
Output schema / propertiesRemoved 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" - } - } -} - removed
Output schema / requiredRemoved 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 its quoted price is above this many USD"New value: +"Refuse the call before any spend if it would cost more than this many USD"
38 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_gads_advertisers_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_gads_search_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_google_ai_mode_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_serp_google_jobs_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_google_jobs_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_google_search_by_image_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_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
get_semrush_organic_results4 fields changed- removed
Input schema / properties / database / defaultRemoved value: -"us" - removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code. Defaults to `us`." - removed
Input schema / properties / phrase / descriptionRemoved value: -"Keyword phrase. URL-encode spaces as `%20` or `+`." - removed
Input schema / properties / phrase / exampleRemoved value: -"seo tools"
- Changed
get_semrush_paid_results4 fields changed- removed
Input schema / properties / database / defaultRemoved value: -"us" - removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code. Defaults to `us`." - removed
Input schema / properties / phrase / descriptionRemoved value: -"Keyword phrase. URL-encode spaces as `%20` or `+`." - removed
Input schema / properties / phrase / exampleRemoved value: -"seo tools"
- Changed
post_dataforseo_serp_google_ai_mode_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "what is google ai mode", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "what is google ai mode", + "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>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "boolean", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>required field if you don't specify <code>language_name</code>;<p>if you use this field, you don't need to specify <code>language_name</code>;<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/google/ai_mode/languages</code></p>", + "type": "string" + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>required field if you don't specify <code>language_code</code>;<p>if you use this field, you don't need to specify <code>language_code</code>;<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/google/ai_mode/languages</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,18z</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/google/locations</code><p><strong>Note:</strong> check <a href=\"https://support.google.com/websearch/answer/16011537?hl=en&co=GENIE.Platform%3DAndroid#\" target=\"_blank\"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>", + "type": "string" + }, + "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" + ] + }, + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "browser_screen_height": { - "description": "browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1080 for desktop; 640 for mobile on android; 812 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true", - "type": "integer" - }, - "browser_screen_resolution_ratio": { - "description": "browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: 0.5-3; by default, the parameter is set to: 1 for desktop; 3 for mobile on android; 3 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true", - "type": "number" - }, - "browser_screen_width": { - "description": "browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1920 for desktop; 360 for mobile on android; 375 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true", - "type": "integer" - }, - "calculate_rectangles": { - "description": "calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false Note: if set to true, the charge per task will be multiplied by 2", - "type": "boolean" - }, - "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; 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/google/ai_mode/languages", - "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/google/ai_mode/languages;", - "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 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/google/locations Note: check Google Search Help for the list of countries where AI Mode is currently available", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,18z", - "type": "string" - }, - "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 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/google/locations Note: check Google Search Help for the list of countries where AI Mode is currently available", - "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_google_ai_mode_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": { + "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”;", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br>required field if you don't specify <code>language_name</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br>required field if you don't specify <code>language_code</code>;<br>if you use this field, you don't need to specify <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/google/ai_mode/languages</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" + }, + "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" + ] + }, + "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: -{ - "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”;", - "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/google/ai_mode/languagesn", - "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/google/ai_mode/languages;", - "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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200n", - "type": "string" - }, - "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 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", - "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_google_autocomplete_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "client": "gws-wiz-serp", + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "client": "gws-wiz-serp", + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "client": { + "description": "<p><em>search client for autocomplete</em><p>optional field<p>autocomplete results may differ depending on the search client;<p>possible values:<p><code>chrome</code> — used when google search is opened in google chrome;<p><code>chrome-omni</code> — used in the address bar in chrome;<p><code>gws-wiz</code> — used in google search home page;<p><code>gws-wiz-serp</code> — used in google search engine results page;<p><code>safari</code> — used when google search is opened in safari browser;<p><code>firefox</code> — used when google search is opened in firefox browser;<p><code>psy-ab</code> — may be used when google search is opened in google chrome browser;<p><code>toolbar</code> — returns XML;<p><code>youtube</code> — returns JSONP;<p><code>gws-wiz-local</code> — used in google local;<p><code>img</code> — used in google's image search;<p><code>products-cc</code> — used in google shopping search</p>", + "type": [ + "string", + "null" + ] + }, + "cursor_pointer": { + "description": "<p><em>search bar cursor pointer</em><p>optional field<p>the horizontal numerical position of the cursor pointer within the keyword in the search bar;<p>by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;<p>minimal value: <code>0</code><p>default value: the number of the last character of the specified <code>keyword</code><p>example:<p><code>|which query are s</code> - <code>\"cursor_pointer\": 0</code><p><code>which query is s|</code> - <code>\"cursor_pointer\": 16</code><p><code>which que|ry is s</code> - <code>\"cursor_pointer\": 9</code></p>", + "type": [ + "integer", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "client": { - "description": "search client for autocomplete optional field autocomplete results may differ depending on the search client; possible values: chrome — used when google search is opened in google chrome; chrome-omni — used in the address bar in chrome; gws-wiz — used in google search home page; gws-wiz-serp — used in google search engine results page; safari — used when google search is opened in safari browser; firefox — used when google search is opened in firefox browser; psy-ab — may be used when google search is opened in google chrome browser; toolbar — returns XML; youtube — returns JSONP; gws-wiz-local — used in google local; img — used in google's image search; products-cc — used in google shopping search", - "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; 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/google/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 https://api.dataforseo.com/v3/serp/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don't 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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/autocomplete/locations example: London,England,United Kingdom", - "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_google_dataset_info_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "dataset_id": "L2cvMTFqbl85ZHN6MQ==" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "dataset_id": "L2cvMTFqbl85ZHN6MQ==" + } + ], + "properties": { + "dataset_id": { + "description": "<p><em>ID of the dataset</em><p><strong>required field</strong><p>you can find dataset ID in the dataset URL or <code>dataset</code> item of <a href=\"https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced\">Google Dataset Search</a> result<p>example:<p><code>L2cvMTFqbl85ZHN6MQ==</code></p>", + "type": "string" + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p>optional field<p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "dataset_id": { - "description": "ID of the dataset required field you can find dataset ID in the dataset URL or dataset item of Google Dataset Search result example: L2cvMTFqbl85ZHN6MQ==", - "type": "string" - }, - "device": { - "description": "device type optional field return results for a specific device type possible value: desktop", - "type": "string" - }, - "language_code": { - "description": "search engine language code optional field if you use this field, you don't need to specify language_name possible value: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language optional field if you use this field, you don't need to specify language_code possible value: English", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "dataset_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_google_dataset_search_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "file_formats": [ + "archive", + "image" + ], + "is_free": true, + "keyword": "water quality", + "last_updated": "1m", + "topics": [ + "natural_sciences", + "geo" + ], + "usage_rights": "noncommercial" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "file_formats": [ + "archive", + "image" + ], + "is_free": true, + "keyword": "water quality", + "last_updated": "1m", + "topics": [ + "natural_sciences", + "geo" + ], + "usage_rights": "noncommercial" + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>20</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "file_formats": { + "description": "<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "is_free": { + "description": "<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>", + "type": [ + "boolean", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>optional field if you don't specify <code>language_name</code><p>if you use this field, you don't need to specify <code>language_name</code><p>possible value:<p><code class=\"long-string\">en</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>", + "type": [ + "string", + "null" + ] + }, + "last_updated": { + "description": "<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "topics": { + "description": "<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "usage_rights": { + "description": "<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "file_formats": { - "description": "file formats of the dataset optional field possible values: other, archive, text, image, document, tabular", - "items": { - "type": "string" - }, - "type": "array" - }, - "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 optional field if you don't specify language_name if you use this field, you don't need to specify language_name possible value: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language optional field if you use this field, you don't need to specify language_code possible value: English", - "type": "string" - }, - "last_updated": { - "description": "last time the dataset was updated optional field possible values: 1m, 1y, 3y", - "type": "string" - }, - "os": { - "description": "device operating system optional field choose from the following values: windows, macos default value: windows", - "type": "string" - }, - "usage_rights": { - "description": "usage rights of the dataset optional field possible values: commercial, noncommercial", - "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_google_finance_explore_live5 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_name": "English", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code></strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "news_type": { + "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code><p><strong>Note:</strong> if you specify <code>local_market</code> or <code>world_markets</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field return results for a specific device type possible 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_google_finance_explore_live_html5 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "news_type": { + "description": "<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "device type optional field possible 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_google_finance_markets_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_name": "English", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "market_type": { + "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "market_type": { - "description": "type of google finance market optional field possible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currencies default value: most-active", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "market_type" -] - 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_google_finance_markets_live_html7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<p><em>search engine language code</em><p><strong>required field if you don't specify <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "market_type": { + "description": "<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>", + "type": [ + "string", + "null" + ] + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + } + }, + "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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "market_type": { - "description": "type of google finance market optional field possible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currencies default value: most-active", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "market_type" -] - 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_google_finance_quote_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "CLW00:NYMEX", + "language_name": "English", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "CLW00:NYMEX", + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "window": { + "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code><p><strong>Note:</strong> if you specify a value that is different from <code>1D</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keyword": { - "description": "ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; 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 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "device operating system optional field possible values: windows", - "type": "string" - }, - "window": { - "description": "time window for google_finance_quote graph optional field possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX default value: 1D Note: if you specify a value that is different from 1D, the charge per task will be multiplied by 2", - "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_google_finance_quote_live_html7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "NASDAQ-100", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "NASDAQ-100", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "device": { + "description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "os": { + "description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>", + "type": [ + "string", + "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" + ] + }, + "window": { + "description": "<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keyword": { - "description": "ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; 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 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "os": { - "description": "device operating system optional field possible values: windows", - "type": "string" - }, - "window": { - "description": "time window for google_finance_quote graph optional field possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX default value: 1D", - "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_google_finance_ticker_search_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "category": "all", + "keyword": "DJ", + "language_name": "English", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "category": "all", + "keyword": "DJ", + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "category": { + "description": "<p><em>category of financial instruments to search for</em><p>optional field<p>possible values: <code>all</code>, <code>stock</code>, <code>index</code>, <code>mutual_fund</code>, <code>currency</code>, <code>futures</code><p>default value: <code>all</code></p>", + "type": [ + "string", + "null" + ] + }, + "keyword": { + "description": "<p><em>company or financial instrument name</em><p><strong>required field</strong><p>in this field, you can enter the name of a company or financial instrument to search for relevant tickers;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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 <code>language_name</code></strong><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/google/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 <code>language_code</code> </strong><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/google/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 <code>location_name</code></strong><p><strong>if you use this field, you don't need to specify <code>location_name</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "location_name": { + "description": "<p><em>full name of search engine location</em><p><strong>required field if you don't specify <code>location_code</code></strong><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keyword": { - "description": "company or financial instrument name required field in this field, you can enter the name of a company or financial instrument to search for relevant tickers; 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 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom", - "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_google_images_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": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>We choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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" + ] + }, + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "Device type: desktop or mobile", - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 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/google/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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "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_google_images_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>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-images-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "device": { - "description": "Device type: desktop or mobile", - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 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/google/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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "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_google_jobs_submit7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": ".net developer", + "language_code": "en", + "location_code": 2840 + }, + { + "keyword": ".net developer", + "language_name": "English", + "location_name": "United States", + "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", + "tag": "some_string_123" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": ".net developer", + "language_code": "en", + "location_code": 2840 + }, + { + "keyword": ".net developer", + "language_name": "English", + "location_name": "United States", + "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag", + "tag": "some_string_123" + } + ], + "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "employment_type": { + "description": "<p><em>employment contract type</em><p>optional field<p>type of employment contract for which the search results will be returned;<p>possible values:<p><code>fulltime</code>, <code>partime</code>, <code>contractor</code>, <code>intern</code></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><strong>Note:</strong> the keyword you specify must indicate the job title;<p>example: <code>.net developer</code></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/google/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 <code>https://api.dataforseo.com/v3/serp/google/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>;<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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">2840</code></p>", + "type": "integer" + }, + "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><p><strong>if you use this field, you don't need to specify <code>location_code</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 <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p>", + "type": "string" + }, + "location_radius": { + "description": "<p><em>location search radius</em><p>optional field<p>location search radius in kilometers;<p><strong>Note:</strong> for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by <code>1.609</code>;<p>if value is not specified, search is executed anywhere within the specified location;<p>maximal value: <code>300</code><p>minimal value: <code>> 0</code></p>", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>", + "type": "string" + }, + "postback_url": { + "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-jobs-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page", + "type": [ + "integer", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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”; Note: the keyword you specify must indicate the job title; example:.net developer 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; 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/google/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 https://api.dataforseo.com/v3/serp/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don't 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 https://api.dataforseo.com/v3/serp/google/jobs/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location", - "type": "string" - }, - "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 https://api.dataforseo.com/v3/serp/google/jobs/locations example: London,England,United Kingdom", - "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, 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_google_local_finder_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "local nail services", + "language_code": "en", + "location_code": 2840, + "min_rating": 4.5, + "time_filter": "monday" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "local nail services", + "language_code": "en", + "location_code": 2840, + "min_rating": 4.5, + "time_filter": "monday" + } + ], + "properties": { + "depth": { + "description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results respectively;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" + }, + "min_rating": { + "description": "<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>", + "format": "double", + "type": [ + "number", + "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" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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" + ] + }, + "time_filter": { + "description": "<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>\"open_now\"</code>, <code>\"24_hours\"</code>, <code>\"$day_value\"</code>, <code>\"$day_value;$time_value\"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>\"monday\"</code>, <code>\"tuesday\"</code>, <code>\"wednesday\"</code>, <code>\"thursday\"</code>, <code>\"friday\"</code>, <code>\"saturday\"</code>, <code>\"sunday\"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>\"00\"</code>, <code>\"01\"</code>, <code>\"02\"</code>, <code>\"03\"</code>, <code>\"04\"</code>, <code>\"05\"</code>, <code>\"06\"</code>, <code>\"07\"</code>, <code>\"08\"</code>, <code>\"09\"</code>, <code>\"10\"</code>, <code>\"11\"</code>, <code>\"12\"</code>, <code>\"13\"</code>, <code>\"14\"</code>, <code>\"15\"</code>, <code>\"16\"</code>, <code>\"17\"</code>, <code>\"18\"</code>, <code>\"19\"</code>, <code>\"20\"</code>, <code>\"21\"</code>, <code>\"22\"</code>, <code>\"23\"</code><p>example: <code class=\"long-string\">\"tuesday;18\"</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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 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", - "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/{{low_se_name}}/languages 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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,20z", - "type": "string" - }, - "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 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", - "type": "string" - }, - "min_rating": { - "description": "filter results by minimum rating optional field possible values for desktop: 3.5, 4, 4.5; possible values for mobile: 2, 2.5, 3, 3.5, 4, 4.5", - "type": "number" - }, - "time_filter": { - "description": "filter results by open hours optional field using this field, you can filter places in the results by the time a place is open for visitors note that Google may also provide results that do not match this filter possible values: \"open_now\", \"24_hours\", \"$day_value\", \"$day_value;$time_value\"; instead of $day_value use one of these values: \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\", \"sunday\"; instead of $time_value use one of these values: \"00\", \"01\", \"02\", \"03\", \"04\", \"05\", \"06\", \"07\", \"08\", \"09\", \"10\", \"11\", \"12\", \"13\", \"14\", \"15\", \"16\", \"17\", \"18\", \"19\", \"20\", \"21\", \"22\", \"23\" example: \"tuesday;18\"", - "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_google_local_finder_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<br><p>default value: <code>10</code><p>max value: <code>100</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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-local-finder-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>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<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>", + "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><p>example:<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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 4z<p>the maximum value for <em>\"zoom\"</em>: 18z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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" + }, + "min_rating": { + "description": "<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>", + "type": [ + "string", + "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" + ] + }, + "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" + ] + }, + "time_filter": { + "description": "<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>\"open_now\"</code>, <code>\"24_hours\"</code>, <code>\"$day_value\"</code>, <code>\"$day_value;$time_value\"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>\"monday\"</code>, <code>\"tuesday\"</code>, <code>\"wednesday\"</code>, <code>\"thursday\"</code>, <code>\"friday\"</code>, <code>\"saturday\"</code>, <code>\"sunday\"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>\"00\"</code>, <code>\"01\"</code>, <code>\"02\"</code>, <code>\"03\"</code>, <code>\"04\"</code>, <code>\"05\"</code>, <code>\"06\"</code>, <code>\"07\"</code>, <code>\"08\"</code>, <code>\"09\"</code>, <code>\"10\"</code>, <code>\"11\"</code>, <code>\"12\"</code>, <code>\"13\"</code>, <code>\"14\"</code>, <code>\"15\"</code>, <code>\"16\"</code>, <code>\"17\"</code>, <code>\"18\"</code>, <code>\"19\"</code>, <code>\"20\"</code>, <code>\"21\"</code>, <code>\"22\"</code>, <code>\"23\"</code><p>example: <code class=\"long-string\">\"tuesday;18\"</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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”", - "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/{{low_se_name}}/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/{{low_se_name}}/languages 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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,20z", - "type": "string" - }, - "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 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", - "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_google_maps_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": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 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 100 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-maps-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><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>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/google/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/google/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/google/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,zoom\"</em> format<p>if <em>\"zoom\"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"zoom\"</em>: 3z<p>the maximum value for <em>\"zoom\"</em>: 21z<p>example:<p><code class=\"long-string\">52.6178549,-155.352142,20z</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/google/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</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>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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>", + "type": [ + "string", + "null" + ] + }, + "search_places": { + "description": "<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;</p><br><p>default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>", + "type": [ + "boolean", + "null" + ] + }, + "search_this_area": { + "description": "<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code></p><br><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off</p><br><p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>", + "type": [ + "boolean", + "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://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</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: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", - "type": "integer" - }, - "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 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/google/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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 17z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 3z the maximum value for \"zoom\": 21z example: 52.6178549,-155.352142,20z", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "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_google_news_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "android", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "android", + "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">Get the list of available parameters and additional details here.</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "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: 200 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; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.", - "type": "integer" - }, - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 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", - "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/{{low_se_name}}/languages 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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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", - "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_google_news_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 if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-news-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</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 locations 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 locations 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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>", + "type": [ + "string", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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" + ] + }, + "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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 you can receive the list of available locations 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", - "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 locations 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", - "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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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", - "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_google_organic_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "calculate_rectangles": true, + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "calculate_rectangles": true, + "keyword": "albert einstein", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "browser_screen_height": { + "description": "browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_resolution_ratio": { + "description": "browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "type": [ + "integer", + "null" + ] + }, + "browser_screen_width": { + "description": "browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true", + "format": "int64", + "type": [ + "integer", + "null" + ] + }, + "calculate_rectangles": { + "description": "calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;Note: you will be charged extra $0.002 for using this parameter", + "type": [ + "boolean", + "null" + ] + }, + "depth": { + "description": "parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your 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.", + "type": [ + "integer", + "null" + ] + }, + "device": { + "description": "device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop", + "type": [ + "string", + "null" + ] + }, + "find_targets_in": { + "description": "SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:\"find_targets_in\": [\"organic\", \"featured_snippet\"]learn more about this parameter on our Help Center", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "group_organic_results": { + "description": "display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true", + "type": [ + "boolean", + "null" + ] + }, + "ignore_targets_in": { + "description": "SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:\"ignore_targets_in\": [\"paid\", \"images\"]learn more about this parameter on our Help Center", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "keyword": { + "description": "keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## 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”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn 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 codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou 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/google/languagesexample:en", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou 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/google/languagesexample:English", + "type": [ + "string", + "null" + ] + }, + "load_async_ai_overview": { + "description": "load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote: you will be charged extra $0.002 for using this parameter;if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance", + "type": [ + "boolean", + "null" + ] + }, + "location_code": { + "description": "search engine location coderequired field if you don't specify location_name or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou 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/google/locationsexample:2840", + "type": [ + "integer", + "null" + ] + }, + "location_coordinate": { + "description": "GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" formatthe maximum number of decimal digits for \"latitude\" and \"longitude\": 7the minimum value for \"radius\": 199 (mm)the maximum value for \"radius\": 199999 (mm)example:53.476225,-2.243572,200", + "type": [ + "string", + "null" + ] + }, + "location_name": { + "description": "full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou 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/google/locationsexample:London,England,United Kingdom", + "type": [ + "string", + "null" + ] + }, + "match_type": { + "description": "target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern", + "type": [ + "string", + "null" + ] + }, + "match_value": { + "description": "target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: \"match_value\": \"dataforseo.com\",\"match_value\": \"/blog/post-*\"", + "type": [ + "string", + "null" + ] + }, + "max_crawl_pages": { + "description": "page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center", + "type": [ + "integer", + "null" + ] + }, + "os": { + "description": "device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android", + "type": [ + "string", + "null" + ] + }, + "people_also_ask_click_depth": { + "description": "clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;Note your account will be billed $0.00015 extra for each click;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4", + "type": [ + "integer", + "null" + ] + }, + "remove_from_url": { + "description": "remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:\"remove_from_url\": [\"srsltid\"]Note: if the target field is specified, the specified URL parameters will be removed before the search", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "se_domain": { + "description": "search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.", + "type": [ + "string", + "null" + ] + }, + "search_param": { + "description": "additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "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": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + }, + "target": { + "description": "target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string", + "type": [ + "string", + "null" + ] + }, + "target_search_mode": { + "description": "target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center", + "type": [ + "string", + "null" + ] + }, + "url": { + "description": "direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "calculate_rectangles": { - "description": "calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false; Note: you will be charged extra for using this parameter", - "type": "boolean" - }, - "depth": { - "description": "parsing depth optional field number of results in SERP default value: 10 max value: 200 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”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5 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 optional field if you 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/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language optional field if you 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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location optional field if you specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "max_crawl_pages": { - "description": "page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center", - "type": "integer" - }, - "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" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "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_google_organic_live_html5 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><strong>default value: <code>10</code></strong><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/google-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" + ] + }, + "expand_ai_overview": { + "description": "<p><em>expand ai overview</em><p>optional field<p>set to <code>true</code> to expand the <code>ai_overview</code> item;<p>default value: <code>false</code></p>", + "type": [ + "boolean", + "null" + ] + }, + "find_targets_in": { + "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "ignore_targets_in": { + "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", + "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/google/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/google/languages</code><p>example:<p><code class=\"long-string\">English</code></p>", + "type": "string" + }, + "load_async_ai_overview": { + "description": "<p><em>load asynchronous ai overview</em><p>optional field<p>set to <code>true</code> to obtain <code>ai_overview</code> items is SERPs even if they are loaded asynchronously;<p>if set to <code>false</code>, you will only obtain <code>ai_overview</code> items from cache;<p>default value: <code>false</code><p><strong>Note</strong> your account will be billed $0.002 extra for each request;<p>if the element is absent or contains <code>\"asynchronous_ai_overview\": false</code>, all extra charges will be returned to your account balance</p>", + "type": [ + "boolean", + "null" + ] + }, + "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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "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_search_mode": { + "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</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: 10 max value: 200 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" - }, - "expand_ai_overview": { - "description": "expand ai overview optional field set to true to expand the ai_overview item; default value: false", - "type": "boolean" - }, - "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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5", - "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/google/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/google/languages example: English", - "type": "string" - }, - "load_async_ai_overview": { - "description": "load asynchronous ai overview optional field set to true to obtain ai_overview items is SERPs even if they are loaded asynchronously; if set to false, you will only obtain ai_overview items from cache; default value: false Note your account will be billed extra for each request; if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance", - "type": "boolean" - }, - "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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "max_crawl_pages": { - "description": "page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center", - "type": "integer" - }, - "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" - }, - "se_domain": { - "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.", - "type": "string" - }, - "search_param": { - "description": "additional parameters of the search query optional field get the list of available parameters and additional details here Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "type": "string" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - }, - "url": { - "description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_serp_google_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><strong>default value: <code>10</code></strong><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/google-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" + ] + }, + "find_targets_in": { + "description": "<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>\"find_targets_in\": [\"organic\", \"featured_snippet\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "group_organic_results": { + "description": "<p><em>display related results</em><p>optional field<p>if set to <code>true</code>, the <code>related_result</code> element in the response will be provided as a snippet of its parent organic result;<p>if set to <code>false</code>, the <code>related_result</code> element will be provided as a separate organic result;<p>default value: <code>true</code></p>", + "type": [ + "boolean", + "null" + ] + }, + "ignore_targets_in": { + "description": "<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>\"ignore_targets_in\": [\"paid\", \"images\"]</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></p>", + "items": { + "type": "string" + }, + "type": [ + "array", + "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>all %## will be decoded (plus character '+' will be decoded to a space character)<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>if this field contains such parameters as <em>'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:'</em>, <strong>the charge per task will be multiplied by 5</strong>", + "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/google/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/google/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/google/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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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/google/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>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href=\"https://dataforseo.com/pricing/serp/google-organic-serp-api\" target=\"_blank\">Pricing</a> page;<p><strong>Note#2:</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" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.", + "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" + ] + }, + "target_search_mode": { + "description": "<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api\" target=\"_blank\">Help Center</a></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.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</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: 10 max value: 200 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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:', the charge per task will be multiplied by 5", - "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/google/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/google/languages 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 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/google/locations example: 2840", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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/google/locations example: London,England,United Kingdom", - "type": "string" - }, - "max_crawl_pages": { - "description": "page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center", - "type": "integer" - }, - "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" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "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_google_search_by_image_submit7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png", + "language_code": "en", + "location_code": 2840 + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png", + "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>by default, the parameter is set to <code>1080</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>by default, the parameter is set to <code>1</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>by default, the parameter is set to <code>1920</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> if set to <code>true</code>, the charge per task will be multiplied by 2</p>", + "type": [ + "boolean", + "null" + ] + }, + "image_url": { + "description": "<p><em>URL of the image</em><p><strong>required field</strong><p>the results will be based on the image you specified in this field<p>example:<p><code class=\"long-string\">https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg</code></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,radius\"</em> format<p>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<p>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<p>the maximum value for <em>\"radius\"</em>: 199999 (mm)<p>example:<p><code class=\"long-string\">53.476225,-2.243572,200</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" + }, + "max_crawl_pages": { + "description": "<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<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\" target=\"_blank\" rel=\"noopener noreferrer\">our help center</a></p>", + "type": [ + "integer", + "null" + ] + }, + "pingback_url": { + "description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>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.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>", + "type": "string" + }, + "postback_url": { + "description": "<p><em>URL for sending task results</em><p>optional field<p>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<p>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.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><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></p>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-search-by-image-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "se_domain": { + "description": "<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</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/google-search-engine-parameters-and-how-to-use-them\">get the list of available parameters and additional details here</a></p>", + "type": [ + "string", + "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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "image_url": { - "description": "URL of the image required field the results will be based on the image you specified in this field example: https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg", - "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/{{low_se_name}}/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/{{low_se_name}}/languages 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 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", - "type": "integer" - }, - "location_coordinate": { - "description": "GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200", - "type": "string" - }, - "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 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", - "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: 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: -[ - "image_url" -] - 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" +}
7 tool updates
- Changed
post_dataforseo_serp_google_jobs_submit1 field changed- 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_google_maps_live1 field changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results in SERP default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of results in SERP default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results."
- Changed
post_dataforseo_serp_google_news_live1 field 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: 200 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; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically 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: 200 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; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically."
- Changed
post_dataforseo_serp_google_organic_live3 fields changed- changed
Input schema / properties / body / items / properties / calculate_rectangles / descriptionPrevious value: -"calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false; Note: you will be charged extra $0.002 for using this parameter"New value: +"calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false; Note: you will be charged extra for using this parameter" - changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results in SERP default value: 10 max value: 200 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: 200 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 / max_crawl_pages / descriptionPrevious value: -"page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); learn more about pricing on our Pricing page; Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center"New value: +"page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center"
- Changed
post_dataforseo_serp_google_organic_live_html3 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: 200 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: 200 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 / load_async_ai_overview / descriptionPrevious value: -"load asynchronous ai overview optional field set to true to obtain ai_overview items is SERPs even if they are loaded asynchronously; if set to false, you will only obtain ai_overview items from cache; default value: false Note your account will be billed $0.002 extra for each request; if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance"New value: +"load asynchronous ai overview optional field set to true to obtain ai_overview items is SERPs even if they are loaded asynchronously; if set to false, you will only obtain ai_overview items from cache; default value: false Note your account will be billed extra for each request; if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance" - changed
Input schema / properties / body / items / properties / max_crawl_pages / descriptionPrevious value: -"page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); learn more about pricing on our Pricing page; Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center"New value: +"page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center"
- Changed
post_dataforseo_serp_google_organic_live_regular2 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: 200 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: 200 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 / max_crawl_pages / descriptionPrevious value: -"page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); learn more about pricing on our Pricing page; Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center"New value: +"page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center"
- Changed
post_dataforseo_serp_google_search_by_image_submit1 field changed- 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."
27 tool updates
- Changed
get_dataforseo_serp_google_jobs_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_google_jobs_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_google_search_by_image_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
post_dataforseo_serp_google_ai_mode_live11 fields changed- changed
Input schema / properties / body / items / properties / browser_screen_height / descriptionPrevious value: -"Custom browser screen height"New value: +"browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1080 for desktop; 640 for mobile on android; 812 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true" - changed
Input schema / properties / body / items / properties / browser_screen_resolution_ratio / descriptionPrevious value: -"Screen resolution ratio for rectangle calculations"New value: +"browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: 0.5-3; by default, the parameter is set to: 1 for desktop; 3 for mobile on android; 3 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true" - changed
Input schema / properties / body / items / properties / browser_screen_width / descriptionPrevious value: -"Custom browser screen width"New value: +"browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1920 for desktop; 360 for mobile on android; 375 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true" - changed
Input schema / properties / body / items / properties / calculate_rectangles / descriptionPrevious value: -"Enable pixel ranking calculations for elements in SERP"New value: +"calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false Note: if set to true, the charge per task will be multiplied by 2" - changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type: desktop or mobile"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; you can specify up to 700 characters"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; required if language_name is not specified"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/google/ai_mode/languages" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language; required if language_code is not specified"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/google/ai_mode/languages;" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code; required if location_name or location_coordinate is not specified"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/google/locations Note: check Google Search Help for the list of countries where AI Mode is currently available" - changed
Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location; required if location_name or location_code is not specified"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,18z" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location; required if location_code or location_coordinate is not specified"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/google/locations Note: check Google Search Help for the list of countries where AI Mode is currently available"
- Changed
post_dataforseo_serp_google_ai_mode_live_html7 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type: desktop or mobile"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; you can specify up to 700 characters"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”;" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code; required if language_name is not specified"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/google/ai_mode/languagesn" - changed
Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"Full name of search engine language; required if language_code is not specified"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/google/ai_mode/languages;" - changed
Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"Search engine location code; required if location_name or location_coordinate is not specified"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_coordinate / descriptionPrevious value: -"GPS coordinates of a location; required if location_name or location_code is not specified"New value: +"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200n" - changed
Input schema / properties / body / items / properties / location_name / descriptionPrevious value: -"Full name of search engine location; required if location_code or location_coordinate is not specified"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
post_dataforseo_serp_google_autocomplete_live6 fields changed- changed
Input schema / properties / body / items / properties / client / descriptionPrevious value: -"Search client for autocomplete"New value: +"search client for autocomplete optional field autocomplete results may differ depending on the search client; possible values: chrome — used when google search is opened in google chrome; chrome-omni — used in the address bar in chrome; gws-wiz — used in google search home page; gws-wiz-serp — used in google search engine results page; safari — used when google search is opened in safari browser; firefox — used when google search is opened in firefox browser; psy-ab — may be used when google search is opened in google chrome browser; toolbar — returns XML; youtube — returns JSONP; gws-wiz-local — used in google local; img — used in google's image search; products-cc — used in google shopping search" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to get autocomplete suggestions 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/google/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 https://api.dataforseo.com/v3/serp/google/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; you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/autocomplete/locations example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_google_dataset_info_live4 fields changed- changed
Input schema / properties / body / items / properties / dataset_id / descriptionPrevious value: -"ID of the dataset"New value: +"ID of the dataset required field you can find dataset ID in the dataset URL or dataset item of Google Dataset Search result example: L2cvMTFqbl85ZHN6MQ==" - changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type; possible value: desktop"New value: +"device type optional field return results for a specific device type possible value: desktop" - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"Search engine language code"New value: +"search engine language code optional field if you use this field, you don't need to specify language_name possible value: 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 optional field if you use this field, you don't need to specify language_code possible value: English"
- Changed
post_dataforseo_serp_google_dataset_search_live7 fields changed- changed
Input schema / properties / body / items / properties / file_formats / descriptionPrevious value: -"Dataset file formats"New value: +"file formats of the dataset optional field possible values: other, archive, text, image, document, tabular" - changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Keyword to search datasets 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 optional field if you don't specify language_name if you use this field, you don't need to specify language_name possible value: 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 optional field if you use this field, you don't need to specify language_code possible value: English" - changed
Input schema / properties / body / items / properties / last_updated / descriptionPrevious value: -"Last updated filter"New value: +"last time the dataset was updated optional field possible values: 1m, 1y, 3y" - changed
Input schema / properties / body / items / properties / os / descriptionPrevious value: -"Device operating system"New value: +"device operating system optional field choose from the following values: windows, macos default value: windows" - changed
Input schema / properties / body / items / properties / usage_rights / descriptionPrevious value: -"Usage rights filter"New value: +"usage rights of the dataset optional field possible values: commercial, noncommercial"
- Changed
post_dataforseo_serp_google_finance_explore_live5 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type; possible value: desktop"New value: +"device type optional field return results for a specific device type possible 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_google_finance_explore_live_html5 fields changed- changed
Input schema / properties / body / items / properties / device / descriptionPrevious value: -"Device type; possible value: desktop"New value: +"device type optional field possible 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_google_finance_markets_live5 fields changed- 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / market_type / descriptionPrevious value: -"Market type for the Markets tab"New value: +"type of google finance market optional field possible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currencies default value: most-active"
- Changed
post_dataforseo_serp_google_finance_markets_live_html5 fields changed- 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / market_type / descriptionPrevious value: -"Market type for the Markets tab"New value: +"type of google finance market optional field possible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currencies default value: most-active"
- Changed
post_dataforseo_serp_google_finance_quote_live7 fields changed- changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Ticker or stock symbol"New value: +"ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/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 possible values: windows" - changed
Input schema / properties / body / items / properties / window / descriptionPrevious value: -"Time window for the quote graph"New value: +"time window for google_finance_quote graph optional field possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX default value: 1D Note: if you specify a value that is different from 1D, the charge per task will be multiplied by 2"
- Changed
post_dataforseo_serp_google_finance_quote_live_html7 fields changed- changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Ticker or stock symbol"New value: +"ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/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 possible values: windows" - changed
Input schema / properties / body / items / properties / window / descriptionPrevious value: -"Time window for the quote graph"New value: +"time window for google_finance_quote graph optional field possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX default value: 1D"
- Changed
post_dataforseo_serp_google_finance_ticker_search_live5 fields changed- changed
Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"Company or financial instrument name"New value: +"company or financial instrument name required field in this field, you can enter the name of a company or financial instrument to search for relevant tickers; 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/google/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/google/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 https://api.dataforseo.com/v3/serp/google/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 https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_google_images_live6 fields changed- 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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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/google/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/google/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/google/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200" - 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/google/locations example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_google_images_live_html6 fields changed- 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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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/google/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/google/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/google/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200" - 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/google/locations example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_google_jobs_submit9 fields changed- 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”; Note: the keyword you specify must indicate the job title; example:.net developer 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/google/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 https://api.dataforseo.com/v3/serp/google/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; you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/jobs/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 https://api.dataforseo.com/v3/serp/google/jobs/locations example: London,England,United Kingdom" - 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 include advanced and 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, 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_google_local_finder_live8 fields changed- 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_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,20z" - 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 / min_rating / descriptionPrevious value: -"Minimum rating filter"New value: +"filter results by minimum rating optional field possible values for desktop: 3.5, 4, 4.5; possible values for mobile: 2, 2.5, 3, 3.5, 4, 4.5" - changed
Input schema / properties / body / items / properties / time_filter / descriptionPrevious value: -"Time filter"New value: +"filter results by open hours optional field using this field, you can filter places in the results by the time a place is open for visitors note that Google may also provide results that do not match this filter possible values: \"open_now\", \"24_hours\", \"$day_value\", \"$day_value;$time_value\"; instead of $day_value use one of these values: \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\", \"sunday\"; instead of $time_value use one of these values: \"00\", \"01\", \"02\", \"03\", \"04\", \"05\", \"06\", \"07\", \"08\", \"09\", \"10\", \"11\", \"12\", \"13\", \"14\", \"15\", \"16\", \"17\", \"18\", \"19\", \"20\", \"21\", \"22\", \"23\" example: \"tuesday;18\""
- Changed
post_dataforseo_serp_google_local_finder_live_html6 fields changed- 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”" - 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_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 9z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 4z the maximum value for \"zoom\": 18z example: 52.6178549,-155.352142,20z" - 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
post_dataforseo_serp_google_maps_live7 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: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page." - 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/google/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/google/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/google/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,zoom\" format if \"zoom\" is not specified, 17z will be applied as a default value the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"zoom\": 3z the maximum value for \"zoom\": 21z example: 52.6178549,-155.352142,20z" - 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/google/locations example: London,England,United Kingdom"
- Changed
post_dataforseo_serp_google_news_live7 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: 200 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; If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically The cost can be calculated on the Pricing page." - 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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200" - 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
post_dataforseo_serp_google_news_live_html6 fields changed- 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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error 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 locations 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 locations 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_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200" - 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
post_dataforseo_serp_google_organic_live12 fields changed- changed
Input schema / properties / body / items / properties / calculate_rectangles / descriptionPrevious value: -"Calculate pixel rankings for SERP elements"New value: +"calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false; Note: you will be charged extra $0.002 for using this parameter" - changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"Parsing depth, default 100, max 700"New value: +"parsing depth optional field number of results in SERP default value: 10 max value: 200 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: desktop or mobile"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”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5 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 optional field if you 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/google/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 optional field if you 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/google/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/google/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location optional field if you specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200" - 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/google/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / max_crawl_pages / descriptionPrevious value: -"Page crawl limit, max 100"New value: +"page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); learn more about pricing on our Pricing page; Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center" - 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 / tag / descriptionPrevious value: -"User-defined task identifier"New value: +"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response"
- Changed
post_dataforseo_serp_google_organic_live_html16 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"Parsing depth, default 100, max 700"New value: +"parsing depth optional field number of results in SERP default value: 10 max value: 200 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: desktop or mobile"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 / expand_ai_overview / descriptionPrevious value: -"Expand AI overview item"New value: +"expand ai overview optional field set to true to expand the ai_overview item; default value: false" - 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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5" - 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/google/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/google/languages example: English" - changed
Input schema / properties / body / items / properties / load_async_ai_overview / descriptionPrevious value: -"Load asynchronous AI overview"New value: +"load asynchronous ai overview optional field set to true to obtain ai_overview items is SERPs even if they are loaded asynchronously; if set to false, you will only obtain ai_overview items from cache; default value: false Note your account will be billed $0.002 extra for each request; if the element is absent or contains \"asynchronous_ai_overview\": false, all extra charges will be returned to your account balance" - 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/google/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200" - 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/google/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / max_crawl_pages / descriptionPrevious value: -"Page crawl limit, max 100"New value: +"page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); learn more about pricing on our Pricing page; Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center" - 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 / se_domain / descriptionPrevious value: -"Custom search engine domain"New value: +"search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc." - changed
Input schema / properties / body / items / properties / search_param / descriptionPrevious value: -"Additional parameters of the search query"New value: +"additional parameters of the search query optional field get the list of available parameters and additional details here Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype." - changed
Input schema / properties / body / items / properties / tag / descriptionPrevious value: -"User-defined task identifier"New value: +"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response" - changed
Input schema / properties / body / items / properties / url / descriptionPrevious value: -"Direct URL of the search query"New value: +"direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype."
- Changed
post_dataforseo_serp_google_organic_live_regular11 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"Parsing depth, default 100, max 700"New value: +"parsing depth optional field number of results in SERP default value: 10 max value: 200 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: desktop or mobile"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”; if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:', the charge per task will be multiplied by 5" - 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/google/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/google/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/google/locations example: 2840" - changed
Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200" - 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/google/locations example: London,England,United Kingdom" - changed
Input schema / properties / body / items / properties / max_crawl_pages / descriptionPrevious value: -"Page crawl limit, max 100"New value: +"page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page); learn more about pricing on our Pricing page; Note#2: the max_crawl_pages and depth parameters complement each other; learn more at our help center" - 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 / tag / descriptionPrevious value: -"User-defined task identifier"New value: +"user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response"
- Changed
post_dataforseo_serp_google_search_by_image_submit10 fields changed- changed
Input schema / properties / body / items / properties / image_url / descriptionPrevious value: -"Publicly accessible image URL used as the search input"New value: +"URL of the image required field the results will be based on the image you specified in this field example: https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg" - 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_coordinate / descriptionPrevious value: -"GPS coordinates of a location"New value: +"GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 (mm) the maximum value for \"radius\": 199999 (mm) example: 53.476225,-2.243572,200" - 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 / 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 include advanced and 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: 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."
43 tool updates
- First observed
batch_use - First observed
get_dataforseo_serp_gads_advertisers_locations - First observed
get_dataforseo_serp_gads_search_locations - First observed
get_dataforseo_serp_google_ai_mode_languages - First observed
get_dataforseo_serp_google_events_locations - First observed
get_dataforseo_serp_google_jobs_fetch - First observed
get_dataforseo_serp_google_jobs_fetch_html - First observed
get_dataforseo_serp_google_jobs_locations - First observed
get_dataforseo_serp_google_search_by_image_fetch - First observed
get_dataforseo_serp_google_search_by_image_fetch_html - First observed
get_details - First observed
get_semrush_organic_results - First observed
get_semrush_paid_results - First observed
list_categories - First observed
post_dataforseo_serp_gads_advertisers_live - First observed
post_dataforseo_serp_gads_search_live - First observed
post_dataforseo_serp_google_ai_mode_live - First observed
post_dataforseo_serp_google_ai_mode_live_html - First observed
post_dataforseo_serp_google_autocomplete_live - First observed
post_dataforseo_serp_google_dataset_info_live - First observed
post_dataforseo_serp_google_dataset_search_live - First observed
post_dataforseo_serp_google_events_live - First observed
post_dataforseo_serp_google_finance_explore_live - First observed
post_dataforseo_serp_google_finance_explore_live_html - First observed
post_dataforseo_serp_google_finance_markets_live - First observed
post_dataforseo_serp_google_finance_markets_live_html - First observed
post_dataforseo_serp_google_finance_quote_live - First observed
post_dataforseo_serp_google_finance_quote_live_html - First observed
post_dataforseo_serp_google_finance_ticker_search_live - First observed
post_dataforseo_serp_google_images_live - First observed
post_dataforseo_serp_google_images_live_html - First observed
post_dataforseo_serp_google_jobs_submit - First observed
post_dataforseo_serp_google_local_finder_live - First observed
post_dataforseo_serp_google_local_finder_live_html - First observed
post_dataforseo_serp_google_maps_live - First observed
post_dataforseo_serp_google_news_live - First observed
post_dataforseo_serp_google_news_live_html - First observed
post_dataforseo_serp_google_organic_live - First observed
post_dataforseo_serp_google_organic_live_html - First observed
post_dataforseo_serp_google_organic_live_regular - First observed
post_dataforseo_serp_google_search_by_image_submit - 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
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.
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 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.
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.
Related MCP Servers
- AlicenseAqualityCmaintenanceEnables AI agents to run live Google searches and retrieve organic results, snippets, sitelinks, People Also Ask, related searches, and Google's AI Overview with citations via a zero-dependency MCP server.2MIT
- AlicenseNot gradedqualityAmaintenanceEnables AI agents to run real Google searches through a self-hosted browser on their own IP or a proxy, returning typed JSON with organic results rewritten to their true destination URLs, AI Overviews, People also ask, related searches, and structured block errors. Requires no API key and works over MCP with any client.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
Try in Browser
Give agents eyes on the webHosted screenshot MCP. Send a URL, get a pixel-perfect image. $0.002 per grab. Works with Claude, Cursor, and Codex.grabbit.liveAd
Glama MCP Gateway
Add one secure layer between your agents and this server.