Scrape, search and extract the public web. 3,000 free credits at https://vera.waggle.ae/signup
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Your Vera API key as a Bearer token. Create a key, with 3,000 free credits, at https://vera.waggle.ae/signup.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Put a buyer's question to an AI assistant that searches the live web, and see whether a brand and its competitors are named in the answer, in what rank, with the citations and cited domains behind it. The assistant is ChatGPT unless `engine` names claude, perplexity or gemini; an assistant the server has no key for answers not_configured and costs nothing. `samples` (1 to 5, default 1) asks the same question more than once, for a mention rate. Returns metrics per assistant, not the raw answers. Charged per call to the assistant at the price list in credits (see llms.txt), the same as POST /v1/ai/answers: the worst case is held first, only the calls made are charged, and a call where the assistant failed is charged nothing. Gemini, when it searches Google, is a base price plus a price for each distinct search query it runs (the model decides how many; up to 10 a call are held for, and a call is only made when that worst case fits in what is held): you are charged for the queries that ran. The most the call can cost is held first and you are charged for what it returns; a call that fails costs nothing.
Brand name to look for in the answer
The question to put to the assistant, as a buyer would ask it
The assistant to ask
Two-letter ISO country code of the market
Times the question is asked of the assistant
Language tag of the market, for example en or ar
Competitor names or domains to track
The brand's domain, for example roasters.ae
Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again.
Put a buyer's question to an AI assistant that searches the live web, and see whether a brand and its competitors are named in the answer, in what rank, with the citations and cited domains behind it. The assistant is ChatGPT unless `engine` names claude, perplexity or gemini; an assistant the server has no key for answers not_configured and costs nothing. `samples` (1 to 5, default 1) asks the same question more than once, for a mention rate. Returns metrics per assistant, not the raw answers. Charged per call to the assistant at the price list in credits (see llms.txt), the same as POST /v1/ai/answers: the worst case is held first, only the calls made are charged, and a call where the assistant failed is charged nothing. Gemini, when it searches Google, is a base price plus a price for each distinct search query it runs (the model decides how many; up to 10 a call are held for, and a call is only made when that worst case fits in what is held): you are charged for the queries that ran. The most the call can cost is held first and you are charged for what it returns; a call that fails costs nothing.
| Argument | Type | Description |
|---|---|---|
| brand* | string | Brand name to look for in the answer |
| engine | string | The assistant to ask |
| prompt* | string | The question to put to the assistant, as a buyer would ask it |
| country | string | Two-letter ISO country code of the market |
| samples | integer | Times the question is asked of the assistant |
| language | string | Language tag of the market, for example en or ar |
| competitors | any | Competitor names or domains to track |
| brand_domain | any | The brand's domain, for example roasters.ae |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"title": "ai_answersArguments",
"required": [
"prompt",
"brand"
],
"properties": {
"brand": {
"type": "string",
"title": "Brand",
"description": "Brand name to look for in the answer"
},
"engine": {
"enum": [
"chatgpt",
"claude",
"perplexity",
"gemini"
],
"type": "string",
"title": "Engine",
"default": "chatgpt",
"description": "The assistant to ask"
},
"prompt": {
"type": "string",
"title": "Prompt",
"description": "The question to put to the assistant, as a buyer would ask it"
},
"country": {
"type": "string",
"title": "Country",
"default": "ae",
"description": "Two-letter ISO country code of the market"
},
"samples": {
"type": "integer",
"title": "Samples",
"default": 1,
"maximum": 5,
"minimum": 1,
"description": "Times the question is asked of the assistant"
},
"language": {
"type": "string",
"title": "Language",
"default": "en",
"description": "Language tag of the market, for example en or ar"
},
"competitors": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Competitors",
"default": null,
"description": "Competitor names or domains to track"
},
"brand_domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Brand Domain",
"default": null,
"description": "The brand's domain, for example roasters.ae"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
}
}Given a company's domain, read its homepage and up to 3 standard pages (about, contact, team) and return a profile: name, description, logo, address, founding date, emails, phones and social links, as the company publishes them. Costs 1 credit for each page read, at most 5 credits (that many are held while it runs and the unused ones are given back); a failed call costs nothing.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The company's domain or website address, for example example.com. |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"maxLength": 255,
"minLength": 3,
"description": "The company's domain or website address, for example example.com."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
},
"additionalProperties": false
}Audit a company's SERP digital footprint, brand reputation, owned domains, and entity profiles. Separates owned web properties, social/entity profiles (Wikipedia, LinkedIn, Instagram, Crunchbase), Google Maps locations, third-party mentions, and customer brand questions (PAA). The most the call can cost is held first and you are charged for what it returns; a call that fails costs nothing.
| Argument | Type | Description |
|---|---|---|
| gl | string | |
| hl | string | |
| depth | integer | |
| fresh | boolean | |
| domain | any | |
| company* | string | |
| location | string | |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
Read one public page and return the contact details it publishes: email addresses, phone numbers, social profile links and links to contact pages, each with where it was found. Published details are not verified, and linked pages are not followed (call this tool again for one). Costs 1 credit; a failed call costs nothing.
| Argument | Type | Description |
|---|---|---|
| url* | string | The full public http(s) address of the page. |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 8,
"description": "The full public http(s) address of the page."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
},
"additionalProperties": false
}Extract Google Local Pack (3-pack) and Google Places listings for local queries. Returns place_id/cid, title, rating, review count, address, latitude/longitude, category, phone, and website. The most the call can cost is held first and you are charged for what it returns; a call that fails costs nothing.
| Argument | Type | Description |
|---|---|---|
| gl | string | |
| hl | string | |
| fresh | boolean | |
| query* | string | |
| location | any | |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"title": "extract_local_placesArguments",
"required": [
"query"
],
"properties": {
"gl": {
"type": "string",
"title": "Gl",
"default": "us"
},
"hl": {
"type": "string",
"title": "Hl",
"default": "en"
},
"fresh": {
"type": "boolean",
"title": "Fresh",
"default": false
},
"query": {
"type": "string",
"title": "Query"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location",
"default": null
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
}
}Read one public product page and return the product data it publishes in its structured markup: name, brand, SKU or GTIN, and offers with price, currency and availability. Prices are what the page states, never guessed. Set marketplace to amazon, walmart or shopee for those product pages; these parsers are best-effort and large marketplaces often block automated requests. Costs 1 credit; a failed call costs nothing.
| Argument | Type | Description |
|---|---|---|
| url* | string | The full public http(s) address of the product page. |
| marketplace | string | Set to "amazon", "walmart" or "shopee" for a product page on that marketplace. |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 8,
"description": "The full public http(s) address of the product page."
},
"marketplace": {
"enum": [
"amazon",
"walmart",
"shopee"
],
"type": "string",
"description": "Set to \"amazon\", \"walmart\" or \"shopee\" for a product page on that marketplace."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
},
"additionalProperties": false
}Extract Google Shopping carousel listings for e-commerce and product queries. Returns product title, price, currency, merchant, rating, reviews, image URL, link, and product ID. The most the call can cost is held first and you are charged for what it returns; a call that fails costs nothing.
| Argument | Type | Description |
|---|---|---|
| gl | string | |
| hl | string | |
| fresh | boolean | |
| query* | string | |
| location | any | |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"title": "extract_shopping_resultsArguments",
"required": [
"query"
],
"properties": {
"gl": {
"type": "string",
"title": "Gl",
"default": "us"
},
"hl": {
"type": "string",
"title": "Hl",
"default": "en"
},
"fresh": {
"type": "boolean",
"title": "Fresh",
"default": false
},
"query": {
"type": "string",
"title": "Query"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location",
"default": null
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
}
}Search Google and filter organic results (positions 1-100) specifically for community discussions and forum threads (Reddit, Quora, HackerNews, StackExchange, niche forums). Ideal for sentiment analysis, user discussions, and customer problem discovery. The most the call can cost is held first and you are charged for what it returns; a call that fails costs nothing.
| Argument | Type | Description |
|---|---|---|
| gl | string | |
| hl | string | |
| depth | integer | |
| fresh | boolean | |
| query* | string | |
| location | any | |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"title": "find_discussion_candidatesArguments",
"required": [
"query"
],
"properties": {
"gl": {
"type": "string",
"title": "Gl",
"default": "us"
},
"hl": {
"type": "string",
"title": "Hl",
"default": "en"
},
"depth": {
"type": "integer",
"title": "Depth",
"default": 30
},
"fresh": {
"type": "boolean",
"title": "Fresh",
"default": false
},
"query": {
"type": "string",
"title": "Query"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location",
"default": null
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
}
}Run GEO Citation & Injection Radar for a topic query and brand. Calculates citation probability score (0-100), identifies high-impact Reddit/Quora threads with injection playbooks, extracts listicle PR outreach targets with Vera contacts payload, discovers AEO question gaps from PAA, and produces an LLM-ready markdown injection brief. The most the call can cost is held first and you are charged for what it returns; a call that fails costs nothing.
| Argument | Type | Description |
|---|---|---|
| gl | string | |
| hl | string | |
| brand | any | |
| depth | integer | |
| fresh | boolean | |
| query* | string | |
| domain | any | |
| engine | string | |
| location | string | |
| idempotency_key |
Execute a full Google SERP search query with strict Google provenance (depth 10 to 100). Returns verified Google organic results with classification tagging (forums, video, ecommerce) and the results page's features (AI Overview, PAA, Knowledge Graph). The local pack and shopping are add-ons: set local_pack and/or shopping to true to include them. A result searched in the last 24 hours is served from the cache at a lower price; set fresh to true to search live. The most the call can cost is held first and you are charged for what it returns; a call that fails costs nothing.
| Argument | Type | Description |
|---|---|---|
| gl | string | |
| hl | string | |
| depth | integer | |
| fresh | boolean | |
| query* | string | |
| location | any | |
| shopping | boolean | |
| local_pack | boolean | |
| idempotency_key | string |
Keyword ideas for a seed keyword from Google autocomplete (the seed plus question words or the alphabet), People Also Ask and related searches, cleaned and de-duplicated. Each idea carries its sources and an intent label (question, comparison, commercial, local, informational). Works in Arabic. Ideas only: no search volumes. Charged for the results page (7 credits live, 1 from your cache) plus 7 credits for each autocomplete call that returns suggestions, so at most 14 credits for expand 'none', 70 for 'questions' (the default), 196 for 'alphabet' (210 for an Arabic seed) and 217 for 'all'; it stops early once `limit` ideas are found, which is 12. Set fresh to true to search the results page live; autocomplete is always live. The most the call can cost is held first and you are charged for what it returns; a call that fails costs nothing.
| Argument | Type | Description |
|---|---|---|
| gl | any | |
| hl | any | |
| seed* | string | |
| fresh | boolean | |
| limit | integer | |
| expand | any | |
| location | any | |
| location_code |
Read one public web page and return its content: the main text (as Markdown with response_format="markdown"), links, metadata and a quality score, plus the raw HTML if you ask (return_html). Set render=true for pages that build their content with JavaScript, or mode="auto" to render only when a plain fetch comes back empty. extract pulls named fields out with CSS selectors. Costs 1 credit for a plain fetch and 5 credits when the page is rendered; with return_html a plain fetch costs 1 credit for each started 400 KB of HTML returned, at most 5. A failed call costs nothing. Pages that disallow automated access or need a login cannot be read.
| Argument | Type | Description |
|---|---|---|
| url* | string | The full public http(s) address of the page. |
| mode | string | "manual" (the default) does what render says. "auto" fetches the page plainly and renders it only when it looks empty; it holds up to max_cost credits and charges what it used. |
| render | boolean | Run the page's JavaScript in a browser first, for pages that build their content in the browser. Costs more. |
| country | string | Two-letter country code for the language headers of the request, for example ae or gb. It does not route the request through that country. |
| extract | object | Named fields to pull out with a CSS selector, for example {"heading":{"selector":"h1"},"links":{"selector":"a","attribute":"href", "multiple":true}}. One tag, class, ID or attribute selector each. Static pages only. |
Search Google and return the results: titles, URLs and snippets, plus Google's own answer boxes, People Also Ask and related searches when it shows them. vertical picks web (the default), news or videos. Returns up to 100 results per call (10 by default), with country and language. Costs 7 credits per call whatever the vertical or limit; a failed search costs nothing. Results are links and snippets: use scrape to read a page.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many results to return (10 by default). The price is the same whatever the number. |
| query* | string | What to search for. Quoted phrases and site: operators are kept. |
| country | string | Two lowercase letters for the search market, for example us, gb or ae (default "us"). |
| language | string | Two lowercase letters for the result language, for example en or ar (default "en"). |
| vertical | string | "web" (the default), "news" or "videos". |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
Audit one public page's technical SEO and how ready it is for AI search: title, description, canonical, robots and indexing directives, headings, links, images, structured data and a score. Costs 1 credit, or 5 credits with render=true (audited after its JavaScript runs); a failed call costs nothing.
| Argument | Type | Description |
|---|---|---|
| url* | string | The full public http(s) address of the page. |
| render | boolean | Audit the page after its JavaScript has run. Costs more. |
| country | string | Two-letter country code for the language headers of the request, for example ae or gb. It does not route the request through that country. |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 8,
"description": "The full public http(s) address of the page."
},
"render": {
"type": "boolean",
"default": false,
"description": "Audit the page after its JavaScript has run. Costs more."
},
"country": {
"type": "string",
"pattern": "^[a-zA-Z]{2}$",
"description": "Two-letter country code for the language headers of the request, for example ae or gb. It does not route the request through that country."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
},
"additionalProperties": false
}Read a site's sitemap.xml (or a sitemap index) and return the page addresses it lists, up to limit (100 by default), optionally only those containing some text. Costs 1 credit; a failed call costs nothing.
| Argument | Type | Description |
|---|---|---|
| url* | string | The address of the sitemap.xml, or of a sitemap index. |
| limit | integer | How many page addresses to return (100 by default). |
| filter_pattern | string | Keep only addresses that contain this text. |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 8,
"description": "The address of the sitemap.xml, or of a sitemap index."
},
"limit": {
"type": "integer",
"default": 100,
"maximum": 1000,
"minimum": 1,
"description": "How many page addresses to return (100 by default)."
},
"filter_pattern": {
"type": "string",
"maxLength": 200,
"description": "Keep only addresses that contain this text."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
},
"additionalProperties": false
}Return the transcript of one public YouTube video as text. Costs 6 credits per started minute of video (a 10-minute video costs 60), up to 45 minutes. A video that cannot be transcribed, or any failure, costs nothing.
| Argument | Type | Description |
|---|---|---|
| url* | string | The link of a public YouTube video, like https://www.youtube.com/watch?v=... |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 8,
"description": "The link of a public YouTube video, like https://www.youtube.com/watch?v=..."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
},
"additionalProperties": false
}{
"type": "object",
"title": "company_serp_footprintArguments",
"required": [
"company"
],
"properties": {
"gl": {
"type": "string",
"title": "Gl",
"default": "ae"
},
"hl": {
"type": "string",
"title": "Hl",
"default": "en"
},
"depth": {
"type": "integer",
"title": "Depth",
"default": 20
},
"fresh": {
"type": "boolean",
"title": "Fresh",
"default": false
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain",
"default": null
},
"company": {
"type": "string",
"title": "Company"
},
"location": {
"type": "string",
"title": "Location",
"default": "Dubai"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
}
}| string |
| Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"title": "geo_citation_radarArguments",
"required": [
"query"
],
"properties": {
"gl": {
"type": "string",
"title": "Gl",
"default": "ae"
},
"hl": {
"type": "string",
"title": "Hl",
"default": "en"
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Brand",
"default": null
},
"depth": {
"type": "integer",
"title": "Depth",
"default": 30
},
"fresh": {
"type": "boolean",
"title": "Fresh",
"default": false
},
"query": {
"type": "string",
"title": "Query"
},
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain",
"default": null
},
"engine": {
"type": "string",
"title": "Engine",
"default": "google"
},
"location": {
"type": "string",
"title": "Location",
"default": "Dubai"
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
}
}| Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"title": "google_serpArguments",
"required": [
"query"
],
"properties": {
"gl": {
"type": "string",
"title": "Gl",
"default": "us"
},
"hl": {
"type": "string",
"title": "Hl",
"default": "en"
},
"depth": {
"type": "integer",
"title": "Depth",
"default": 10
},
"fresh": {
"type": "boolean",
"title": "Fresh",
"default": false
},
"query": {
"type": "string",
"title": "Query"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location",
"default": null
},
"shopping": {
"type": "boolean",
"title": "Shopping",
"default": false
},
"local_pack": {
"type": "boolean",
"title": "Local Pack",
"default": false
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
}
}| any |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
{
"type": "object",
"title": "keyword_ideasArguments",
"required": [
"seed"
],
"properties": {
"gl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Gl",
"default": null
},
"hl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Hl",
"default": null
},
"seed": {
"type": "string",
"title": "Seed"
},
"fresh": {
"type": "boolean",
"title": "Fresh",
"default": false
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 50
},
"expand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Expand",
"default": null
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location",
"default": null
},
"location_code": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Location Code",
"default": null
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
}
}| wait_ms | integer | Milliseconds to wait after the page loads. Needs render=true. |
| max_cost | integer | With mode=auto, the most to spend: 1 never renders, 5 may render. |
| wait_for | string | A CSS selector to wait for before reading. Needs render=true. |
| return_html | boolean | Also return the page's raw HTML in data.html (up to 2 MB). Costs 1 credit for each started 400 KB of HTML returned, at most 5. Not with extract. |
| idempotency_key | string | Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again. |
| response_format | string | Use "markdown" to get the page's main content as Markdown in data.markdown, the best form for reading or summarising. "all" (the default) and "text" return the standard fields: text, links, metadata and a quality score. |
| min_quality_score | integer | Refuse the page, at no charge, when its quality score is below this. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 8,
"description": "The full public http(s) address of the page."
},
"mode": {
"enum": [
"manual",
"auto"
],
"type": "string",
"default": "manual",
"description": "\"manual\" (the default) does what render says. \"auto\" fetches the page plainly and renders it only when it looks empty; it holds up to max_cost credits and charges what it used."
},
"render": {
"type": "boolean",
"default": false,
"description": "Run the page's JavaScript in a browser first, for pages that build their content in the browser. Costs more."
},
"country": {
"type": "string",
"pattern": "^[a-zA-Z]{2}$",
"description": "Two-letter country code for the language headers of the request, for example ae or gb. It does not route the request through that country."
},
"extract": {
"type": "object",
"description": "Named fields to pull out with a CSS selector, for example {\"heading\":{\"selector\":\"h1\"},\"links\":{\"selector\":\"a\",\"attribute\":\"href\", \"multiple\":true}}. One tag, class, ID or attribute selector each. Static pages only.",
"maxProperties": 10,
"additionalProperties": {
"type": "object",
"required": [
"selector"
],
"properties": {
"multiple": {
"type": "boolean",
"default": false
},
"selector": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"attribute": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]{0,63}$"
}
},
"additionalProperties": false
}
},
"wait_ms": {
"type": "integer",
"default": 500,
"maximum": 3000,
"minimum": 0,
"description": "Milliseconds to wait after the page loads. Needs render=true."
},
"max_cost": {
"type": "integer",
"maximum": 5,
"minimum": 1,
"description": "With mode=auto, the most to spend: 1 never renders, 5 may render."
},
"wait_for": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "A CSS selector to wait for before reading. Needs render=true."
},
"return_html": {
"type": "boolean",
"default": false,
"description": "Also return the page's raw HTML in data.html (up to 2 MB). Costs 1 credit for each started 400 KB of HTML returned, at most 5. Not with extract."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
},
"response_format": {
"enum": [
"text",
"markdown",
"all"
],
"type": "string",
"default": "all",
"description": "Use \"markdown\" to get the page's main content as Markdown in data.markdown, the best form for reading or summarising. \"all\" (the default) and \"text\" return the standard fields: text, links, metadata and a quality score."
},
"min_quality_score": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "Refuse the page, at no charge, when its quality score is below this."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"query"
],
"properties": {
"limit": {
"type": "integer",
"default": 10,
"maximum": 100,
"minimum": 1,
"description": "How many results to return (10 by default). The price is the same whatever the number."
},
"query": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "What to search for. Quoted phrases and site: operators are kept."
},
"country": {
"type": "string",
"default": "us",
"pattern": "^[a-z]{2}$",
"description": "Two lowercase letters for the search market, for example us, gb or ae (default \"us\")."
},
"language": {
"type": "string",
"default": "en",
"pattern": "^[a-z]{2}$",
"description": "Two lowercase letters for the result language, for example en or ar (default \"en\")."
},
"vertical": {
"enum": [
"web",
"news",
"videos"
],
"type": "string",
"default": "web",
"description": "\"web\" (the default), \"news\" or \"videos\"."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]+$",
"maxLength": 128,
"minLength": 16,
"description": "Optional. Send the same key (16 to 128 letters, digits, _ . : -) to retry this exact call safely: a retry within 24 hours returns the first result and is not charged again."
}
},
"additionalProperties": false
}