diff --git a/Dockerfile b/Dockerfile index bc4264c..f24d45d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,6 +7,7 @@ WORKDIR /app COPY pyproject.toml /app/ COPY README.md /app/ COPY src /app/src +COPY engines /app/engines RUN uv sync diff --git a/README.md b/README.md index 52df07d..39a2d8d 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ A Model Context Protocol (MCP) server implementation that integrates with [SerpA ## Features - **Multi-Engine Search**: Google, Bing, Yahoo, DuckDuckGo, YouTube, eBay, and [more](https://serpapi.com/search-engine-apis) +- **Engine Resources**: Per-engine parameter schemas available via MCP resources (see Search Tool) - **Real-time Weather Data**: Location-based weather with forecasts via search queries - **Stock Market Data**: Company financials and market data through search integration - **Dynamic Result Processing**: Automatically detects and formats different result types @@ -68,6 +69,7 @@ curl "https://mcp.serpapi.com/mcp" -H "Authorization: Bearer your_key" -d '...' ## Search Tool The MCP server has one main Search Tool that supports all SerpApi engines and result types. You can find all available parameters on the [SerpApi API reference](https://serpapi.com/search-api). +Engine parameter schemas are also exposed as MCP resources: `serpapi://engines` (index) and `serpapi://engines/`. The parameters you can provide are specific for each API engine. Some sample parameters are provided below: @@ -87,7 +89,7 @@ The parameters you can provide are specific for each API engine. Some sample par {"name": "search", "arguments": {"params": {"q": "detailed search"}, "mode": "complete"}} ``` -**Supported Engines:** Google, Bing, Yahoo, DuckDuckGo, YouTube, eBay, and more. +**Supported Engines:** Google, Bing, Yahoo, DuckDuckGo, YouTube, eBay, and more (see `serpapi://engines`). **Result Types:** Answer boxes, organic results, news, images, shopping - automatically detected and formatted. diff --git a/engines/amazon.json b/engines/amazon.json new file mode 100644 index 0000000..2469a27 --- /dev/null +++ b/engines/amazon.json @@ -0,0 +1,418 @@ +{ + "engine": "amazon", + "params": { + "k": { + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Amazon search.", + "group": "search_query" + }, + "amazon_domain": { + "type": "select", + "options": [ + "amazon.com.au", + "amazon.com.be", + "amazon.com.br", + "amazon.ca", + "amazon.cn", + "amazon.eg", + "amazon.fr", + "amazon.de", + "amazon.in", + "amazon.it", + "amazon.co.jp", + "amazon.nl", + "amazon.pl", + "amazon.sa", + "amazon.sg", + "amazon.es", + "amazon.se", + "amazon.com.tr", + "amazon.ae", + "amazon.co.uk", + "amazon.com", + "amazon.com.mx" + ], + "description": "Parameter defines the Amazon domain to use. It defaults to `amazon.com`. Head to Amazon domains for a full list of supported Amazon domains.", + "group": "localization" + }, + "language": { + "type": "select", + "options": [ + "amazon.com.au|en_AU", + "amazon.com.be|nl_BE", + "amazon.com.be|fr_BE", + "amazon.com.be|en_GB", + "amazon.com.br|pt_BR", + "amazon.ca|en_CA", + "amazon.ca|fr_CA", + "amazon.cn|zh_CN", + "amazon.eg|ar_AE", + "amazon.eg|en_AE", + "amazon.fr|fr_FR", + "amazon.fr|en_GB", + "amazon.de|de_DE", + "amazon.de|en_GB", + "amazon.de|cs_CZ", + "amazon.de|nl_NL", + "amazon.de|pl_PL", + "amazon.de|tr_TR", + "amazon.de|da_DK", + "amazon.in|en_IN", + "amazon.in|hi_IN", + "amazon.in|ta_IN", + "amazon.in|te_IN", + "amazon.in|kn_IN", + "amazon.in|ml_IN", + "amazon.in|bn_IN", + "amazon.in|mr_IN", + "amazon.it|it_IT", + "amazon.it|en_GB", + "amazon.co.jp|ja_JP", + "amazon.co.jp|en_US", + "amazon.co.jp|zh_CN", + "amazon.nl|nl_NL", + "amazon.nl|en_GB", + "amazon.pl|pl_PL", + "amazon.sa|ar_AE", + "amazon.sa|en_AE", + "amazon.sg|en_SG", + "amazon.es|es_ES", + "amazon.es|pt_PT", + "amazon.es|en_GB", + "amazon.se|sv_SE", + "amazon.se|en_GB", + "amazon.com.tr|tr_TR", + "amazon.ae|en_AE", + "amazon.ae|ar_AE", + "amazon.co.uk|en_GB", + "amazon.com|en_US", + "amazon.com|es_US", + "amazon.com.mx|pt_MX" + ], + "description": "Parameter defines the language to use for the Amazon search. It's a locale name represented as _. (e.g., on amazon.com `en_US` for English, `es_US` for Spanish, or on amazon.co.jp `ja_JP` for Japanese). Head to Amazon languages for a full list of supported Amazon languages.", + "group": "localization" + }, + "delivery_zip": { + "description": "ZIP Postal code. To filter the shipping products by a selected area.", + "group": "advanced_amazon_parameters" + }, + "shipping_location": { + "type": "select", + "options": [ + "AU", + "CA", + "CN", + "JP", + "MX", + "SG", + "GB", + "AF", + "AX", + "AL", + "DZ", + "AS", + "AD", + "AO", + "AI", + "AG", + "AR", + "AM", + "AW", + "AT", + "AZ", + "BS", + "BH", + "BD", + "BB", + "BY", + "BE", + "BZ", + "BJ", + "BM", + "BT", + "BO", + "BQ", + "BA", + "BW", + "BV", + "BR", + "IO", + "BN", + "BG", + "BF", + "BI", + "KH", + "CM", + "CV", + "KY", + "CF", + "TD", + "CL", + "CX", + "CC", + "CO", + "KM", + "CG", + "CD", + "CK", + "CR", + "CI", + "HR", + "CW", + "CY", + "CZ", + "DK", + "DJ", + "DM", + "DO", + "EC", + "EG", + "SV", + "GQ", + "ER", + "EE", + "ET", + "FK", + "FO", + "FJ", + "FI", + "FR", + "GF", + "PF", + "TF", + "GA", + "GM", + "GE", + "DE", + "GH", + "GI", + "GR", + "GL", + "GD", + "GP", + "GT", + "GG", + "GN", + "GW", + "GY", + "HT", + "HM", + "VA", + "HN", + "HK", + "HU", + "IS", + "IN", + "ID", + "IQ", + "IE", + "IM", + "IL", + "IT", + "JM", + "JE", + "JO", + "KZ", + "KE", + "KI", + "XK", + "KW", + "KG", + "LA", + "LV", + "LB", + "LS", + "LR", + "LY", + "LI", + "LT", + "LU", + "MO", + "MK", + "MG", + "MW", + "MY", + "MV", + "ML", + "MT", + "MH", + "MQ", + "MR", + "MU", + "YT", + "FM", + "MD", + "MC", + "MN", + "ME", + "MS", + "MA", + "MZ", + "MM", + "NA", + "NR", + "NP", + "NL", + "AN", + "NC", + "NZ", + "NI", + "NE", + "NG", + "NU", + "NF", + "NO", + "OM", + "PK", + "PW", + "PS", + "PA", + "PG", + "PY", + "PE", + "PH", + "PN", + "PL", + "PT", + "QA", + "KR", + "RE", + "RO", + "RU", + "RW", + "BL", + "SH", + "KN", + "LC", + "MF", + "PM", + "VC", + "WS", + "SM", + "ST", + "SA", + "SN", + "RS", + "SC", + "SL", + "SX", + "SK", + "SI", + "SB", + "SO", + "ZA", + "ES", + "LK", + "SR", + "SZ", + "SE", + "CH", + "TW", + "TJ", + "TZ", + "TH", + "TL", + "TG", + "TK", + "TO", + "TT", + "TN", + "TR", + "TM", + "TC", + "TV", + "UG", + "UA", + "AE", + "US", + "UY", + "UZ", + "VU", + "VE", + "VN", + "VG", + "VI", + "WF", + "EH", + "YE", + "ZM", + "ZW" + ], + "description": "Shipping country. To filter the shipping products by a selected country.", + "group": "advanced_amazon_parameters" + }, + "s": { + "type": "select", + "options": [ + "relevanceblender", + "price-asc-rank", + "price-desc-rank", + "review-rank", + "date-desc-rank", + "exact-aware-popularity-rank" + ], + "description": "Parameter is used for sorting results. Available options: `relevanceblender` - Featured (default) `price-asc-rank` - Price: Low to High `price-desc-rank` - Price: High to Low `review-rank` - Avg. Customer Review `date-desc-rank` - Newest Arrivals `exact-aware-popularity-rank` - Best Sellers", + "group": "advanced_amazon_parameters" + }, + "node": { + "description": "Parameter specifies the category for Amazon search results. You can find the appropriate node value by browsing Amazon\u2019s website and accessing a specific category. The node ID is typically included in the URL after the format `node=[NODE ID]`. For example, on Amazon.com, the node for Smart Home is `6563140011`, and on Amazon.co.uk, the node for Fashion is `11961407031`. Use this node value to filter search results by category.", + "group": "advanced_filters" + }, + "rh": { + "description": "Parameter defines items filtering based on their attributes. The structure is a list of `key:value` pairs separated by `,`. For example `n:16318031,p_n_cpf_eligible:21512497011,p_72:1248897011` to filter for products in Coffee department (`n:16318031`) that are Climate Pledge Friendly (`p_n_cpf_eligible:21512497011`) and rated 4 Stars & Up (`p_72:1248897011`).", + "group": "advanced_filters" + }, + "dc": { + "type": "checkbox", + "description": "Activate spelling fix. `true` (default) includes spelling fix, `false` searches without spelling fix.", + "group": "advanced_filters" + }, + "page": { + "type": "number", + "description": "Parameter defines the page number. It's used for pagination. (e.g., `1` (default) is the first page of results, `2` is the 2nd page of results, `3` is the 3rd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `amazon` to use the Amazon API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Amazon results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/amazon_product.json b/engines/amazon_product.json new file mode 100644 index 0000000..77cb3a1 --- /dev/null +++ b/engines/amazon_product.json @@ -0,0 +1,392 @@ +{ + "engine": "amazon_product", + "params": { + "asin": { + "description": "Parameter defines the Amazon Standard Identification Number (ASIN) of the product you want to retrieve. This is a unique identifier assigned to each product on Amazon.", + "group": "search_query" + }, + "amazon_domain": { + "type": "select", + "options": [ + "amazon.com.au", + "amazon.com.be", + "amazon.com.br", + "amazon.ca", + "amazon.cn", + "amazon.eg", + "amazon.fr", + "amazon.de", + "amazon.in", + "amazon.it", + "amazon.co.jp", + "amazon.nl", + "amazon.pl", + "amazon.sa", + "amazon.sg", + "amazon.es", + "amazon.se", + "amazon.com.tr", + "amazon.ae", + "amazon.co.uk", + "amazon.com", + "amazon.com.mx" + ], + "description": "Parameter defines the Amazon domain to use. It defaults to `amazon.com`. Head to Amazon domains for a full list of supported Amazon domains.", + "group": "localization" + }, + "language": { + "type": "select", + "options": [ + "amazon.com.au|en_AU", + "amazon.com.be|nl_BE", + "amazon.com.be|fr_BE", + "amazon.com.be|en_GB", + "amazon.com.br|pt_BR", + "amazon.ca|en_CA", + "amazon.ca|fr_CA", + "amazon.cn|zh_CN", + "amazon.eg|ar_AE", + "amazon.eg|en_AE", + "amazon.fr|fr_FR", + "amazon.fr|en_GB", + "amazon.de|de_DE", + "amazon.de|en_GB", + "amazon.de|cs_CZ", + "amazon.de|nl_NL", + "amazon.de|pl_PL", + "amazon.de|tr_TR", + "amazon.de|da_DK", + "amazon.in|en_IN", + "amazon.in|hi_IN", + "amazon.in|ta_IN", + "amazon.in|te_IN", + "amazon.in|kn_IN", + "amazon.in|ml_IN", + "amazon.in|bn_IN", + "amazon.in|mr_IN", + "amazon.it|it_IT", + "amazon.it|en_GB", + "amazon.co.jp|ja_JP", + "amazon.co.jp|en_US", + "amazon.co.jp|zh_CN", + "amazon.nl|nl_NL", + "amazon.nl|en_GB", + "amazon.pl|pl_PL", + "amazon.sa|ar_AE", + "amazon.sa|en_AE", + "amazon.sg|en_SG", + "amazon.es|es_ES", + "amazon.es|pt_PT", + "amazon.es|en_GB", + "amazon.se|sv_SE", + "amazon.se|en_GB", + "amazon.com.tr|tr_TR", + "amazon.ae|en_AE", + "amazon.ae|ar_AE", + "amazon.co.uk|en_GB", + "amazon.com|en_US", + "amazon.com|es_US", + "amazon.com.mx|pt_MX" + ], + "description": "Parameter defines the language to use for the Amazon search. It's a locale name represented as _. (e.g., on amazon.com `en_US` for English, `es_US` for Spanish, or on amazon.co.jp `ja_JP` for Japanese). Head to Amazon languages for a full list of supported Amazon languages.", + "group": "localization" + }, + "delivery_zip": { + "description": "ZIP Postal code. To filter the shipping products by a selected area.", + "group": "advanced_amazon_parameters" + }, + "shipping_location": { + "type": "select", + "options": [ + "AU", + "CA", + "CN", + "JP", + "MX", + "SG", + "GB", + "AF", + "AX", + "AL", + "DZ", + "AS", + "AD", + "AO", + "AI", + "AG", + "AR", + "AM", + "AW", + "AT", + "AZ", + "BS", + "BH", + "BD", + "BB", + "BY", + "BE", + "BZ", + "BJ", + "BM", + "BT", + "BO", + "BQ", + "BA", + "BW", + "BV", + "BR", + "IO", + "BN", + "BG", + "BF", + "BI", + "KH", + "CM", + "CV", + "KY", + "CF", + "TD", + "CL", + "CX", + "CC", + "CO", + "KM", + "CG", + "CD", + "CK", + "CR", + "CI", + "HR", + "CW", + "CY", + "CZ", + "DK", + "DJ", + "DM", + "DO", + "EC", + "EG", + "SV", + "GQ", + "ER", + "EE", + "ET", + "FK", + "FO", + "FJ", + "FI", + "FR", + "GF", + "PF", + "TF", + "GA", + "GM", + "GE", + "DE", + "GH", + "GI", + "GR", + "GL", + "GD", + "GP", + "GT", + "GG", + "GN", + "GW", + "GY", + "HT", + "HM", + "VA", + "HN", + "HK", + "HU", + "IS", + "IN", + "ID", + "IQ", + "IE", + "IM", + "IL", + "IT", + "JM", + "JE", + "JO", + "KZ", + "KE", + "KI", + "XK", + "KW", + "KG", + "LA", + "LV", + "LB", + "LS", + "LR", + "LY", + "LI", + "LT", + "LU", + "MO", + "MK", + "MG", + "MW", + "MY", + "MV", + "ML", + "MT", + "MH", + "MQ", + "MR", + "MU", + "YT", + "FM", + "MD", + "MC", + "MN", + "ME", + "MS", + "MA", + "MZ", + "MM", + "NA", + "NR", + "NP", + "NL", + "AN", + "NC", + "NZ", + "NI", + "NE", + "NG", + "NU", + "NF", + "NO", + "OM", + "PK", + "PW", + "PS", + "PA", + "PG", + "PY", + "PE", + "PH", + "PN", + "PL", + "PT", + "QA", + "KR", + "RE", + "RO", + "RU", + "RW", + "BL", + "SH", + "KN", + "LC", + "MF", + "PM", + "VC", + "WS", + "SM", + "ST", + "SA", + "SN", + "RS", + "SC", + "SL", + "SX", + "SK", + "SI", + "SB", + "SO", + "ZA", + "ES", + "LK", + "SR", + "SZ", + "SE", + "CH", + "TW", + "TJ", + "TZ", + "TH", + "TL", + "TG", + "TK", + "TO", + "TT", + "TN", + "TR", + "TM", + "TC", + "TV", + "UG", + "UA", + "AE", + "US", + "UY", + "UZ", + "VU", + "VE", + "VN", + "VG", + "VI", + "WF", + "EH", + "YE", + "ZM", + "ZW" + ], + "description": "Shipping country. To filter the shipping products by a selected country.", + "group": "advanced_amazon_parameters" + }, + "other_sellers": { + "type": "checkbox", + "description": "Include results from other sellers.", + "group": "advanced_amazon_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `amazon_product` to use the Amazon Product API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Amazon Product results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/apple_app_store.json b/engines/apple_app_store.json new file mode 100644 index 0000000..9071352 --- /dev/null +++ b/engines/apple_app_store.json @@ -0,0 +1,456 @@ +{ + "engine": "apple_app_store", + "params": { + "term": { + "required": true, + "description": "Parameter defines the query you want to search. You can use any search term that you would use in a regular App Store search. (e.g. `Coffee`)", + "group": "search_query" + }, + "country": { + "required": false, + "type": "select", + "options": [ + "al", + "dz", + "ao", + "ai", + "ag", + "ar", + "am", + "au", + "at", + "az", + "bs", + "bh", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "bw", + "br", + "vg", + "bn", + "bg", + "bf", + "kh", + "ca", + "cv", + "ky", + "cl", + "td", + "cn", + "co", + "cd", + "cr", + "hr", + "cy", + "cz", + "dk", + "dm", + "do", + "ec", + "eg", + "sv", + "ee", + "fj", + "fi", + "fr", + "de", + "gm", + "gb", + "gh", + "gr", + "gd", + "gt", + "gw", + "gy", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ie", + "il", + "it", + "jm", + "jp", + "jo", + "kz", + "ke", + "kw", + "kg", + "la", + "lv", + "lb", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "ml", + "mt", + "mr", + "mu", + "mx", + "fm", + "md", + "mn", + "ms", + "mz", + "na", + "np", + "nl", + "nz", + "ni", + "ne", + "ng", + "no", + "om", + "pk", + "pw", + "pa", + "pg", + "py", + "pe", + "ph", + "pl", + "pt", + "qa", + "ro", + "ru", + "st", + "sa", + "sn", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "za", + "kr", + "es", + "lk", + "kn", + "lc", + "vc", + "sr", + "sz", + "se", + "ch", + "tw", + "tj", + "tz", + "th", + "tt", + "tn", + "tr", + "tm", + "tc", + "ug", + "ua", + "ae", + "us", + "uy", + "uz", + "ve", + "vn", + "ye", + "zw" + ], + "description": "Parameter defines the country to use for the search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Apple Regions for a full list of supported Apple Regions", + "group": "localization" + }, + "lang": { + "required": false, + "type": "select", + "options": [ + "pt-br", + "it-it", + "hi-in", + "ca-es", + "es-es", + "zh-tw", + "th-th", + "da-dk", + "fi-fi", + "en-gb", + "nl-nl", + "pl-pl", + "ro-ro", + "zh-cn", + "no-no", + "pt-pt", + "de-ch", + "uk-ua", + "en-us", + "vi-vi", + "sv-se", + "en-ca", + "fr-fr", + "sk-sk", + "zh-hk", + "hr-hr", + "en-au", + "ko-kr", + "tr-tr", + "el-gr", + "ms-my", + "id-id", + "cs-cz", + "hu-hu", + "fr-ca", + "es-mx", + "de-de", + "ru-ru", + "ja-jp" + ], + "description": "Parameter defines the language to use for the search. It's a four-letter country code. (e.g., `en-us` (default) for the English, `fr-fr` for French, or `uk-ua` for Ukrainian). Head to the Apple Languages for a full list of supported Apple Languages", + "group": "localization" + }, + "num": { + "type": "number", + "required": false, + "description": "Parameter defines the number of results you want to get per each page. It defaults to `10`. Maximum number of results you can get per page is `200`. Any number greater than maximum number will default to `200`.", + "group": "pagination" + }, + "disallow_explicit": { + "required": false, + "type": "checkbox", + "description": "Parameter defines the filter for disallowing explicit apps. It defaults to `false`.", + "group": "advanced_parameters" + }, + "property": { + "required": false, + "type": "select", + "options": [ + "developer" + ], + "description": "Parameter allows to search the property of an app. `developer` allows searching the developer title of an app ( e.g., property=`developer` and term=`Coffee` gives apps with \"Coffee\" in their developer's name. (Ex: `Coffee Inc.`)", + "group": "advanced_parameters" + }, + "category_id": { + "required": false, + "type": "select", + "options": [ + [ + "6018", + "Books - 6018" + ], + [ + "6000", + "Business - 6000" + ], + [ + "6026", + "Developer Tools - 6026" + ], + [ + "6017", + "Education - 6017" + ], + [ + "6016", + "Entertainment - 6016" + ], + [ + "6015", + "Finance - 6015" + ], + [ + "6023", + "Food & Drink - 6023" + ], + [ + "6014", + "Games - 6014" + ], + [ + "7001", + "Games: Action - 7001" + ], + [ + "7002", + "Games: Adventure - 7002" + ], + [ + "7003", + "Games: Casual - 7003" + ], + [ + "7004", + "Games: Board - 7004" + ], + [ + "7005", + "Games: Card - 7005" + ], + [ + "7006", + "Games: Casino - 7006" + ], + [ + "7009", + "Games: Family - 7009" + ], + [ + "7011", + "Games: Music - 7011" + ], + [ + "7012", + "Games: Puzzle - 7012" + ], + [ + "7013", + "Games: Racing - 7013" + ], + [ + "7014", + "Games: Role Playing - 7014" + ], + [ + "7015", + "Games: Simulation - 7015" + ], + [ + "7016", + "Games: Sports - 7016" + ], + [ + "7017", + "Games: Strategy - 7017" + ], + [ + "7018", + "Games: Trivia - 7018" + ], + [ + "7019", + "Games: Word - 7019" + ], + [ + "6027", + "Graphics & Design - 6027" + ], + [ + "6013", + "Health & Fitness - 6013" + ], + [ + "6012", + "Lifestyle - 6012" + ], + [ + "6021", + "Magazines & Newspapers - 6021" + ], + [ + "6020", + "Medical - 6020" + ], + [ + "6011", + "Music - 6011" + ], + [ + "6010", + "Navigation - 6010" + ], + [ + "6009", + "News - 6009" + ], + [ + "6008", + "Photo & Video - 6008" + ], + [ + "6007", + "Productivity - 6007" + ], + [ + "6006", + "Reference - 6006" + ], + [ + "6005", + "Social Networking - 6005" + ], + [ + "6024", + "Shopping - 6024" + ], + [ + "6004", + "Sports - 6004" + ], + [ + "6003", + "Travel - 6003" + ], + [ + "6002", + "Utilities - 6002" + ], + [ + "6001", + "Weather - 6001" + ] + ], + "description": "Parameter allows to only show app results for a specific category, or genre. E.g. category_id=`6014` will only return apps that have \"Games\" as at least one of their categories, or genres. Head to the Apple Categories for a full list of supported Apple Categories/Genres.", + "group": "advanced_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `apple_app_store` to use the Apple App Store API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Apple App Store results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/apple_product.json b/engines/apple_product.json new file mode 100644 index 0000000..fa6bbc0 --- /dev/null +++ b/engines/apple_product.json @@ -0,0 +1,215 @@ +{ + "engine": "apple_product", + "params": { + "product_id": { + "required": true, + "description": "Parameter defines the product id you want to search. You can use the specific id of a product that you would like to get the product page of.", + "group": "search_query" + }, + "type": { + "required": false, + "type": "select", + "options": [ + "app" + ], + "description": "Parameter defines the type of Apple Product to get the product page of. It defaults to `app`.", + "group": "advanced_apple_parameters" + }, + "country": { + "required": false, + "type": "select", + "options": [ + "al", + "dz", + "ao", + "ai", + "ag", + "ar", + "am", + "au", + "at", + "az", + "bs", + "bh", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "bw", + "br", + "vg", + "bn", + "bg", + "bf", + "kh", + "ca", + "cv", + "ky", + "cl", + "td", + "cn", + "co", + "cd", + "cr", + "hr", + "cy", + "cz", + "dk", + "dm", + "do", + "ec", + "eg", + "sv", + "ee", + "fj", + "fi", + "fr", + "de", + "gm", + "gb", + "gh", + "gr", + "gd", + "gt", + "gw", + "gy", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ie", + "il", + "it", + "jm", + "jp", + "jo", + "kz", + "ke", + "kw", + "kg", + "la", + "lv", + "lb", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "ml", + "mt", + "mr", + "mu", + "mx", + "fm", + "md", + "mn", + "ms", + "mz", + "na", + "np", + "nl", + "nz", + "ni", + "ne", + "ng", + "no", + "om", + "pk", + "pw", + "pa", + "pg", + "py", + "pe", + "ph", + "pl", + "pt", + "qa", + "ro", + "ru", + "st", + "sa", + "sn", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "za", + "kr", + "es", + "lk", + "kn", + "lc", + "vc", + "sr", + "sz", + "se", + "ch", + "tw", + "tj", + "tz", + "th", + "tt", + "tn", + "tr", + "tm", + "tc", + "ug", + "ua", + "ae", + "us", + "uy", + "uz", + "ve", + "vn", + "ye", + "zw" + ], + "description": "Parameter defines the country to use for the search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Apple Regions for a full list of supported Apple Regions.", + "group": "localization" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `apple_product` to use the Apple Product API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Apple Product results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/apple_reviews.json b/engines/apple_reviews.json new file mode 100644 index 0000000..0662a23 --- /dev/null +++ b/engines/apple_reviews.json @@ -0,0 +1,224 @@ +{ + "engine": "apple_reviews", + "params": { + "product_id": { + "required": true, + "description": "Parameter defines the ID of a product you want to get the reviews for. You can find the ID of a product from App Store API json results, You can also get it from the URL of the app. For example `product_id` of \"https://apps.apple.com/us/app/the-great-coffee-app/id534220544\", is the long numerical value that comes after \"id\", 534220544 (default).", + "group": "search_query" + }, + "country": { + "required": false, + "type": "select", + "options": [ + "al", + "dz", + "ao", + "ai", + "ag", + "ar", + "am", + "au", + "at", + "az", + "bs", + "bh", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "bw", + "br", + "vg", + "bn", + "bg", + "bf", + "kh", + "ca", + "cv", + "ky", + "cl", + "td", + "cn", + "co", + "cd", + "cr", + "hr", + "cy", + "cz", + "dk", + "dm", + "do", + "ec", + "eg", + "sv", + "ee", + "fj", + "fi", + "fr", + "de", + "gm", + "gb", + "gh", + "gr", + "gd", + "gt", + "gw", + "gy", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ie", + "il", + "it", + "jm", + "jp", + "jo", + "kz", + "ke", + "kw", + "kg", + "la", + "lv", + "lb", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "ml", + "mt", + "mr", + "mu", + "mx", + "fm", + "md", + "mn", + "ms", + "mz", + "na", + "np", + "nl", + "nz", + "ni", + "ne", + "ng", + "no", + "om", + "pk", + "pw", + "pa", + "pg", + "py", + "pe", + "ph", + "pl", + "pt", + "qa", + "ro", + "ru", + "st", + "sa", + "sn", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "za", + "kr", + "es", + "lk", + "kn", + "lc", + "vc", + "sr", + "sz", + "se", + "ch", + "tw", + "tj", + "tz", + "th", + "tt", + "tn", + "tr", + "tm", + "tc", + "ug", + "ua", + "ae", + "us", + "uy", + "uz", + "ve", + "vn", + "ye", + "zw" + ], + "description": "Parameter defines the country to use for the search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Apple Regions for a full list of supported Apple Regions.", + "group": "localization" + }, + "page": { + "type": "number", + "required": false, + "description": "Parameter is used to get the items on a specific page. (e.g., 1 (default) is the first page of results, 2 is the 2nd page of results, 3 is the 3rd page of results, etc.).", + "group": "pagination" + }, + "sort": { + "required": false, + "type": "select", + "options": [ + "mostrecent", + "mosthelpful", + "mostfavorable", + "mostcritical" + ], + "description": "Parameter is used for sorting reviews for the iOS App Store (iPhone and iPad). It can be set to: `mostrecent`: Most recent (default), `mosthelpful`: Most helpful, `mostfavorable`: Most favorable, `mostcritical`: Most critical This parameter has no effect on the macOS App Store. Reviews from the macOS App Store will always be sorted from most recent to least recent.", + "group": "advanced_apple_reviews_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `apple_reviews` to use the Apple Reviews API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Apple Reviews results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/baidu.json b/engines/baidu.json new file mode 100644 index 0000000..80dbcce --- /dev/null +++ b/engines/baidu.json @@ -0,0 +1,106 @@ +{ + "engine": "baidu", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query, including all Baidu search operators. (e.g., `inurl:`, `site:`, `intitle:`, etc.).", + "group": "search_query" + }, + "ct": { + "type": "select", + "options": [ + [ + "1", + "All Languages" + ], + [ + "2", + "Simplified Chinese" + ], + [ + "3", + "Traditional Chinese" + ] + ], + "description": "Parameter defines which language to restrict results. Available options: `1` - All languages `2` - Simplified Chinese `3` - Traditional Chinese", + "group": "localization" + }, + "pn": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "rn": { + "type": "number", + "description": "Parameter defines the maximum number of results to return, limited to 50. (e.g., `10` (default) returns 10 results, `30` returns 30 results, and `50` returns 50 results). This parameter is only available for desktop and tablet searches.", + "group": "pagination" + }, + "gpc": { + "description": "Parameter defines the time period for results. (e.g., `stf=1766826674,1767431474|stftype=1` only returns results from the past 7 days. First integer within the parameter,`1766826674` is Unix Timestamp for 7 days ago. Second integer,`1767431474` is Unix Timestamp for now.).", + "group": "advanced_filters" + }, + "q5": { + "description": "Similar to using `inurl:` or `intitle:`. (e.g., `1` to search by page title, `2` to search by web address.).", + "group": "advanced_filters" + }, + "q6": { + "description": "Similar to using `site:`. (e.g., `q6=serpapi.com` to search for results only from the domain `serpapi.com`).", + "group": "advanced_filters" + }, + "bs": { + "description": "Defines the previous search query.", + "group": "advanced_baidu_parameters" + }, + "oq": { + "description": "Defines the original search query when navigated from a related search.", + "group": "advanced_baidu_parameters" + }, + "f": { + "description": "Defines the originating search type. (e.g., `8` is a normal search, `3` is from the suggestion list, and `1` is a related search.", + "group": "advanced_baidu_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `baidu` to use the Baidu API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Baidu results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/baidu_news.json b/engines/baidu_news.json new file mode 100644 index 0000000..cf4561a --- /dev/null +++ b/engines/baidu_news.json @@ -0,0 +1,106 @@ +{ + "engine": "baidu_news", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query, including all Baidu search operators. (e.g., `inurl:`, `site:`, `intitle:`, etc.).", + "group": "search_query" + }, + "ct": { + "type": "select", + "options": [ + [ + "1", + "All Languages" + ], + [ + "2", + "Simplified Chinese" + ], + [ + "3", + "Traditional Chinese" + ] + ], + "description": "Parameter defines which language to restrict results. Available options: `1` - All Languages. `2` - Simplified Chinese `3` - Traditional Chinese.", + "group": "localization" + }, + "pn": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "rn": { + "type": "number", + "description": "Parameter defines the maximum number of results to return, limited to 50. (e.g., `10` (default) returns 10 results, `30` returns 30 results, and `50` returns 50 results).", + "group": "pagination" + }, + "rtt": { + "type": "select", + "options": [ + [ + "1", + "Sort by attraction" + ], + [ + "4", + "Sort by time" + ] + ], + "description": "Parameter defines the sort type for results. Available options: `1` - Sort by attraction (default) `4` - Sort by time", + "group": "advanced_filters" + }, + "medium": { + "type": "select", + "options": [ + [ + "0", + "No filtering" + ], + [ + "1", + "Show results from medium sites" + ], + [ + "2", + "Show results from Baijiahao (baijiahao.baidu.com)" + ] + ], + "description": "Parameter defines medium filtering for results. Available options: `0` - No filtering `1` - Show results from medium sites `2` - Show results from Baijiahao (baijiahao.baidu.com)", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `baidu_news` to use the Baidu News API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Baidu News results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/bing.json b/engines/bing.json new file mode 100644 index 0000000..237a93c --- /dev/null +++ b/engines/bing.json @@ -0,0 +1,175 @@ +{ + "engine": "bing", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Bing search. (e.g., `'query'`, `NOT`, `OR`, `site:`, `filetype:`, `near:`, `ip:`, `loc:`, `feed:` etc.).", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "lat": { + "type": "number", + "description": "Defines a GPS latitude for the search origin", + "group": "geographic_location" + }, + "lon": { + "type": "number", + "description": "Defines a GPS longitude for the search origin", + "group": "geographic_location" + }, + "mkt": { + "type": "select", + "options": [ + "es-ar", + "en-au", + "de-at", + "nl-be", + "fr-be", + "pt-br", + "en-ca", + "fr-ca", + "es-cl", + "da-dk", + "fi-fi", + "fr-fr", + "de-de", + "zh-hk", + "en-in", + "en-id", + "it-it", + "ja-jp", + "ko-kr", + "en-my", + "es-mx", + "nl-nl", + "en-nz", + "no-no", + "zh-cn", + "pl-pl", + "en-ph", + "ru-ru", + "en-za", + "es-es", + "sv-se", + "fr-ch", + "de-ch", + "zh-tw", + "tr-tr", + "en-gb", + "en-us", + "es-us" + ], + "description": "The market where the results come from (e.g. `en-US`). Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see Market Codes. NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in Market Codes, Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the cc query parameter are mutually exclusive\u2014do not specify both.", + "group": "geographic_location" + }, + "cc": { + "type": "select", + "options": [ + "AR", + "AU", + "AT", + "BE", + "BR", + "CA", + "CL", + "DK", + "FI", + "FR", + "DE", + "HK", + "IN", + "ID", + "IT", + "JP", + "KR", + "MY", + "MX", + "NL", + "NZ", + "NO", + "CN", + "PL", + "PT", + "PH", + "RU", + "SA", + "ZA", + "ES", + "SE", + "CH", + "TW", + "TR", + "GB", + "US" + ], + "description": "Parameter defines the country to search from. It follows the 2-character ISO_3166-1 format. (e.g., `us` for United States, `de` for Germany, `gb` for United Kingdom, etc.).", + "group": "localization" + }, + "first": { + "type": "number", + "description": "Parameter controls the offset of the organic results. This parameter defaults to `1`. (e.g., `first=10` will move the 10th organic result to the first position).", + "group": "pagination" + }, + "safeSearch": { + "type": "select", + "options": [ + "off", + "moderate", + "strict" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to: `Off` to return webpages with adult text, images, or videos. `Moderate` to return webpages with adult text, but not adult images or videos. `Strict` to not return webpages with adult text, images, or videos.", + "group": "advanced_filters" + }, + "filters": { + "description": "Parameter allows usage of a more complex filtering options such as filtering by date range `ex1:\"ez5_18169_18230\"` or using a specific display filters such as `ufn:\"Wunderman+Thompson\"+sid:\"5bede9a2-1bda-9887-e6eb-30b1b8b6b513\"+catguid:\"5bede9a2-1bda-9887-e6eb-30b1b8b6b513_cfb02057\"+segment:\"generic.carousel\"+entitysegment:\"Organization\"`. Exact values can be constructed by using Bing search and copying `filters` query parameter.", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `bing` to use the Bing API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Bing results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/bing_copilot.json b/engines/bing_copilot.json new file mode 100644 index 0000000..c4ed98f --- /dev/null +++ b/engines/bing_copilot.json @@ -0,0 +1,43 @@ +{ + "engine": "bing_copilot", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query for Bing Copilot. You can use anything that you would use in a regular Bing Copilot search.", + "group": "search_query" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `bing_copilot` to use the Bing Copilot API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Bing Copilot results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/bing_images.json b/engines/bing_images.json new file mode 100644 index 0000000..f2444c4 --- /dev/null +++ b/engines/bing_images.json @@ -0,0 +1,240 @@ +{ + "engine": "bing_images", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Bing Images search.", + "group": "search_query" + }, + "mkt": { + "type": "select", + "options": [ + "es-ar", + "en-au", + "de-at", + "nl-be", + "fr-be", + "pt-br", + "en-ca", + "fr-ca", + "es-cl", + "da-dk", + "fi-fi", + "fr-fr", + "de-de", + "zh-hk", + "en-in", + "en-id", + "it-it", + "ja-jp", + "ko-kr", + "en-my", + "es-mx", + "nl-nl", + "en-nz", + "no-no", + "zh-cn", + "pl-pl", + "en-ph", + "ru-ru", + "en-za", + "es-es", + "sv-se", + "fr-ch", + "de-ch", + "zh-tw", + "tr-tr", + "en-gb", + "en-us", + "es-us" + ], + "description": "The market where the results come from (e.g. `en-US`). Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing Images API delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see Market Codes. NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in Market Codes, Bing Images API uses a best fit market code based on an internal mapping that is subject to change. This parameter and the cc query parameter are mutually exclusive\u2014do not specify both.", + "group": "geographic_location" + }, + "cc": { + "type": "select", + "options": [ + "AR", + "AU", + "AT", + "BE", + "BR", + "CA", + "CL", + "DK", + "FI", + "FR", + "DE", + "HK", + "IN", + "ID", + "IT", + "JP", + "KR", + "MY", + "MX", + "NL", + "NZ", + "NO", + "CN", + "PL", + "PT", + "PH", + "RU", + "SA", + "ZA", + "ES", + "SE", + "CH", + "TW", + "TR", + "GB", + "US" + ], + "description": "Parameter defines the country to search from. It follows the 2-character ISO_3166-1 format. (e.g., `us` for United States, `de` for Germany, `gb` for United Kingdom, etc.).", + "group": "localization" + }, + "first": { + "type": "number", + "description": "Parameter controls the offset of the organic results. This parameter defaults to `1`. (e.g., `first=10` will move the 10th organic result to the first position).", + "group": "pagination" + }, + "count": { + "type": "number", + "description": "Parameter controls the number of results per page. This parameter is only a suggestion and might not reflect the returned results.", + "group": "pagination" + }, + "imagesize": { + "type": "select", + "options": [ + "small", + "medium", + "large", + "wallpaper" + ], + "description": "Parameter is used for filtering images by size. It can be set to: `small` - Small `medium` - Medium `large` - Large `wallpaper` - Extra Large", + "group": "advanced_bing_images_parameters" + }, + "color2": { + "type": "select", + "options": [ + "color", + "bw", + "FGcls_RED", + "FGcls_ORGANGE", + "FGcls_YELLOW", + "FGcls_GREEN", + "FGcls_TEAL", + "FGcls_BLUE", + "FGcls_PURPLE", + "FGcls_PINK", + "FGcls_BROWN", + "FGcls_BLACK", + "FGcls_GRAY", + "FGcls_WHITE" + ], + "description": "Parameter is used for filtering images by color. It can be set to: `color` - Color Only `bw` - Black & white `FGcls_RED` - Red `FGcls_ORGANGE` - Orange `FGcls_YELLOW` - Yellow `FGcls_GREEN` - Green `FGcls_TEAL` - Teal `FGcls_BLUE` - Blue `FGcls_PURPLE` - Purple `FGcls_PINK` - Pink `FGcls_BROWN` - Brown `FGcls_BLACK` - Black `FGcls_GRAY` - Gray `FGcls_WHITE` - White", + "group": "advanced_bing_images_parameters" + }, + "photo": { + "type": "select", + "options": [ + "photo", + "clipart", + "linedrawing", + "animatedgif", + "animatedgifhttps", + "transparent", + "shopping" + ], + "description": "Parameter is used for filtering images by image type. It can be set to: `photo` - Photo `clipart` - Clipart `linedrawing` - Line Drawing `animatedgif` - Animated GIF `animatedgifhttps` - Animated GIF HTTPS `transparent` - Transparent `shopping` - Shopping, return only images that contain items where Bing knows of a merchant that is selling the items", + "group": "advanced_bing_images_parameters" + }, + "aspect": { + "type": "select", + "options": [ + "square", + "wide", + "tall" + ], + "description": "Parameter is used for filtering images by layout. It can be set to: `square` - Square `wide` - Wide `tall` - Tall", + "group": "advanced_bing_images_parameters" + }, + "face": { + "type": "select", + "options": [ + "face", + "portrait" + ], + "description": "Parameter is used for filtering images by people. It can be set to: `face` - Faces Only `portrait` - Head & Shoulders", + "group": "advanced_bing_images_parameters" + }, + "age": { + "type": "select", + "options": [ + "lt1440", + "lt10080", + "lt43200", + "lt525600" + ], + "description": "Parameter is used for filtering images by date. It can be set to: `lt1440` - Past 24 hours `lt10080` - Past week `lt43200` - Past month `lt525600` - Past year", + "group": "advanced_bing_images_parameters" + }, + "license": { + "type": "select", + "options": [ + "Type-Any", + "L1", + "L2_L3_L4_L5_L6_L7", + "L2_L3_L4", + "L2_L3_L5_L6", + "L2_L3" + ], + "description": "Parameter is used for filtering images by license. It can be set to: `Type-Any` - All Creative Commons `L1` - Public Domain `L2_L3_L4_L5_L6_L7` - Free to share and use `L2_L3_L4` - Free to share and use commercially `L2_L3_L5_L6` - Free to modify, share and use `L2_L3` - Free to modify, share, and use commercially", + "group": "advanced_bing_images_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `bing_images` to use the Bing Images API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Bing Images results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/bing_maps.json b/engines/bing_maps.json new file mode 100644 index 0000000..ea7ed81 --- /dev/null +++ b/engines/bing_maps.json @@ -0,0 +1,118 @@ +{ + "engine": "bing_maps", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Bing Maps search.", + "group": "search_query" + }, + "cp": { + "description": "Parameter defines GPS coordinates of location where you want your q (query) to be applied. It has to be constructed in the next sequence: `latitude` + `~` + `longitude` This will form a string that looks like this: e.g. `40.7455096~-74.0083012`.", + "group": "geographic_location" + }, + "setlang": { + "type": "select", + "options": [ + "ar", + "eu", + "bn", + "bg", + "ca", + "zh-hans", + "zh-hant", + "hr", + "cs", + "da", + "nl", + "en", + "en-gb", + "et", + "fi", + "fr", + "gl", + "de", + "gu", + "he", + "hi", + "hu", + "is", + "it", + "jp", + "kn", + "ko", + "lv", + "lt", + "ms", + "ml", + "mr", + "nb", + "pl", + "pt-br", + "pt-pt", + "pa", + "ro", + "ru", + "sr", + "sk", + "sl", + "es", + "sv", + "ta", + "te", + "th", + "tr", + "uk", + "vi" + ], + "description": "Parameter defines the language to search with. It follows the 2-character ISO_3166-1 format. (e.g., `us` for United States, `de` for Germany, `gb` for United Kingdom, etc.). You can view all supported language codes on Bing Maps.", + "group": "localization" + }, + "place_id": { + "description": "Parameter defines the unique reference to a place on a Bing Map. Place IDs are available for most locations, including businesses, landmarks, parks, and intersections. You can find the place_id using our Bing Maps API and Bing Local Pack API. place_id can be used without any other optional parameter including q parameter.", + "group": "advanced_bing_maps_parameters" + }, + "first": { + "type": "number", + "description": "Parameter controls the offset of the local results. This parameter defaults to `0`. (e.g. When `count=10`, the second page result start from `first=10`).", + "group": "pagination" + }, + "count": { + "type": "number", + "description": "Parameter controls the number of results per page. This parameter is only a suggestion and might not reflect the returned results. Maximum results per page is `30`", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `bing_maps` to use the Bing Maps API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Bing Maps results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/bing_news.json b/engines/bing_news.json new file mode 100644 index 0000000..8fa277b --- /dev/null +++ b/engines/bing_news.json @@ -0,0 +1,171 @@ +{ + "engine": "bing_news", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Bing search. (e.g., `'query'`, `NOT`, `OR`, `site:`, `filetype:`, `near:`, `ip:`, `loc:`, `feed:` etc.).", + "group": "search_query" + }, + "mkt": { + "type": "select", + "options": [ + "es-ar", + "en-au", + "de-at", + "nl-be", + "fr-be", + "pt-br", + "en-ca", + "fr-ca", + "es-cl", + "da-dk", + "fi-fi", + "fr-fr", + "de-de", + "zh-hk", + "en-in", + "en-id", + "it-it", + "ja-jp", + "ko-kr", + "en-my", + "es-mx", + "nl-nl", + "en-nz", + "no-no", + "pl-pl", + "en-ph", + "ru-ru", + "en-za", + "es-es", + "sv-se", + "fr-ch", + "de-ch", + "zh-tw", + "tr-tr", + "en-gb", + "en-us", + "es-us" + ], + "description": "The market where the results come from (e.g. `en-US`). Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see Market Codes. NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in Market Codes, Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the cc query parameter are mutually exclusive\u2014do not specify both.", + "group": "geographic_location" + }, + "cc": { + "type": "select", + "options": [ + "AR", + "AU", + "AT", + "BE", + "BR", + "CA", + "CL", + "DK", + "FI", + "FR", + "DE", + "HK", + "IN", + "ID", + "IT", + "JP", + "KR", + "MY", + "MX", + "NL", + "NZ", + "NO", + "PL", + "PT", + "PH", + "RU", + "SA", + "ZA", + "ES", + "SE", + "CH", + "TW", + "TR", + "GB", + "US" + ], + "description": "Parameter defines the country to search from. It follows the 2-character ISO_3166-1 format. (e.g., `us` for United States, `de` for Germany, `gb` for United Kingdom, etc.).", + "group": "localization" + }, + "first": { + "type": "number", + "description": "Parameter controls the offset of the organic results. This parameter defaults to `1`. (e.g., `first=10` will move the 10th organic result to the first position).", + "group": "pagination" + }, + "count": { + "type": "number", + "description": "Parameter controls the number of results per page. This parameter is only a suggestion and might not reflect actual results returned.", + "group": "pagination" + }, + "qft": { + "type": "select", + "options": [ + "interval=\"4\"", + "interval=\"7\"", + "interval=\"8\"", + "interval=\"9\"", + "sortbydate=\"1\"" + ], + "description": "Parameter defines results sorted by date. If the parameter is not set, it will default to the \"Best match\" sorting, otherwise, if set to: e.g. `interval=\"4\"`, it will show results from the past hour. Other options are: `interval=\"7\"`: Past 24 hours, `interval=\"8\"`: Past 7 days, `interval=\"9\"`: Past 30 days, `sortbydate=\"1\"`: Most Recent", + "group": "advanced_bing_news_parameters" + }, + "safeSearch": { + "type": "select", + "options": [ + "off", + "moderate", + "strict" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to: `Off` to return webpages with adult text, images, or videos. `Moderate` to return webpages with adult text, but not adult images or videos. `Strict` to not return webpages with adult text, images, or videos.", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `bing_news` to use the Bing News API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Bing News results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/bing_product.json b/engines/bing_product.json new file mode 100644 index 0000000..459805b --- /dev/null +++ b/engines/bing_product.json @@ -0,0 +1,43 @@ +{ + "engine": "bing_product", + "params": { + "product_token": { + "required": true, + "description": "Parameter defines the token needed to retrieve specific product details. The token is generated by SerpApi using our Bing Shopping API.", + "group": "search_query" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `bing_product` to use the Bing Product API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Bing Product results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/bing_reverse_image.json b/engines/bing_reverse_image.json new file mode 100644 index 0000000..6f8dd91 --- /dev/null +++ b/engines/bing_reverse_image.json @@ -0,0 +1,117 @@ +{ + "engine": "bing_reverse_image", + "params": { + "image_url": { + "required": true, + "description": "Parameter defines the URL for an image to perform the reverse image search. NOTE: The image's width and height must each be 4,000 pixels or less.", + "group": "search_query" + }, + "mkt": { + "type": "select", + "options": [ + "es-ar", + "en-au", + "de-at", + "nl-be", + "fr-be", + "pt-br", + "en-ca", + "fr-ca", + "es-cl", + "da-dk", + "fi-fi", + "fr-fr", + "de-de", + "zh-hk", + "en-in", + "en-id", + "it-it", + "ja-jp", + "ko-kr", + "en-my", + "es-mx", + "nl-nl", + "en-nz", + "no-no", + "zh-cn", + "pl-pl", + "en-ph", + "ru-ru", + "en-za", + "es-es", + "sv-se", + "fr-ch", + "de-ch", + "zh-tw", + "tr-tr", + "en-gb", + "en-us", + "es-us" + ], + "description": "The market where the results come from (e.g. `en-US`). Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing Reverse Image API delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see Market Codes. NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in Market Codes, Bing Reverse Image API uses a best fit market code based on an internal mapping that is subject to change.", + "group": "geographic_location" + }, + "cat": { + "type": "number", + "description": "Parameter is used to crop the image and perform the reverse search on the cropped part of the image. For example, `0.3` means cropping 30% from the top. The minimum and maximum for this coordinate are `0` and `1`, respectively.", + "group": "crop_area" + }, + "cal": { + "type": "number", + "description": "Parameter is used to crop the image and perform the reverse search on the cropped part of the image. For example, `0.3` means cropping 30% from the left. The minimum and maximum for this coordinate are `0` and `1`, respectively.", + "group": "crop_area" + }, + "car": { + "type": "number", + "description": "Parameter is used to crop the image and perform the reverse search on the cropped part of the image. For example, `0.8` means cropping the right, 80% from the left. The minimum and maximum for this coordinate are `0` and `1`, respectively.", + "group": "crop_area" + }, + "cab": { + "type": "number", + "description": "Parameter is used to crop the image and perform the reverse search on the cropped part of the image. For example, `0.8` means cropping the bottom, 80% from the top. The minimum and maximum for this coordinate are `0` and `1`, respectively.", + "group": "crop_area" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results.", + "group": "pagination" + }, + "count": { + "type": "number", + "description": "Parameter controls the number of results per page. This parameter defaults to `35`. This parameter is only a suggestion and might not reflect the returned results. The minimum and maximum for this parameter are `0` and `150`, respectively.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `bing_reverse_image` to use the Bing Reverse Image API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Bing Reverse Image results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/bing_shopping.json b/engines/bing_shopping.json new file mode 100644 index 0000000..65697f9 --- /dev/null +++ b/engines/bing_shopping.json @@ -0,0 +1,150 @@ +{ + "engine": "bing_shopping", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Bing Shopping search.", + "group": "search_query" + }, + "mkt": { + "type": "select", + "options": [ + "es-ar", + "en-au", + "de-at", + "nl-be", + "fr-be", + "pt-br", + "en-ca", + "fr-ca", + "es-cl", + "da-dk", + "fi-fi", + "fr-fr", + "de-de", + "zh-hk", + "en-in", + "en-id", + "it-it", + "ja-jp", + "ko-kr", + "en-my", + "es-mx", + "nl-nl", + "en-nz", + "no-no", + "zh-cn", + "pl-pl", + "en-ph", + "ru-ru", + "en-za", + "es-es", + "sv-se", + "fr-ch", + "de-ch", + "zh-tw", + "tr-tr", + "en-gb", + "en-us", + "es-us" + ], + "description": "The market where the results come from (e.g. `en-US`). Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing Shopping API delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see Market Codes. NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in Market Codes, Bing Shopping API uses a best fit market code based on an internal mapping that is subject to change. This parameter and the cc query parameter are mutually exclusive\u2014do not specify both.", + "group": "geographic_location" + }, + "cc": { + "type": "select", + "options": [ + "AR", + "AU", + "AT", + "BE", + "BR", + "CA", + "CL", + "DK", + "FI", + "FR", + "DE", + "HK", + "IN", + "ID", + "IT", + "JP", + "KR", + "MY", + "MX", + "NL", + "NZ", + "NO", + "CN", + "PL", + "PT", + "PH", + "RU", + "SA", + "ZA", + "ES", + "SE", + "CH", + "TW", + "TR", + "GB", + "US" + ], + "description": "Parameter defines the country to search from. It follows the 2-character ISO_3166-1 format. (e.g., `us` for United States, `de` for Germany, `gb` for United Kingdom, etc.).", + "group": "localization" + }, + "efirst": { + "type": "number", + "description": "Parameter controls the offset of the shopping results. (e.g., `efirst=10` will move the 10th shopping result to the first position).", + "group": "pagination" + }, + "filters": { + "description": "Parameter allows usage of a more complex filtering options such as filtering by date range `ex1:\"ez5_18169_18230\"` or using a specific display filters such as `ufn:\"Wunderman+Thompson\"+sid:\"5bede9a2-1bda-9887-e6eb-30b1b8b6b513\"+catguid:\"5bede9a2-1bda-9887-e6eb-30b1b8b6b513_cfb02057\"+segment:\"generic.carousel\"+entitysegment:\"Organization\"`. Exact values can be constructed by using Bing search and copying `filters` query parameter.", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `bing_shopping` to use the Bing Shopping API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Bing Shopping results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/bing_videos.json b/engines/bing_videos.json new file mode 100644 index 0000000..6e8a87d --- /dev/null +++ b/engines/bing_videos.json @@ -0,0 +1,263 @@ +{ + "engine": "bing_videos", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Bing Videos search.", + "group": "search_query" + }, + "mkt": { + "type": "select", + "options": [ + "es-ar", + "en-au", + "de-at", + "nl-be", + "fr-be", + "pt-br", + "en-ca", + "fr-ca", + "es-cl", + "da-dk", + "fi-fi", + "fr-fr", + "de-de", + "zh-hk", + "en-in", + "en-id", + "it-it", + "ja-jp", + "ko-kr", + "en-my", + "es-mx", + "nl-nl", + "en-nz", + "no-no", + "zh-cn", + "pl-pl", + "en-ph", + "ru-ru", + "en-za", + "es-es", + "sv-se", + "fr-ch", + "de-ch", + "zh-tw", + "tr-tr", + "en-gb", + "en-us", + "es-us" + ], + "description": "The market where the results come from (e.g. `en-US`). Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing Videos API delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see Market Codes. NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in Market Codes, Bing Videos API uses a best fit market code based on an internal mapping that is subject to change. This parameter and the cc query parameter are mutually exclusive\u2014do not specify both.", + "group": "geographic_location" + }, + "cc": { + "type": "select", + "options": [ + "AR", + "AU", + "AT", + "BE", + "BR", + "CA", + "CL", + "DK", + "FI", + "FR", + "DE", + "HK", + "IN", + "ID", + "IT", + "JP", + "KR", + "MY", + "MX", + "NL", + "NZ", + "NO", + "CN", + "PL", + "PT", + "PH", + "RU", + "SA", + "ZA", + "ES", + "SE", + "CH", + "TW", + "TR", + "GB", + "US" + ], + "description": "Parameter defines the country to search from. It follows the 2-character ISO_3166-1 format. (e.g., `us` for United States, `de` for Germany, `gb` for United Kingdom, etc.).", + "group": "localization" + }, + "setlang": { + "type": "select", + "options": [ + "ar", + "eu", + "bn", + "bg", + "ca", + "zh-hans", + "zh-hant", + "hr", + "cs", + "da", + "nl", + "en", + "en-gb", + "et", + "fi", + "fr", + "gl", + "de", + "gu", + "he", + "hi", + "hu", + "is", + "it", + "jp", + "kn", + "ko", + "lv", + "lt", + "ms", + "ml", + "mr", + "nb", + "pl", + "pt-br", + "pt-pt", + "pa", + "ro", + "ru", + "sr", + "sk", + "sl", + "es", + "sv", + "ta", + "te", + "th", + "tr", + "uk", + "vi" + ], + "description": "Parameter defines the language to search with. It follows the 2-character ISO_3166-1 format. (e.g., `us` for United States, `de` for Germany, `gb` for United Kingdom, etc.). You can view all valid language codes here.", + "group": "localization" + }, + "first": { + "type": "number", + "description": "Parameter controls the offset of the organic results. This parameter defaults to `1`. (e.g., `first=10` will move the 10th organic result to the first position).", + "group": "pagination" + }, + "length": { + "type": "select", + "options": [ + "short", + "medium", + "long" + ], + "description": "Parameter is used for filtering videos by duration. It can be set to: `short` - Short (less than 5 minutes) `medium` - Medium (5-20 minutes) `long` - Long (more than 20 minutes)", + "group": "advanced_bing_videos_parameters" + }, + "date": { + "type": "select", + "options": [ + "lt1440", + "lt10080", + "lt43200", + "lt525600" + ], + "description": "Parameter is used for filtering videos by date. It can be set to: `lt1440` - Past 24 hours `lt10080` - Past week `lt43200` - Past month `lt525600` - Past year", + "group": "advanced_bing_videos_parameters" + }, + "resolution": { + "type": "select", + "options": [ + "lowerthan_360p", + "360p", + "480p", + "720p", + "1080p" + ], + "description": "Parameter is used for filtering videos by resolution type. It can be set to: `lowerthan_360p` - Lower than 360p `360p` - 360p or higher `480p` - 480p or higher `720p` - 720p or higher `1080p` - 1080p or higher", + "group": "advanced_bing_videos_parameters" + }, + "source_site": { + "type": "select", + "options": [ + "dailymotion.com", + "vimeo.com", + "metacafe.com", + "hulu.com", + "vevo.com", + "myspace.com", + "mtv.com", + "cbsnews.com", + "foxnews.com", + "cnn.com", + "msn.com" + ], + "description": "Parameter is used for filtering videos by source. It can be set to: `dailymotion.com` - DailyMotion `vimeo.com` - Vimeo `metacafe.com` - Metacafe `hulu.com` - Hulu `vevo.com` - VEVO `myspace.com` - Myspace `mtv.com` - MTV `cbsnews.com` - CBS `foxnews.com` - FOX `cnn.com` - CNN `msn.com` - MSN", + "group": "advanced_bing_videos_parameters" + }, + "price": { + "type": "select", + "options": [ + "free", + "paid" + ], + "description": "Parameter is used for filtering videos by price. It can be set to: `free` - Free `paid` - Paid", + "group": "advanced_bing_videos_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `bing_videos` to use the Bing Videos API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Bing Videos results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/duckduckgo.json b/engines/duckduckgo.json new file mode 100644 index 0000000..55f5e72 --- /dev/null +++ b/engines/duckduckgo.json @@ -0,0 +1,141 @@ +{ + "engine": "duckduckgo", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular DuckDuckGo search. (e.g., `inurl:`, `site:`, `intitle:`, etc.) Parameter length can not exceed 500 characters.", + "group": "search_query" + }, + "kl": { + "type": "select", + "options": [ + "ar-es", + "au-en", + "at-de", + "be-fr", + "be-nl", + "br-pt", + "bg-bg", + "ca-en", + "ca-fr", + "ct-ca", + "cl-es", + "cn-zh", + "co-es", + "hr-hr", + "cz-cs", + "dk-da", + "ee-et", + "fi-fi", + "fr-fr", + "de-de", + "gr-el", + "hk-tzh", + "hu-hu", + "is-is", + "in-en", + "id-en", + "ie-en", + "il-en", + "it-it", + "jp-jp", + "kr-kr", + "lv-lv", + "lt-lt", + "my-en", + "mx-es", + "nl-nl", + "nz-en", + "no-no", + "pk-en", + "pe-es", + "ph-en", + "pl-pl", + "pt-pt", + "ro-ro", + "ru-ru", + "xa-ar", + "sg-en", + "sk-sk", + "sl-sl", + "za-en", + "es-ca", + "es-es", + "se-sv", + "ch-de", + "ch-fr", + "tw-tzh", + "th-en", + "tr-tr", + "us-en", + "us-es", + "ua-uk", + "uk-en", + "vn-en", + "wt-wt" + ], + "description": "Parameter defines the region to use for the DuckDuckGo search. Region code examples: `us-en` for the United States, `uk-en` for United Kingdom, or `fr-fr` for France. Head to the DuckDuckGo regions for a full list of supported regions.", + "group": "localization" + }, + "safe": { + "type": "select", + "options": [ + [ + "1", + "Strict" + ], + "-1", + "-2" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `1` (Strict), `-1` (Moderate - default), or `-2` (Off).", + "group": "advanced_duckduckgo_filters" + }, + "df": { + "description": "Parameter defines results filtered by date. It can be set to: `d`: Past day, `w`: Past week, `m`: Past month, `y`: Past year, or you can pass a custom date following the next format: `from_date` + `..` + `to_date` (e.g. `2021-06-15..2024-06-16`).", + "group": "advanced_duckduckgo_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. When offset is not being used (initial search request, start parameter is set to 0 or left blank), up to 35 `organic_results` can be returned. When offset is being used (start parameter is greater than 0), up to 50 `organic_results` can be returned. DuckDuckGo may return duplicated results or a variable number of results. This is more likely to happen with higher start and m parameters.", + "group": "pagination" + }, + "m": { + "type": "number", + "description": "Parameter defines the maximum number of results to return. Default value:`50` Min. value:`1` Max. value:`50` When offset is not being used (initial search request, start parameter is set to 0 or left blank), up to 35 `organic_results` can be returned. DuckDuckGo may return duplicated results or a variable number of results. This is more likely to happen with higher start and m parameters.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `duckduckgo` to use the DuckDuckGo API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the DuckDuckGo results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/duckduckgo_light.json b/engines/duckduckgo_light.json new file mode 100644 index 0000000..fc3618f --- /dev/null +++ b/engines/duckduckgo_light.json @@ -0,0 +1,122 @@ +{ + "engine": "duckduckgo_light", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular DuckDuckGo search. (e.g., `inurl:`, `site:`, `intitle:`, etc.) Parameter length can not exceed 500 characters.", + "group": "search_query" + }, + "kl": { + "type": "select", + "options": [ + "ar-es", + "au-en", + "at-de", + "be-fr", + "be-nl", + "br-pt", + "bg-bg", + "ca-en", + "ca-fr", + "ct-ca", + "cl-es", + "cn-zh", + "co-es", + "hr-hr", + "cz-cs", + "dk-da", + "ee-et", + "fi-fi", + "fr-fr", + "de-de", + "gr-el", + "hk-tzh", + "hu-hu", + "is-is", + "in-en", + "id-en", + "ie-en", + "il-en", + "it-it", + "jp-jp", + "kr-kr", + "lv-lv", + "lt-lt", + "my-en", + "mx-es", + "nl-nl", + "nz-en", + "no-no", + "pk-en", + "pe-es", + "ph-en", + "pl-pl", + "pt-pt", + "ro-ro", + "ru-ru", + "xa-ar", + "sg-en", + "sk-sk", + "sl-sl", + "za-en", + "es-ca", + "es-es", + "se-sv", + "ch-de", + "ch-fr", + "tw-tzh", + "th-en", + "tr-tr", + "us-en", + "us-es", + "ua-uk", + "uk-en", + "vn-en", + "wt-wt" + ], + "description": "Parameter defines the region to use for the DuckDuckGo search. Region code examples: `us-en` for the United States, `uk-en` for United Kingdom, or `fr-fr` for France. Head to the DuckDuckGo regions for a full list of supported regions.", + "group": "localization" + }, + "df": { + "description": "Parameter defines results filtered by date. It can be set to: `d`: Past day, `w`: Past week, `m`: Past month, `y`: Past year, or you can pass a custom date following the next format: `from_date` + `..` + `to_date` (e.g. `2021-06-15..2024-06-16`).", + "group": "advanced_duckduckgo_filters" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results. `15` results are returned per page.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `duckduckgo_light` to use the DuckDuckGo Light API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the DuckDuckGo Light results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/duckduckgo_maps.json b/engines/duckduckgo_maps.json new file mode 100644 index 0000000..e05500d --- /dev/null +++ b/engines/duckduckgo_maps.json @@ -0,0 +1,72 @@ +{ + "engine": "duckduckgo_maps", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular DuckDuckGo Maps search.", + "group": "search_query" + }, + "bbox": { + "description": "Parameter defines an area where you want your q (query) to be applied. The value consists of latitude/longitude pair. The first pair marks the top left corner and the second pair marks the bottom right corner of the map area box. It has to be constructed in the next sequence: `latitude_tl` + `,` + `longitude_tl` + `,` + `latitude_br` + `,` + `longitude_br` This will form a string that looks like this: e.g. `30.341552964181687,-97.87405344947078,30.16321730812698,-97.50702877159034` DuckDuckGo Maps uses bbox parameter as the default way to pass GPS coordinates. When unsure what the value should be, visit DuckDuckGo Maps, search for a query in a desired location, and copy a value from the URL. Parameter can't be used with lat and lon parameters.", + "group": "geographic_location" + }, + "lat": { + "type": "number", + "description": "Defines a GPS latitude for the search origin. Parameter is required when using lon parameter.", + "group": "geographic_location" + }, + "lon": { + "type": "number", + "description": "Defines a GPS longitude for the search origin. Parameter is required when using lat parameter.", + "group": "geographic_location" + }, + "strict_bbox": { + "type": "select", + "options": [ + [ + "0", + "0 - Don't follow `bbox` GPS coordinates" + ], + [ + "1", + "1 - Follow `bbox` GPS coordinates" + ] + ], + "description": "Parameter defines whether you strictly want your search to follow the bbox coordinates. It can be set to `1` (strict - default), or `0` (off).", + "group": "advanced_duckduckgo_maps_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `duckduckgo_maps` to use the DuckDuckGo Maps API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the DuckDuckGo Maps results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/duckduckgo_news.json b/engines/duckduckgo_news.json new file mode 100644 index 0000000..2b61829 --- /dev/null +++ b/engines/duckduckgo_news.json @@ -0,0 +1,141 @@ +{ + "engine": "duckduckgo_news", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular DuckDuckGo News search. (e.g., `inurl:`, `site:`, `intitle:`, etc.) Parameter length can not exceed 500 characters.", + "group": "search_query" + }, + "kl": { + "type": "select", + "options": [ + "ar-es", + "au-en", + "at-de", + "be-fr", + "be-nl", + "br-pt", + "bg-bg", + "ca-en", + "ca-fr", + "ct-ca", + "cl-es", + "cn-zh", + "co-es", + "hr-hr", + "cz-cs", + "dk-da", + "ee-et", + "fi-fi", + "fr-fr", + "de-de", + "gr-el", + "hk-tzh", + "hu-hu", + "is-is", + "in-en", + "id-en", + "ie-en", + "il-en", + "it-it", + "jp-jp", + "kr-kr", + "lv-lv", + "lt-lt", + "my-en", + "mx-es", + "nl-nl", + "nz-en", + "no-no", + "pk-en", + "pe-es", + "ph-en", + "pl-pl", + "pt-pt", + "ro-ro", + "ru-ru", + "xa-ar", + "sg-en", + "sk-sk", + "sl-sl", + "za-en", + "es-ca", + "es-es", + "se-sv", + "ch-de", + "ch-fr", + "tw-tzh", + "th-en", + "tr-tr", + "us-en", + "us-es", + "ua-uk", + "uk-en", + "vn-en", + "wt-wt" + ], + "description": "Parameter defines the region to use for the DuckDuckGo News search. Region code examples: `us-en` for the United States, `uk-en` for United Kingdom, or `fr-fr` for France. Head to the DuckDuckGo regions for a full list of supported regions.", + "group": "localization" + }, + "safe": { + "type": "select", + "options": [ + [ + "1", + "Strict" + ], + "-1", + "-2" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `1` (Strict), `-1` (Moderate - default), or `-2` (Off).", + "group": "advanced_duckduckgo_news_filters" + }, + "df": { + "description": "Parameter defines results filtered by date. It can be set to: `d`: Past day, `w`: Past week, `m`: Past month.", + "group": "advanced_duckduckgo_news_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. When offset is not being used (initial search request, start parameter is set to 0 or left blank), up to 75 `news_results` can be returned. When offset is being used (start parameter is greater than 0), up to 100 `news_results` can be returned. DuckDuckGo may return duplicated results or a variable number of results. This is more likely to happen with higher start and m parameters.", + "group": "pagination" + }, + "m": { + "type": "number", + "description": "Parameter defines the maximum number of results to return. Default value:`100` Min. value:`1` Max. value:`100` When offset is not being used (initial search request, start parameter is set to 0 or left blank), up to 75 `news_results` can be returned. DuckDuckGo may return duplicated results or a variable number of results. This is more likely to happen with higher start and m parameters.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `duckduckgo_news` to use the DuckDuckGo News API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the DuckDuckGo News results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/ebay.json b/engines/ebay.json new file mode 100644 index 0000000..fdc9930 --- /dev/null +++ b/engines/ebay.json @@ -0,0 +1,1112 @@ +{ + "engine": "ebay", + "params": { + "_nkw": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular eBay search. _nkw parameter is optional when category_id parameter is specified.", + "group": "search_query" + }, + "ebay_domain": { + "type": "select", + "options": [ + "ebay.com.au", + "ebay.at", + "ebay.ca", + "ebay.fr", + "ebay.de", + "ebay.com.hk", + "ebay.ie", + "ebay.it", + "ebay.com.my", + "ebay.nl", + "ebay.ph", + "ebay.pl", + "ebay.com.sg", + "ebay.es", + "ebay.ch", + "ebay.co.uk", + "ebay.com" + ], + "description": "Parameter defines the eBay domain to use. It defaults to `ebay.com`. Head to the eBay domains for a full list of supported eBay domains.", + "group": "localization" + }, + "_salic": { + "type": "select", + "options": [ + [ + "1", + "United States" + ], + [ + "2", + "Canada" + ], + [ + "3", + "United Kingdom" + ], + [ + "4", + "Afghanistan" + ], + [ + "5", + "Albania" + ], + [ + "6", + "Algeria" + ], + [ + "7", + "American Samoa" + ], + [ + "8", + "Andorra" + ], + [ + "9", + "Angola" + ], + [ + "10", + "Anguilla" + ], + [ + "11", + "Antigua and Barbuda" + ], + [ + "12", + "Argentina" + ], + [ + "13", + "Armenia" + ], + [ + "14", + "Aruba" + ], + [ + "15", + "Australia" + ], + [ + "16", + "Austria" + ], + [ + "17", + "Azerbaijan Republic" + ], + [ + "18", + "Bahamas" + ], + [ + "19", + "Bahrain" + ], + [ + "20", + "Bangladesh" + ], + [ + "21", + "Barbados" + ], + [ + "22", + "Belarus" + ], + [ + "23", + "Belgium" + ], + [ + "24", + "Belize" + ], + [ + "25", + "Benin" + ], + [ + "26", + "Bermuda" + ], + [ + "27", + "Bhutan" + ], + [ + "28", + "Bolivia" + ], + [ + "29", + "Bosnia and Herzegovina" + ], + [ + "30", + "Botswana" + ], + [ + "31", + "Brazil" + ], + [ + "32", + "British Virgin Islands" + ], + [ + "33", + "Brunei Darussalam" + ], + [ + "34", + "Bulgaria" + ], + [ + "35", + "Burkina Faso" + ], + [ + "36", + "Burma" + ], + [ + "37", + "Burundi" + ], + [ + "38", + "Cambodia" + ], + [ + "39", + "Cameroon" + ], + [ + "40", + "Cape Verde Islands" + ], + [ + "41", + "Cayman Islands" + ], + [ + "42", + "Central African Republic" + ], + [ + "43", + "Chad" + ], + [ + "44", + "Chile" + ], + [ + "45", + "China" + ], + [ + "46", + "Colombia" + ], + [ + "47", + "Comoros" + ], + [ + "48", + "Congo, Democratic Republic of the" + ], + [ + "49", + "Congo, Republic of the" + ], + [ + "50", + "Cook Islands" + ], + [ + "51", + "Costa Rica" + ], + [ + "52", + "Cote d Ivoire (Ivory Coast)" + ], + [ + "53", + "Croatia, Republic of" + ], + [ + "55", + "Cyprus" + ], + [ + "56", + "Czech Republic" + ], + [ + "57", + "Denmark" + ], + [ + "58", + "Djibouti" + ], + [ + "59", + "Dominica" + ], + [ + "60", + "Dominican Republic" + ], + [ + "61", + "Ecuador" + ], + [ + "62", + "Egypt" + ], + [ + "63", + "El Salvador" + ], + [ + "64", + "Equatorial Guinea" + ], + [ + "65", + "Eritrea" + ], + [ + "66", + "Estonia" + ], + [ + "67", + "Ethiopia" + ], + [ + "68", + "Falkland Islands (Islas Malvinas)" + ], + [ + "69", + "Fiji" + ], + [ + "70", + "Finland" + ], + [ + "71", + "France" + ], + [ + "72", + "French Guiana" + ], + [ + "73", + "French Polynesia" + ], + [ + "74", + "Gabon Republic" + ], + [ + "75", + "Gambia" + ], + [ + "76", + "Georgia" + ], + [ + "77", + "Germany" + ], + [ + "78", + "Ghana" + ], + [ + "79", + "Gibraltar" + ], + [ + "80", + "Greece" + ], + [ + "81", + "Greenland" + ], + [ + "82", + "Grenada" + ], + [ + "83", + "Guadeloupe" + ], + [ + "84", + "Guam" + ], + [ + "85", + "Guatemala" + ], + [ + "86", + "Guernsey" + ], + [ + "87", + "Guinea" + ], + [ + "88", + "Guinea-Bissau" + ], + [ + "89", + "Guyana" + ], + [ + "90", + "Haiti" + ], + [ + "91", + "Honduras" + ], + [ + "92", + "Hong Kong" + ], + [ + "93", + "Hungary" + ], + [ + "94", + "Iceland" + ], + [ + "95", + "India" + ], + [ + "96", + "Indonesia" + ], + [ + "97", + "Iran" + ], + [ + "98", + "Iraq" + ], + [ + "99", + "Ireland" + ], + [ + "100", + "Israel" + ], + [ + "101", + "Italy" + ], + [ + "102", + "Jamaica" + ], + [ + "104", + "Japan" + ], + [ + "105", + "Jersey" + ], + [ + "106", + "Jordan" + ], + [ + "107", + "Kazakhstan" + ], + [ + "108", + "Kenya" + ], + [ + "109", + "Kiribati" + ], + [ + "111", + "South Korea" + ], + [ + "112", + "Kuwait" + ], + [ + "113", + "Kyrgyzstan" + ], + [ + "114", + "Laos" + ], + [ + "115", + "Latvia" + ], + [ + "116", + "Lebanon" + ], + [ + "117", + "Lesotho" + ], + [ + "118", + "Liberya" + ], + [ + "119", + "Libya" + ], + [ + "120", + "Liechtenstein" + ], + [ + "121", + "Lithuania" + ], + [ + "122", + "Luxembourg" + ], + [ + "123", + "Macau" + ], + [ + "124", + "Macedonia" + ], + [ + "125", + "Madagascar" + ], + [ + "126", + "Malawi" + ], + [ + "127", + "Malaysia" + ], + [ + "128", + "Maldives" + ], + [ + "129", + "Mali" + ], + [ + "130", + "Malta" + ], + [ + "131", + "Marshall Islands" + ], + [ + "132", + "Martinique" + ], + [ + "133", + "Mauritania" + ], + [ + "134", + "Mauritius" + ], + [ + "135", + "Mayotte" + ], + [ + "136", + "Mexico" + ], + [ + "137", + "Moldova" + ], + [ + "138", + "Monaco" + ], + [ + "139", + "Mongolia" + ], + [ + "140", + "Montserrat" + ], + [ + "141", + "Morocco" + ], + [ + "142", + "Mozambique" + ], + [ + "143", + "Namibia" + ], + [ + "144", + "Nauru" + ], + [ + "145", + "Nepal" + ], + [ + "146", + "Netherlands" + ], + [ + "147", + "Netherlands Antilles" + ], + [ + "148", + "New Caledonia" + ], + [ + "149", + "New Zealand" + ], + [ + "150", + "Nicaragua" + ], + [ + "151", + "Niger" + ], + [ + "152", + "Nigeria" + ], + [ + "153", + "Niue" + ], + [ + "154", + "Norway" + ], + [ + "155", + "Oman" + ], + [ + "156", + "Pakistan" + ], + [ + "157", + "Palau" + ], + [ + "158", + "Panama" + ], + [ + "159", + "Papua New Guinea" + ], + [ + "160", + "Paraguay" + ], + [ + "161", + "Peru" + ], + [ + "162", + "Philippines" + ], + [ + "163", + "Poland" + ], + [ + "164", + "Portugal" + ], + [ + "165", + "Puerto Rico" + ], + [ + "166", + "Qatar" + ], + [ + "167", + "Romania" + ], + [ + "168", + "Russian Federation" + ], + [ + "169", + "Rwanda" + ], + [ + "170", + "Saint Helena" + ], + [ + "171", + "Saint Kitts-Nevis" + ], + [ + "172", + "Saint Lucia" + ], + [ + "173", + "Saint Pierre and Miquelon" + ], + [ + "174", + "Saint Vincent and the Grenadines" + ], + [ + "175", + "San Marino" + ], + [ + "176", + "Saudi Arabia" + ], + [ + "177", + "Senegal" + ], + [ + "178", + "Seychelles" + ], + [ + "179", + "Sierra Leone" + ], + [ + "180", + "Singapore" + ], + [ + "181", + "Slovakia" + ], + [ + "182", + "Slovenia" + ], + [ + "183", + "Solomon Islands" + ], + [ + "184", + "Somalia" + ], + [ + "185", + "South Africa" + ], + [ + "186", + "Spain" + ], + [ + "187", + "Sri Lanka" + ], + [ + "189", + "Suriname" + ], + [ + "190", + "Svalbard" + ], + [ + "191", + "Swaziland" + ], + [ + "192", + "Sweden" + ], + [ + "193", + "Switzerland" + ], + [ + "194", + "Syria" + ], + [ + "196", + "Taiwan" + ], + [ + "197", + "Tajikistan" + ], + [ + "198", + "Tanzania" + ], + [ + "199", + "Thailand" + ], + [ + "200", + "Togo" + ], + [ + "201", + "Tonga" + ], + [ + "202", + "Trinidad and Tobago" + ], + [ + "203", + "Tunisia" + ], + [ + "204", + "Turkey" + ], + [ + "205", + "Turkmenistan" + ], + [ + "206", + "Turks and Caicos Islands" + ], + [ + "207", + "Tuvalu" + ], + [ + "208", + "Uganda" + ], + [ + "209", + "Ukraine" + ], + [ + "210", + "United Arab Emirates" + ], + [ + "211", + "Uruguay" + ], + [ + "212", + "Uzbekistan" + ], + [ + "213", + "Vanuatu" + ], + [ + "214", + "Vatican City State" + ], + [ + "215", + "Venezuela" + ], + [ + "216", + "Vietnam" + ], + [ + "217", + "Virgin Islands (U.S.)" + ], + [ + "218", + "Wallis and Futuna" + ], + [ + "219", + "Western Sahara" + ], + [ + "220", + "Western Samoa" + ], + [ + "221", + "Yemen" + ], + [ + "223", + "Zambia" + ], + [ + "224", + "Zimbabwe" + ], + [ + "226", + "Micronesia" + ], + [ + "227", + "Reunion" + ], + [ + "228", + "Montenegro" + ], + [ + "229", + "Serbia" + ] + ], + "description": "Parameter defines the location based on country. Head to the eBay location options for a full list of supported countries.", + "group": "localization" + }, + "_pgn": { + "type": "number", + "description": "Parameter defines the page number. It's used for pagination. (e.g., `1` (default) is the first page of results, `2` is the 2nd page of results, `3` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "_ipg": { + "type": "select", + "options": [ + [ + 50, + "50 - Items Per Page" + ], + [ + 25, + "25 - Items Per Page" + ], + [ + 100, + "100 - Items Per Page" + ], + [ + 200, + "200 - Items Per Page" + ] + ], + "description": "Parameter defines the maximum number of results to return. There are total of four options: `25`, `50` (default), `100` and `200` results.", + "group": "pagination" + }, + "_blrs": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. The recommended value for this parameter is `spell_auto_correct`. Omit `_blrs` if you want the search to include results for an auto-corrected query. Note that this parameter may not prevent eBay from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "show_only": { + "description": "Parameter defines the list of filters you can apply to the results. Available options (case-sensitive): `Complete` - Completed items `Sold` - Sold items `FR` - Free returns `RPA` - Returns accepted `AS` - Authorized seller `Savings` - Deals and savings `SaleItems` - Sale items `Lots` - Listed as lots `Charity` - Benefits charity `AV` - Authenticity Guarantee `FS` - Free shipping `LPickup` - Local pickup You can also combine multiple filter values by joining them with a comma (`value` + `,` + `value`; eg: `Sold,FS`).", + "group": "advanced_filters" + }, + "buying_format": { + "type": "select", + "options": [ + "Auction", + "BIN", + "BO" + ], + "description": "Parameter defines the buying format you can apply to the results. Available options (case-sensitive): `Auction` - Auction `BIN` - Buy It Now `BO` - Accepts Offers", + "group": "advanced_filters" + }, + "_udlo": { + "type": "number", + "description": "Parameter defines the lowest price of items that should be included in the results (e.g. `10` will only return items that have higher price than `10`).", + "group": "advanced_ebay_parameters" + }, + "_udhi": { + "type": "number", + "description": "Parameter defines the highest price of items that should be included in the results (e.g. `20` will only return items that have lower price than `20`).", + "group": "advanced_ebay_parameters" + }, + "_sop": { + "type": "select", + "options": [ + [ + "12", + "Best Match (default)" + ], + [ + "1", + "Time: ending soonest" + ], + [ + "10", + "Time: newly listed" + ], + [ + "15", + "Price + Shipping: lowest first" + ], + [ + "16", + "Price + Shipping: highest first" + ], + [ + "7", + "Distance: nearest first" + ], + [ + "3", + "Price: highest first" + ], + [ + "2", + "Price: lowest first" + ], + [ + "18", + "Condition: new first" + ], + [ + "19", + "Condition: used first" + ] + ], + "description": "Parameter defines results sorted by different options in the eBay. The default option is 'Best Match'. Head to the eBay sort options for a full list of supported sort options.", + "group": "advanced_ebay_parameters" + }, + "_dmd": { + "type": "select", + "options": [ + [ + "1", + "List" + ], + [ + "2", + "Grid" + ] + ], + "description": "Parameter defines the visual layout for displaying results. The available options are 'Grid' and 'List'.", + "group": "advanced_ebay_parameters" + }, + "category_id": { + "description": "Parameter defines the ID of a category where you want your search to be concentrated. ID values are accessible inside `categories` array, located in our JSON output (e.g. `categories[1].id`). You can search using category_id parameter without specifying _nkw parameter.", + "group": "advanced_ebay_parameters" + }, + "_stpos": { + "description": "Parameter defines the ZIP or Postal code. You can use it to filter the shipping products by a selected area.", + "group": "advanced_ebay_parameters" + }, + "LH_ItemCondition": { + "description": "Parameter defines one or multiple product conditions to limit the search to. Condition is represented via numeric ID, e.g. `1000` for `New`. Multiple IDs should be joined with `|` delimiter, e.g. `1000|3000`. List of supported IDs can be found on eBay documentation page. There is also undocumented ID `10` for `Not Specified` condition.", + "group": "advanced_ebay_parameters" + }, + "LH_PrefLoc": { + "type": "select", + "options": [ + [ + "1", + "Domestic" + ], + [ + "3", + "Regional" + ], + [ + "2", + "Worldwide" + ] + ], + "description": "Parameter defines the preferred location. The available options are 'Domestic', 'Regional', and 'Worldwide'.", + "group": "advanced_ebay_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `ebay` to use the Ebay API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Ebay results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/ebay_product.json b/engines/ebay_product.json new file mode 100644 index 0000000..44641d5 --- /dev/null +++ b/engines/ebay_product.json @@ -0,0 +1,539 @@ +{ + "engine": "ebay_product", + "params": { + "product_id": { + "required": true, + "description": "Parameter defines an ID of the product to get results for. Normally, it can be found in product link from search results: `https://www.ebay.com/itm/{product_id}`", + "group": "search_query" + }, + "ebay_domain": { + "type": "select", + "options": [ + "ebay.com.au", + "ebay.at", + "ebay.ca", + "ebay.fr", + "ebay.de", + "ebay.com.hk", + "ebay.ie", + "ebay.it", + "ebay.com.my", + "ebay.nl", + "ebay.ph", + "ebay.pl", + "ebay.com.sg", + "ebay.es", + "ebay.ch", + "ebay.co.uk", + "ebay.com" + ], + "description": "Parameter defines the eBay domain to use. It defaults to `ebay.com`. Head to the eBay domains for a full list of supported domains.", + "group": "localization" + }, + "locale": { + "required": false, + "type": "select", + "options": [ + "US", + "CA", + "GB", + "AF", + "AL", + "DZ", + "AS", + "AD", + "AO", + "AI", + "AG", + "AR", + "AM", + "AW", + "AU", + "AT", + "AZ", + "BS", + "BH", + "BD", + "BB", + "BY", + "BE", + "BZ", + "BJ", + "BM", + "BT", + "BO", + "BA", + "BW", + "BR", + "VG", + "BN", + "BG", + "BF", + "MM", + "BI", + "KH", + "CM", + "CV", + "KY", + "CF", + "TD", + "CL", + "CN", + "CO", + "KM", + "CD", + "CG", + "CK", + "CR", + "CI", + "HR", + "CU", + "CY", + "CZ", + "DK", + "DJ", + "DM", + "DO", + "EC", + "EG", + "SV", + "GQ", + "ER", + "EE", + "ET", + "FK", + "FJ", + "FI", + "FR", + "GF", + "PF", + "GA", + "GM", + "GE", + "DE", + "GH", + "GI", + "GR", + "GL", + "GD", + "GP", + "GU", + "GT", + "GG", + "GN", + "GW", + "GY", + "HT", + "HN", + "HK", + "HU", + "IS", + "IN", + "ID", + "IR", + "IQ", + "IE", + "IL", + "IT", + "JM", + "JP", + "JE", + "JO", + "KZ", + "KE", + "KI", + "KR", + "KW", + "KG", + "LA", + "LV", + "LB", + "LS", + "LR", + "LY", + "LI", + "LT", + "LU", + "MO", + "MK", + "MG", + "MW", + "MY", + "MV", + "ML", + "MT", + "MH", + "MQ", + "MR", + "MU", + "YT", + "MX", + "MD", + "MC", + "MN", + "MS", + "MA", + "MZ", + "NA", + "NR", + "NP", + "NL", + "AN", + "NC", + "NZ", + "NI", + "NE", + "NG", + "NU", + "NO", + "OM", + "PK", + "PW", + "PA", + "PG", + "PY", + "PE", + "PH", + "PL", + "PT", + "PR", + "QA", + "RO", + "RU", + "RW", + "SH", + "KN", + "LC", + "PM", + "VC", + "SM", + "SA", + "SN", + "SC", + "SL", + "SG", + "SK", + "SI", + "SB", + "SO", + "ZA", + "ES", + "LK", + "SD", + "SR", + "SJ", + "SZ", + "SE", + "CH", + "SY", + "TW", + "TJ", + "TZ", + "TH", + "TG", + "TO", + "TT", + "TN", + "TR", + "TM", + "TC", + "TV", + "UG", + "UA", + "AE", + "UY", + "UZ", + "VU", + "VA", + "VE", + "VN", + "VI", + "WF", + "EH", + "WS", + "YE", + "ZM", + "ZW", + "FM", + "RE", + "ME", + "RS" + ], + "description": "Parameter defines from where you want the search to originate from. Head to the eBay locales for a full list of supported locales.", + "group": "localization" + }, + "lang": { + "required": false, + "type": "select", + "options": [ + "en-us" + ], + "description": "Parameter defines the language to use for the search. Normally, it defaults to `en-US`, but some locales use localized interface (Japan, Argentina etc.) so override might be helpful. This parameter available only for `United States` eBay domain and only when `locale` is set.", + "group": "localization" + }, + "shipping_country": { + "type": "select", + "options": [ + "US", + "CA", + "GB", + "AF", + "AL", + "DZ", + "AS", + "AD", + "AO", + "AI", + "AG", + "AR", + "AM", + "AW", + "AU", + "AT", + "AZ", + "BS", + "BH", + "BD", + "BB", + "BY", + "BE", + "BZ", + "BJ", + "BM", + "BT", + "BO", + "BA", + "BW", + "BR", + "VG", + "BN", + "BG", + "BF", + "MM", + "BI", + "KH", + "CM", + "CV", + "KY", + "CF", + "TD", + "CL", + "CN", + "CO", + "KM", + "CD", + "CG", + "CK", + "CR", + "CI", + "HR", + "CU", + "CY", + "CZ", + "DK", + "DJ", + "DM", + "DO", + "EC", + "EG", + "SV", + "GQ", + "ER", + "EE", + "ET", + "FK", + "FJ", + "FI", + "FR", + "GF", + "PF", + "GA", + "GM", + "GE", + "DE", + "GH", + "GI", + "GR", + "GL", + "GD", + "GP", + "GU", + "GT", + "GG", + "GN", + "GW", + "GY", + "HT", + "HN", + "HK", + "HU", + "IS", + "IN", + "ID", + "IR", + "IQ", + "IE", + "IL", + "IT", + "JM", + "JP", + "JE", + "JO", + "KZ", + "KE", + "KI", + "KR", + "KW", + "KG", + "LA", + "LV", + "LB", + "LS", + "LR", + "LY", + "LI", + "LT", + "LU", + "MO", + "MK", + "MG", + "MW", + "MY", + "MV", + "ML", + "MT", + "MH", + "MQ", + "MR", + "MU", + "YT", + "MX", + "MD", + "MC", + "MN", + "MS", + "MA", + "MZ", + "NA", + "NR", + "NP", + "NL", + "AN", + "NC", + "NZ", + "NI", + "NE", + "NG", + "NU", + "NO", + "OM", + "PK", + "PW", + "PA", + "PG", + "PY", + "PE", + "PH", + "PL", + "PT", + "PR", + "QA", + "RO", + "RU", + "RW", + "SH", + "KN", + "LC", + "PM", + "VC", + "SM", + "SA", + "SN", + "SC", + "SL", + "SG", + "SK", + "SI", + "SB", + "SO", + "ZA", + "ES", + "LK", + "SD", + "SR", + "SJ", + "SZ", + "SE", + "CH", + "SY", + "TW", + "TJ", + "TZ", + "TH", + "TG", + "TO", + "TT", + "TN", + "TR", + "TM", + "TC", + "TV", + "UG", + "UA", + "AE", + "UY", + "UZ", + "VU", + "VA", + "VE", + "VN", + "VI", + "WF", + "EH", + "WS", + "YE", + "ZM", + "ZW", + "FM", + "RE", + "ME", + "RS" + ], + "description": "Parameter defines the shipping country to use for shipping data calculation. Head to the eBay shipping countries for a full list of supported countries.", + "group": "advanced_ebay_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `ebay_product` to use the Ebay Product API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Ebay Product results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/facebook_profile.json b/engines/facebook_profile.json new file mode 100644 index 0000000..7ca51dc --- /dev/null +++ b/engines/facebook_profile.json @@ -0,0 +1,43 @@ +{ + "engine": "facebook_profile", + "params": { + "profile_id": { + "required": true, + "description": "Parameter defines the Facebook profile ID. You can find it in the URL of the profile page. For example, in `https://www.facebook.com/Meta`, the profile ID is `Meta`; in `https://facebook.com/profile.php?id=100080376596424`, the profile ID is `100080376596424`.", + "group": "search_query" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `facebook_profile` to use the Facebook Profile API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Facebook Profile results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google.json b/engines/google.json new file mode 100644 index 0000000..0ceef57 --- /dev/null +++ b/engines/google.json @@ -0,0 +1,786 @@ +{ + "engine": "google", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google search. e.g. `inurl:`, `site:`, `intitle:`. We also support advanced search query parameters such as as_dt and as_eq. See the full list of supported advanced search query parameters.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy. When only the location parameter is set, Google may still take into account the proxy\u2019s country, which can influence some results. For more consistent country-specific filtering, use the gl parameter alongside location.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "ludocid": { + "description": "Parameter defines the Google CID (customer identifier) of a place. This parameter can be found in Google Search API and Google Local API local results under the name of place_id, as well as in Google Maps API local results under the name of data_cid. You can also acquire it using Google's CID converter.", + "group": "advanced_google_parameters" + }, + "lsig": { + "description": "Parameter that you might have to use to force the knowledge graph map view to show up. You can find the lsig ID by using our Local Pack API or Google Local API. lsig ID is also available via a redirect Google uses within Google My Business.", + "group": "advanced_google_parameters" + }, + "kgmid": { + "description": "Parameter defines the id (`KGMID`) of the Google Knowledge Graph listing you want to scrape. Also known as Google Knowledge Graph ID. Searches with kgmid parameter will return results for the originally encrypted search parameters. For some searches, kgmid may override all other parameters except start parameter.", + "group": "advanced_google_parameters" + }, + "si": { + "description": "Parameter defines the cached search parameters of the Google Search you want to scrape. Searches with si parameter will return results for the originally encrypted search parameters. For some searches, si may override all other parameters except startsi can be used to scrape Google Knowledge Graph Tabs.", + "group": "advanced_google_parameters" + }, + "ibp": { + "description": "Parameter is responsible for rendering layouts and expansions for some elements (e.g., `gwp;0,7` to expand searches with `ludocid` for expanded knowledge graph).", + "group": "advanced_google_parameters" + }, + "uds": { + "description": "Parameter enables to filter search. It's a string provided by Google as a filter. `uds` values are provided under the section: `filters` with `uds`, `q` and `serpapi_link` values provided for each filter.", + "group": "advanced_google_parameters" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "cr": { + "description": "Parameter defines one or multiple countries to limit the search to. It uses `country{two-letter upper-case country code}` to specify countries and `|` as a delimiter. (e.g., `countryFR|countryDE` will only search French and German pages). Head to the Google cr countries page for a full list of supported countries.", + "group": "localization" + }, + "lr": { + "description": "Parameter defines one or multiple languages to limit the search to. It uses `lang_{two-letter language code}` to specify languages and `|` as a delimiter. (e.g., `lang_fr|lang_de` will only search French and German pages). Head to the Google lr languages page for a full list of supported languages.", + "group": "localization" + }, + "as_dt": { + "description": "Parameter controls whether to include or exclude results from the site named in the as_sitesearch parameter.", + "group": "advanced_search_query_parameters" + }, + "as_epq": { + "description": "Parameter identifies a phrase that all documents in the search results must contain. You can also use the phrase search query term to search for a phrase.", + "group": "advanced_search_query_parameters" + }, + "as_eq": { + "description": "Parameter identifies a word or phrase that should not appear in any documents in the search results. You can also use the exclude query term to ensure that a particular word or phrase will not appear in the documents in a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_lq": { + "description": "Parameter specifies that all search results should contain a link to a particular URL. You can also use the link: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_nlo": { + "description": "Parameter specifies the starting value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_nhi": { + "description": "Parameter specifies the ending value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_oq": { + "description": "Parameter provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_q": { + "description": "Parameter provides search terms to check for in a document. This parameter is also commonly used to allow users to specify additional terms to search for within a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_qdr": { + "description": "Parameter requests search results from a specified time period (quick date range). The following values are supported: `d[number]`: requests results from the specified number of past days. Example for the past 10 days: `as_qdr=d10` `w[number]`: requests results from the specified number of past weeks. `m[number]`: requests results from the specified number of past months. `y[number]`: requests results from the specified number of past years. Example for the past year: `as_qdr=y`", + "group": "advanced_search_query_parameters" + }, + "as_rq": { + "description": "Parameter specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. You can also use the related: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_sitesearch": { + "description": "Parameter allows you to specify that all search results should be pages from a given site. By setting the as_dt parameter, you can also use it to exclude pages from a given site from your search results.", + "group": "advanced_search_query_parameters" + }, + "tbs": { + "description": "(to be searched) parameter defines advanced search parameters that aren't possible in the regular query field. (e.g., advanced search for patents, dates, news, videos, images, apps, or text contents).", + "group": "advanced_filters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "nfpr": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude these results, or `0` to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + }, + "tbm": { + "type": "select", + "options": [ + "isch", + "lcl", + "nws", + "shop", + "vid", + "pts" + ], + "description": "(to be matched) parameter defines the type of search you want to do. It can be set to: `(no tbm parameter)`: regular Google Search, `isch`: Google Images API, `lcl` - Google Local API `vid`: Google Videos API, `nws`: Google News API, `shop`: Google Shopping API, `pts`: Google Patents API, or any other Google service.", + "group": "search_type" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": false, + "description": "Set parameter to `google` (default) to use the Google API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_about_this_result.json b/engines/google_about_this_result.json new file mode 100644 index 0000000..6f574b1 --- /dev/null +++ b/engines/google_about_this_result.json @@ -0,0 +1,239 @@ +{ + "engine": "google_about_this_result", + "params": { + "q": { + "required": true, + "description": "Parameter defines the URL of a website which results you what to show. Value should be formatted in the next order: `About URL` (e.g. `About https://www.starbucks.com/`)", + "group": "search_query" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "ilps": { + "description": "Parameter defines unique ID of a website which results you what to show.", + "group": "advanced_about_this_result_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_about_this_result` to use the Google About This Result API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google About This Result results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_ads_transparency_center.json b/engines/google_ads_transparency_center.json new file mode 100644 index 0000000..e3916c6 --- /dev/null +++ b/engines/google_ads_transparency_center.json @@ -0,0 +1,1053 @@ +{ + "engine": "google_ads_transparency_center", + "params": { + "advertiser_id": { + "description": "Parameter defines the Google Advertiser ID. It can be found in the Ads Transparency Center advertiser URL. For example, the advertiser ID for the URL `https://adstransparency.google.com/advertiser/AR17828074650563772417` is `AR17828074650563772417`(Tesla Inc). It accepts either a single ID or multiple IDs separated by commas (`,`). Example, Single ID: `AR17828074650563772417` Multiple IDs: `AR17828074650563772417,AR03911981557522366465,...` Alternatively, text can be used for free-text search.", + "group": "search_query" + }, + "text": { + "description": "Parameter defines the text you want to search, typically related to a domain search within the context of Google Ads. You can use anything that you would normally use in a standard Google Ads Transparency Center search. It can be used as an alternative to advertiser_id. The advertiser_id can be optional when text is present.", + "group": "advanced_ads_transparency_parameters" + }, + "platform": { + "type": "select", + "options": [ + "PLAY", + "MAPS", + "SEARCH", + "SHOPPING", + "YOUTUBE" + ], + "description": "Parameter defines the target platform where ads are displayed. When not set, it will return results from all platforms (default). Available options: `PLAY` - Google Play `MAPS` - Google Maps `SEARCH` - Google Search `SHOPPING` - Google Shopping `YOUTUBE` - YouTube.", + "group": "advanced_ads_transparency_parameters" + }, + "political_ads": { + "type": "checkbox", + "description": "The parameter determine if the advertiser promotes political advertisement. Political advertisement is a different category than regular advertisements, and will not appear on the results unless this parameter is set to `true`. If this parameter is set to `true`, only political advertisements will appear on the results. By default it is `false`. This parameter can only be used alongside with the `region` parameter.", + "group": "advanced_ads_transparency_parameters" + }, + "region": { + "type": "dropdown", + "options": [ + [ + "2008", + "Albania" + ], + [ + "2010", + "Antarctica" + ], + [ + "2012", + "Algeria" + ], + [ + "2016", + "American Samoa" + ], + [ + "2020", + "Andorra" + ], + [ + "2024", + "Angola" + ], + [ + "2028", + "Antigua and Barbuda" + ], + [ + "2031", + "Azerbaijan" + ], + [ + "2032", + "Argentina" + ], + [ + "2036", + "Australia" + ], + [ + "2040", + "Austria" + ], + [ + "2044", + "The Bahamas" + ], + [ + "2048", + "Bahrain" + ], + [ + "2050", + "Bangladesh" + ], + [ + "2051", + "Armenia" + ], + [ + "2052", + "Barbados" + ], + [ + "2056", + "Belgium" + ], + [ + "2060", + "Bermuda" + ], + [ + "2064", + "Bhutan" + ], + [ + "2068", + "Bolivia" + ], + [ + "2070", + "Bosnia and Herzegovina" + ], + [ + "2072", + "Botswana" + ], + [ + "2074", + "Bouvet Island" + ], + [ + "2076", + "Brazil" + ], + [ + "2084", + "Belize" + ], + [ + "2086", + "British Indian Ocean Territory" + ], + [ + "2090", + "Solomon Islands" + ], + [ + "2092", + "British Virgin Islands" + ], + [ + "2096", + "Brunei" + ], + [ + "2100", + "Bulgaria" + ], + [ + "2104", + "Myanmar (Burma)" + ], + [ + "2108", + "Burundi" + ], + [ + "2112", + "Belarus" + ], + [ + "2116", + "Cambodia" + ], + [ + "2120", + "Cameroon" + ], + [ + "2124", + "Canada" + ], + [ + "2132", + "Cabo Verde" + ], + [ + "2136", + "Cayman Islands" + ], + [ + "2140", + "Central African Republic" + ], + [ + "2144", + "Sri Lanka" + ], + [ + "2148", + "Chad" + ], + [ + "2152", + "Chile" + ], + [ + "2156", + "China" + ], + [ + "2158", + "Taiwan" + ], + [ + "2162", + "Christmas Island" + ], + [ + "2166", + "Cocos (Keeling) Islands" + ], + [ + "2170", + "Colombia" + ], + [ + "2174", + "Comoros" + ], + [ + "2175", + "Mayotte" + ], + [ + "2178", + "Republic of the Congo" + ], + [ + "2180", + "Democratic Republic of the Congo" + ], + [ + "2184", + "Cook Islands" + ], + [ + "2188", + "Costa Rica" + ], + [ + "2191", + "Croatia" + ], + [ + "2196", + "Cyprus" + ], + [ + "2203", + "Czechia" + ], + [ + "2204", + "Benin" + ], + [ + "2208", + "Denmark" + ], + [ + "2212", + "Dominica" + ], + [ + "2214", + "Dominican Republic" + ], + [ + "2218", + "Ecuador" + ], + [ + "2222", + "El Salvador" + ], + [ + "2226", + "Equatorial Guinea" + ], + [ + "2231", + "Ethiopia" + ], + [ + "2232", + "Eritrea" + ], + [ + "2233", + "Estonia" + ], + [ + "2234", + "Faroe Islands" + ], + [ + "2238", + "Falkland Islands (Islas Malvinas)" + ], + [ + "2239", + "South Georgia and the South Sandwich Islands" + ], + [ + "2242", + "Fiji" + ], + [ + "2246", + "Finland" + ], + [ + "2250", + "France" + ], + [ + "2254", + "French Guiana" + ], + [ + "2258", + "French Polynesia" + ], + [ + "2260", + "French Southern and Antarctic Lands" + ], + [ + "2262", + "Djibouti" + ], + [ + "2266", + "Gabon" + ], + [ + "2268", + "Georgia" + ], + [ + "2270", + "The Gambia" + ], + [ + "2275", + "Palestine" + ], + [ + "2276", + "Germany" + ], + [ + "2288", + "Ghana" + ], + [ + "2292", + "Gibraltar" + ], + [ + "2296", + "Kiribati" + ], + [ + "2300", + "Greece" + ], + [ + "2304", + "Greenland" + ], + [ + "2308", + "Grenada" + ], + [ + "2312", + "Guadeloupe" + ], + [ + "2316", + "Guam" + ], + [ + "2320", + "Guatemala" + ], + [ + "2324", + "Guinea" + ], + [ + "2328", + "Guyana" + ], + [ + "2332", + "Haiti" + ], + [ + "2334", + "Heard Island and McDonald Islands" + ], + [ + "2336", + "Vatican City" + ], + [ + "2340", + "Honduras" + ], + [ + "2344", + "Hong Kong" + ], + [ + "2348", + "Hungary" + ], + [ + "2352", + "Iceland" + ], + [ + "2356", + "India" + ], + [ + "2360", + "Indonesia" + ], + [ + "2368", + "Iraq" + ], + [ + "2372", + "Ireland" + ], + [ + "2376", + "Israel" + ], + [ + "2380", + "Italy" + ], + [ + "2384", + "Cote d'Ivoire" + ], + [ + "2388", + "Jamaica" + ], + [ + "2392", + "Japan" + ], + [ + "2398", + "Kazakhstan" + ], + [ + "2400", + "Jordan" + ], + [ + "2404", + "Kenya" + ], + [ + "2410", + "South Korea" + ], + [ + "2414", + "Kuwait" + ], + [ + "2417", + "Kyrgyzstan" + ], + [ + "2418", + "Laos" + ], + [ + "2422", + "Lebanon" + ], + [ + "2426", + "Lesotho" + ], + [ + "2428", + "Latvia" + ], + [ + "2430", + "Liberia" + ], + [ + "2434", + "Libya" + ], + [ + "2438", + "Liechtenstein" + ], + [ + "2440", + "Lithuania" + ], + [ + "2442", + "Luxembourg" + ], + [ + "2446", + "Macao" + ], + [ + "2450", + "Madagascar" + ], + [ + "2454", + "Malawi" + ], + [ + "2458", + "Malaysia" + ], + [ + "2462", + "Maldives" + ], + [ + "2466", + "Mali" + ], + [ + "2470", + "Malta" + ], + [ + "2474", + "Martinique" + ], + [ + "2478", + "Mauritania" + ], + [ + "2480", + "Mauritius" + ], + [ + "2484", + "Mexico" + ], + [ + "2492", + "Monaco" + ], + [ + "2496", + "Mongolia" + ], + [ + "2498", + "Moldova" + ], + [ + "2499", + "Montenegro" + ], + [ + "2500", + "Montserrat" + ], + [ + "2504", + "Morocco" + ], + [ + "2508", + "Mozambique" + ], + [ + "2512", + "Oman" + ], + [ + "2516", + "Namibia" + ], + [ + "2520", + "Nauru" + ], + [ + "2524", + "Nepal" + ], + [ + "2528", + "Netherlands" + ], + [ + "2531", + "Curacao" + ], + [ + "2533", + "Aruba" + ], + [ + "2534", + "Sint Maarten" + ], + [ + "2535", + "Caribbean Netherlands" + ], + [ + "2540", + "New Caledonia" + ], + [ + "2548", + "Vanuatu" + ], + [ + "2554", + "New Zealand" + ], + [ + "2558", + "Nicaragua" + ], + [ + "2562", + "Niger" + ], + [ + "2566", + "Nigeria" + ], + [ + "2570", + "Niue" + ], + [ + "2574", + "Norfolk Island" + ], + [ + "2578", + "Norway" + ], + [ + "2580", + "Northern Mariana Islands" + ], + [ + "2581", + "United States Minor Outlying Islands" + ], + [ + "2583", + "Micronesia" + ], + [ + "2584", + "Marshall Islands" + ], + [ + "2585", + "Palau" + ], + [ + "2586", + "Pakistan" + ], + [ + "2591", + "Panama" + ], + [ + "2598", + "Papua New Guinea" + ], + [ + "2600", + "Paraguay" + ], + [ + "2604", + "Peru" + ], + [ + "2608", + "Philippines" + ], + [ + "2612", + "Pitcairn Islands" + ], + [ + "2616", + "Poland" + ], + [ + "2620", + "Portugal" + ], + [ + "2624", + "Guinea-Bissau" + ], + [ + "2626", + "Timor-Leste" + ], + [ + "2630", + "Puerto Rico" + ], + [ + "2634", + "Qatar" + ], + [ + "2638", + "Reunion" + ], + [ + "2642", + "Romania" + ], + [ + "2646", + "Rwanda" + ], + [ + "2654", + "Saint Helena, Ascension and Tristan da Cunha" + ], + [ + "2659", + "Saint Kitts and Nevis" + ], + [ + "2660", + "Anguilla" + ], + [ + "2662", + "Saint Lucia" + ], + [ + "2663", + "Saint Martin" + ], + [ + "2666", + "Saint Pierre and Miquelon" + ], + [ + "2670", + "Saint Vincent and the Grenadines" + ], + [ + "2674", + "San Marino" + ], + [ + "2678", + "Sao Tome and Principe" + ], + [ + "2682", + "Saudi Arabia" + ], + [ + "2686", + "Senegal" + ], + [ + "2690", + "Seychelles" + ], + [ + "2694", + "Sierra Leone" + ], + [ + "2702", + "Singapore" + ], + [ + "2703", + "Slovakia" + ], + [ + "2704", + "Vietnam" + ], + [ + "2705", + "Slovenia" + ], + [ + "2706", + "Somalia" + ], + [ + "2710", + "South Africa" + ], + [ + "2716", + "Zimbabwe" + ], + [ + "2724", + "Spain" + ], + [ + "2732", + "Western Sahara" + ], + [ + "2740", + "Suriname" + ], + [ + "2744", + "Svalbard and Jan Mayen" + ], + [ + "2748", + "Eswatini" + ], + [ + "2752", + "Sweden" + ], + [ + "2756", + "Switzerland" + ], + [ + "2762", + "Tajikistan" + ], + [ + "2764", + "Thailand" + ], + [ + "2768", + "Togo" + ], + [ + "2772", + "Tokelau" + ], + [ + "2776", + "Tonga" + ], + [ + "2780", + "Trinidad and Tobago" + ], + [ + "2784", + "United Arab Emirates" + ], + [ + "2788", + "Tunisia" + ], + [ + "2792", + "Turkiye" + ], + [ + "2795", + "Turkmenistan" + ], + [ + "2796", + "Turks and Caicos Islands" + ], + [ + "2798", + "Tuvalu" + ], + [ + "2800", + "Uganda" + ], + [ + "2804", + "Ukraine" + ], + [ + "2807", + "North Macedonia" + ], + [ + "2818", + "Egypt" + ], + [ + "2826", + "United Kingdom" + ], + [ + "2831", + "Guernsey" + ], + [ + "2832", + "Jersey" + ], + [ + "2833", + "Isle of Man" + ], + [ + "2834", + "Tanzania" + ], + [ + "2840", + "United States" + ], + [ + "2850", + "U.S. Virgin Islands" + ], + [ + "2854", + "Burkina Faso" + ], + [ + "2858", + "Uruguay" + ], + [ + "2860", + "Uzbekistan" + ], + [ + "2862", + "Venezuela" + ], + [ + "2876", + "Wallis and Futuna" + ], + [ + "2882", + "Samoa" + ], + [ + "2887", + "Yemen" + ], + [ + "2894", + "Zambia" + ], + [ + "20277", + "Canary Islands" + ] + ], + "description": "Parameter defines from where you want the search to originate. By default it search results from anywhere. Head to the Google Ads Transparency Center Regions for a full list of supported regions.", + "group": "geographic_location" + }, + "start_date": { + "description": "Parameter defines the start date for which you want the search results to begin. The format for this field is `YYYYMMDD`. Example: `20221201`", + "group": "date_range" + }, + "end_date": { + "description": "Parameter defines the end date for which you want the search results to conclude. The format for this field is `YYYYMMDD`. Example: `20221231` To set the date for Today / Single Day, you should set end_date as start_date + `1 day`.", + "group": "date_range" + }, + "creative_format": { + "type": "dropdown", + "options": [ + "text", + "image", + "video" + ], + "description": "Parameter defines the format you want to filter by. Only search results with a similar format will be returned. Available options: `text` - Text `image` - Image `video` - Video", + "group": "advanced_filters" + }, + "num": { + "type": "number", + "description": "Parameter defines the maximum number of results to return. (e.g., `40` (default) returns `40` results and `100` returns `100` results).", + "group": "pagination" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_ads_transparency_center` to use the Google Ads Transparency Center API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Ads Transparency Center results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_ads_transparency_center_ad_details.json b/engines/google_ads_transparency_center_ad_details.json new file mode 100644 index 0000000..d070bdf --- /dev/null +++ b/engines/google_ads_transparency_center_ad_details.json @@ -0,0 +1,1011 @@ +{ + "engine": "google_ads_transparency_center_ad_details", + "params": { + "advertiser_id": { + "required": true, + "description": "Parameter defines the Google Advertiser ID. It can be found in the Ads Transparency Center advertiser URL. For example, the advertiser ID for the URL `https://adstransparency.google.com/advertiser/AR17828074650563772417` is `AR17828074650563772417`(Tesla Inc).", + "group": "search_query" + }, + "creative_id": { + "required": true, + "description": "Parameter defines the Google Creative ID. It can be found in the Ads Transparency Center creative URL. For example, the creative ID for the URL `https://adstransparency.google.com/advertiser/AR17828074650563772417/creative/CR07110512387970564097` is `CR07110512387970564097`.", + "group": "search_query" + }, + "region": { + "type": "dropdown", + "options": [ + [ + "2008", + "Albania" + ], + [ + "2010", + "Antarctica" + ], + [ + "2012", + "Algeria" + ], + [ + "2016", + "American Samoa" + ], + [ + "2020", + "Andorra" + ], + [ + "2024", + "Angola" + ], + [ + "2028", + "Antigua and Barbuda" + ], + [ + "2031", + "Azerbaijan" + ], + [ + "2032", + "Argentina" + ], + [ + "2036", + "Australia" + ], + [ + "2040", + "Austria" + ], + [ + "2044", + "The Bahamas" + ], + [ + "2048", + "Bahrain" + ], + [ + "2050", + "Bangladesh" + ], + [ + "2051", + "Armenia" + ], + [ + "2052", + "Barbados" + ], + [ + "2056", + "Belgium" + ], + [ + "2060", + "Bermuda" + ], + [ + "2064", + "Bhutan" + ], + [ + "2068", + "Bolivia" + ], + [ + "2070", + "Bosnia and Herzegovina" + ], + [ + "2072", + "Botswana" + ], + [ + "2074", + "Bouvet Island" + ], + [ + "2076", + "Brazil" + ], + [ + "2084", + "Belize" + ], + [ + "2086", + "British Indian Ocean Territory" + ], + [ + "2090", + "Solomon Islands" + ], + [ + "2092", + "British Virgin Islands" + ], + [ + "2096", + "Brunei" + ], + [ + "2100", + "Bulgaria" + ], + [ + "2104", + "Myanmar (Burma)" + ], + [ + "2108", + "Burundi" + ], + [ + "2112", + "Belarus" + ], + [ + "2116", + "Cambodia" + ], + [ + "2120", + "Cameroon" + ], + [ + "2124", + "Canada" + ], + [ + "2132", + "Cabo Verde" + ], + [ + "2136", + "Cayman Islands" + ], + [ + "2140", + "Central African Republic" + ], + [ + "2144", + "Sri Lanka" + ], + [ + "2148", + "Chad" + ], + [ + "2152", + "Chile" + ], + [ + "2156", + "China" + ], + [ + "2158", + "Taiwan" + ], + [ + "2162", + "Christmas Island" + ], + [ + "2166", + "Cocos (Keeling) Islands" + ], + [ + "2170", + "Colombia" + ], + [ + "2174", + "Comoros" + ], + [ + "2175", + "Mayotte" + ], + [ + "2178", + "Republic of the Congo" + ], + [ + "2180", + "Democratic Republic of the Congo" + ], + [ + "2184", + "Cook Islands" + ], + [ + "2188", + "Costa Rica" + ], + [ + "2191", + "Croatia" + ], + [ + "2196", + "Cyprus" + ], + [ + "2203", + "Czechia" + ], + [ + "2204", + "Benin" + ], + [ + "2208", + "Denmark" + ], + [ + "2212", + "Dominica" + ], + [ + "2214", + "Dominican Republic" + ], + [ + "2218", + "Ecuador" + ], + [ + "2222", + "El Salvador" + ], + [ + "2226", + "Equatorial Guinea" + ], + [ + "2231", + "Ethiopia" + ], + [ + "2232", + "Eritrea" + ], + [ + "2233", + "Estonia" + ], + [ + "2234", + "Faroe Islands" + ], + [ + "2238", + "Falkland Islands (Islas Malvinas)" + ], + [ + "2239", + "South Georgia and the South Sandwich Islands" + ], + [ + "2242", + "Fiji" + ], + [ + "2246", + "Finland" + ], + [ + "2250", + "France" + ], + [ + "2254", + "French Guiana" + ], + [ + "2258", + "French Polynesia" + ], + [ + "2260", + "French Southern and Antarctic Lands" + ], + [ + "2262", + "Djibouti" + ], + [ + "2266", + "Gabon" + ], + [ + "2268", + "Georgia" + ], + [ + "2270", + "The Gambia" + ], + [ + "2275", + "Palestine" + ], + [ + "2276", + "Germany" + ], + [ + "2288", + "Ghana" + ], + [ + "2292", + "Gibraltar" + ], + [ + "2296", + "Kiribati" + ], + [ + "2300", + "Greece" + ], + [ + "2304", + "Greenland" + ], + [ + "2308", + "Grenada" + ], + [ + "2312", + "Guadeloupe" + ], + [ + "2316", + "Guam" + ], + [ + "2320", + "Guatemala" + ], + [ + "2324", + "Guinea" + ], + [ + "2328", + "Guyana" + ], + [ + "2332", + "Haiti" + ], + [ + "2334", + "Heard Island and McDonald Islands" + ], + [ + "2336", + "Vatican City" + ], + [ + "2340", + "Honduras" + ], + [ + "2344", + "Hong Kong" + ], + [ + "2348", + "Hungary" + ], + [ + "2352", + "Iceland" + ], + [ + "2356", + "India" + ], + [ + "2360", + "Indonesia" + ], + [ + "2368", + "Iraq" + ], + [ + "2372", + "Ireland" + ], + [ + "2376", + "Israel" + ], + [ + "2380", + "Italy" + ], + [ + "2384", + "Cote d'Ivoire" + ], + [ + "2388", + "Jamaica" + ], + [ + "2392", + "Japan" + ], + [ + "2398", + "Kazakhstan" + ], + [ + "2400", + "Jordan" + ], + [ + "2404", + "Kenya" + ], + [ + "2410", + "South Korea" + ], + [ + "2414", + "Kuwait" + ], + [ + "2417", + "Kyrgyzstan" + ], + [ + "2418", + "Laos" + ], + [ + "2422", + "Lebanon" + ], + [ + "2426", + "Lesotho" + ], + [ + "2428", + "Latvia" + ], + [ + "2430", + "Liberia" + ], + [ + "2434", + "Libya" + ], + [ + "2438", + "Liechtenstein" + ], + [ + "2440", + "Lithuania" + ], + [ + "2442", + "Luxembourg" + ], + [ + "2446", + "Macao" + ], + [ + "2450", + "Madagascar" + ], + [ + "2454", + "Malawi" + ], + [ + "2458", + "Malaysia" + ], + [ + "2462", + "Maldives" + ], + [ + "2466", + "Mali" + ], + [ + "2470", + "Malta" + ], + [ + "2474", + "Martinique" + ], + [ + "2478", + "Mauritania" + ], + [ + "2480", + "Mauritius" + ], + [ + "2484", + "Mexico" + ], + [ + "2492", + "Monaco" + ], + [ + "2496", + "Mongolia" + ], + [ + "2498", + "Moldova" + ], + [ + "2499", + "Montenegro" + ], + [ + "2500", + "Montserrat" + ], + [ + "2504", + "Morocco" + ], + [ + "2508", + "Mozambique" + ], + [ + "2512", + "Oman" + ], + [ + "2516", + "Namibia" + ], + [ + "2520", + "Nauru" + ], + [ + "2524", + "Nepal" + ], + [ + "2528", + "Netherlands" + ], + [ + "2531", + "Curacao" + ], + [ + "2533", + "Aruba" + ], + [ + "2534", + "Sint Maarten" + ], + [ + "2535", + "Caribbean Netherlands" + ], + [ + "2540", + "New Caledonia" + ], + [ + "2548", + "Vanuatu" + ], + [ + "2554", + "New Zealand" + ], + [ + "2558", + "Nicaragua" + ], + [ + "2562", + "Niger" + ], + [ + "2566", + "Nigeria" + ], + [ + "2570", + "Niue" + ], + [ + "2574", + "Norfolk Island" + ], + [ + "2578", + "Norway" + ], + [ + "2580", + "Northern Mariana Islands" + ], + [ + "2581", + "United States Minor Outlying Islands" + ], + [ + "2583", + "Micronesia" + ], + [ + "2584", + "Marshall Islands" + ], + [ + "2585", + "Palau" + ], + [ + "2586", + "Pakistan" + ], + [ + "2591", + "Panama" + ], + [ + "2598", + "Papua New Guinea" + ], + [ + "2600", + "Paraguay" + ], + [ + "2604", + "Peru" + ], + [ + "2608", + "Philippines" + ], + [ + "2612", + "Pitcairn Islands" + ], + [ + "2616", + "Poland" + ], + [ + "2620", + "Portugal" + ], + [ + "2624", + "Guinea-Bissau" + ], + [ + "2626", + "Timor-Leste" + ], + [ + "2630", + "Puerto Rico" + ], + [ + "2634", + "Qatar" + ], + [ + "2638", + "Reunion" + ], + [ + "2642", + "Romania" + ], + [ + "2646", + "Rwanda" + ], + [ + "2654", + "Saint Helena, Ascension and Tristan da Cunha" + ], + [ + "2659", + "Saint Kitts and Nevis" + ], + [ + "2660", + "Anguilla" + ], + [ + "2662", + "Saint Lucia" + ], + [ + "2663", + "Saint Martin" + ], + [ + "2666", + "Saint Pierre and Miquelon" + ], + [ + "2670", + "Saint Vincent and the Grenadines" + ], + [ + "2674", + "San Marino" + ], + [ + "2678", + "Sao Tome and Principe" + ], + [ + "2682", + "Saudi Arabia" + ], + [ + "2686", + "Senegal" + ], + [ + "2690", + "Seychelles" + ], + [ + "2694", + "Sierra Leone" + ], + [ + "2702", + "Singapore" + ], + [ + "2703", + "Slovakia" + ], + [ + "2704", + "Vietnam" + ], + [ + "2705", + "Slovenia" + ], + [ + "2706", + "Somalia" + ], + [ + "2710", + "South Africa" + ], + [ + "2716", + "Zimbabwe" + ], + [ + "2724", + "Spain" + ], + [ + "2732", + "Western Sahara" + ], + [ + "2740", + "Suriname" + ], + [ + "2744", + "Svalbard and Jan Mayen" + ], + [ + "2748", + "Eswatini" + ], + [ + "2752", + "Sweden" + ], + [ + "2756", + "Switzerland" + ], + [ + "2762", + "Tajikistan" + ], + [ + "2764", + "Thailand" + ], + [ + "2768", + "Togo" + ], + [ + "2772", + "Tokelau" + ], + [ + "2776", + "Tonga" + ], + [ + "2780", + "Trinidad and Tobago" + ], + [ + "2784", + "United Arab Emirates" + ], + [ + "2788", + "Tunisia" + ], + [ + "2792", + "Turkiye" + ], + [ + "2795", + "Turkmenistan" + ], + [ + "2796", + "Turks and Caicos Islands" + ], + [ + "2798", + "Tuvalu" + ], + [ + "2800", + "Uganda" + ], + [ + "2804", + "Ukraine" + ], + [ + "2807", + "North Macedonia" + ], + [ + "2818", + "Egypt" + ], + [ + "2826", + "United Kingdom" + ], + [ + "2831", + "Guernsey" + ], + [ + "2832", + "Jersey" + ], + [ + "2833", + "Isle of Man" + ], + [ + "2834", + "Tanzania" + ], + [ + "2840", + "United States" + ], + [ + "2850", + "U.S. Virgin Islands" + ], + [ + "2854", + "Burkina Faso" + ], + [ + "2858", + "Uruguay" + ], + [ + "2860", + "Uzbekistan" + ], + [ + "2862", + "Venezuela" + ], + [ + "2876", + "Wallis and Futuna" + ], + [ + "2882", + "Samoa" + ], + [ + "2887", + "Yemen" + ], + [ + "2894", + "Zambia" + ], + [ + "20277", + "Canary Islands" + ] + ], + "description": "Parameter defines from where you want the search to originate. By default it finds results from anywhere. Head to the Google Ads Transparency Center Regions for a full list of supported regions.", + "group": "geographic_location" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_ads_transparency_center_ad_details` to use the Google Ads Transparency Center Ad Details API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Ads Transparency Center Ad Details results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_ai_mode.json b/engines/google_ai_mode.json new file mode 100644 index 0000000..00ba854 --- /dev/null +++ b/engines/google_ai_mode.json @@ -0,0 +1,477 @@ +{ + "engine": "google_ai_mode", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google AI Mode search. Google AI Mode may support multiple languages (including English), though not all are available yet.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_ai_mode` to use the Google Ai Mode API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Ai Mode results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_ai_overview.json b/engines/google_ai_overview.json new file mode 100644 index 0000000..2886038 --- /dev/null +++ b/engines/google_ai_overview.json @@ -0,0 +1,43 @@ +{ + "engine": "google_ai_overview", + "params": { + "page_token": { + "required": true, + "description": "Parameter defines the token to fetch the AI Overview from. Use `ai_overview.page_token` from the AI Overview Results section of our Google Search API \u2014 see the extra request example. `ai_overview.page_token` expires within 1 minute of the search and should be used immediately.", + "group": "search_query" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_ai_overview` to use the Google AI Overview API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google AI Overview results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_autocomplete.json b/engines/google_autocomplete.json new file mode 100644 index 0000000..adb9814 --- /dev/null +++ b/engines/google_autocomplete.json @@ -0,0 +1,478 @@ +{ + "engine": "google_autocomplete", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. A query that would be used to provide completion options.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Autocomplete search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "cp": { + "description": "Cursor pointer defines the position of cursor for the query provided, position starts from 0 which is a case where cursor is placed before the query `|query`. If not provided acts as cursor is placed in the end of query `query|`.", + "group": "advanced_autocomplete_parameters" + }, + "client": { + "type": "select", + "options": [ + "chrome", + "chrome-omni", + "gws-wiz", + "safari", + "firefox", + "psy-ab", + "toolbar", + "youtube", + "gws-wiz-local" + ], + "description": "Parameter used to define client for autocomplete. List of supported clients.", + "group": "advanced_autocomplete_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_autocomplete` to use the Google Autocomplete API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Autocomplete results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_events.json b/engines/google_events.json new file mode 100644 index 0000000..4654ace --- /dev/null +++ b/engines/google_events.json @@ -0,0 +1,476 @@ +{ + "engine": "google_events", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. To search for events in a specific location, just include the location inside your search query (e.g. `Events in Austin, TX`).", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Events search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Events search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "htichips": { + "description": "Parameter allows the use of different filters. `date:today` - Today's Events `date:tomorrow` - Tomorrow's Events `date:week` - This Week's Events `date:today` - Today's Weekend's Events `date:next_week` - Next Week's Events `date:month` - This Month's Events `date:next_month` - Next Month's Events `event_type:Virtual-Event` - Online Events You can also mix different kinds of filters by separating them with a comma. `event_type:Virtual-Event,date:today` Today's Online Events", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_events` to use the Google Events API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Events results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_finance.json b/engines/google_finance.json new file mode 100644 index 0000000..20ccc6e --- /dev/null +++ b/engines/google_finance.json @@ -0,0 +1,222 @@ +{ + "engine": "google_finance", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. It can be a stock, index, mutual fund, currency or futures.", + "group": "search_query" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Finance search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "window": { + "type": "dropdown", + "options": [ + "1D", + "5D", + "1M", + "6M", + "YTD", + "1Y", + "5Y", + "MAX" + ], + "description": "Parameter is used for setting time range for the graph. It can be set to: `1D` - 1 Day(default) `5D` - 5 Days `1M` - 1 Month `6M` - 6 Months `YTD` - Year to Date `1Y` - 1 Year `5Y` - 5 Years `MAX` - Maximum", + "group": "advanced_google_finance_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_finance` to use the Google Finance API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Finance results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_finance_markets.json b/engines/google_finance_markets.json new file mode 100644 index 0000000..c9303d4 --- /dev/null +++ b/engines/google_finance_markets.json @@ -0,0 +1,478 @@ +{ + "engine": "google_finance_markets", + "params": { + "trend": { + "type": "select", + "options": [ + "indexes", + "most-active", + "gainers", + "losers", + "climate-leaders", + "cryptocurrencies", + "currencies" + ], + "required": true, + "description": "Parameter is used for retrieving different market trends. Available options: `indexes` - Market indexes `most-active` - Most active `gainers` - Gainers `losers` - Losers `climate-leaders` - Climate leaders `cryptocurrencies` - Crypto `currencies` - Currencies", + "group": "search_query" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Finance Markets search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Finance Markets search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "index_market": { + "type": "select", + "options": [ + "americas", + "europe-middle-east-africa", + "asia-pacific" + ], + "description": "Parameter is used for expanding market indexes by region and retrieving more results. Available options: `americas` - Americas `europe-middle-east-africa` - Europe, Middle East, and Africa `asia-pacific` - Asia Pacific Parameter can be used only when trend parameter is set to: `indexes`.", + "group": "advanced_google_finance_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_finance_markets` to use the Google Finance Markets API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Finance Markets results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_flights.json b/engines/google_flights.json new file mode 100644 index 0000000..4525381 --- /dev/null +++ b/engines/google_flights.json @@ -0,0 +1,740 @@ +{ + "engine": "google_flights", + "params": { + "departure_id": { + "description": "Parameter defines the departure airport code or location kgmid. An airport code is an uppercase 3-letter code. You can search for it on Google Flights or IATA. For example, `CDG` is Paris Charles de Gaulle Airport and `AUS` is Austin-Bergstrom International Airport. A location kgmid is a string that starts with `/m/`. You can search for a location on Wikidata and use its \"Freebase ID\" as the location kgmid. For example, `/m/0vzm` is the location kgmid for Austin, TX. You can specify multiple departure airports by separating them with a comma. For example, `CDG,ORY,/m/04jpl`.", + "group": "search_query" + }, + "arrival_id": { + "description": "Parameter defines the arrival airport code or location kgmid. An airport code is an uppercase 3-letter code. You can search for it on Google Flights or IATA. For example, `CDG` is Paris Charles de Gaulle Airport and `AUS` is Austin-Bergstrom International Airport. A location kgmid is a string that starts with `/m/`. You can search for a location on Wikidata and use its \"Freebase ID\" as the location kgmid. For example, `/m/0vzm` is the location kgmid for Austin, TX. You can specify multiple arrival airports by separating them with a comma. For example, `CDG,ORY,/m/04jpl`.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Flights search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Flights search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "currency": { + "type": "select", + "options": [ + "ALL", + "DZD", + "ARS", + "AMD", + "AWG", + "AUD", + "AZN", + "BSD", + "BHD", + "BYN", + "BMD", + "BAM", + "BRL", + "GBP", + "BGN", + "XPF", + "CAD", + "CLP", + "CNY", + "COP", + "CRC", + "CUP", + "CZK", + "DKK", + "DOP", + "EGP", + "EUR", + "GEL", + "HKD", + "HUF", + "ISK", + "INR", + "IDR", + "IRR", + "ILS", + "JMD", + "JPY", + "JOD", + "KZT", + "KWD", + "LBP", + "MKD", + "MYR", + "MXN", + "MDL", + "MAD", + "TWD", + "NZD", + "NOK", + "OMR", + "PKR", + "PAB", + "PEN", + "PHP", + "PLN", + "QAR", + "RON", + "RUB", + "SAR", + "RSD", + "SGD", + "ZAR", + "KRW", + "SEK", + "CHF", + "THB", + "TRY", + "USD", + "UAH", + "AED", + "VND" + ], + "description": "Parameter defines the currency of the returned prices. Default to `USD`. Head to the Google Travel Currencies page for a full list of supported currency codes.", + "group": "localization" + }, + "type": { + "type": "select", + "options": [ + [ + "1", + "Round trip (default) - 1" + ], + [ + "2", + "One way - 2" + ], + [ + "3", + "Multi-city - 3" + ] + ], + "description": "Parameter defines the type of the flights. Available options: `1` - Round trip (default) `2` - One way `3` - Multi-city When this parameter is set to `3`, use multi_city_json to set the flight information. To obtain the returning flight information for Round Trip `(1)`, you need to make another request using a departure_token.", + "group": "advanced_google_flights_parameters" + }, + "outbound_date": { + "description": "Parameter defines the outbound date. The format is YYYY-MM-DD. e.g. `2026-01-04`", + "group": "advanced_google_flights_parameters" + }, + "return_date": { + "description": "Parameter defines the return date. The format is YYYY-MM-DD. e.g. `2026-01-10` Parameter is required if type parameter is set to: `1` (Round trip)", + "group": "advanced_google_flights_parameters" + }, + "travel_class": { + "type": "select", + "options": [ + [ + 1, + "Economy (default) - 1" + ], + [ + 2, + "Premium economy - 2" + ], + [ + 3, + "Business - 3" + ], + [ + 4, + "First - 4" + ] + ], + "description": "Parameter defines the travel class. Available options: `1` - Economy (default) `2` - Premium economy `3` - Business `4` - First", + "group": "advanced_google_flights_parameters" + }, + "multi_city_json": { + "description": "Parameter defines the flight information for multi-city flights. It's a JSON string containing multiple flight information objects. Each object should contain the following fields: `departure_id` - The departure airport code or location kgmid. The format is the same as the main departure_id parameter. `arrival_id` - The arrival airport code or location kgmid. The format is the same as the main arrival_id parameter. `date` - Flight date. The format is the same as the outbound_date parameter. `times` - Time range for the flight. The format is the same as the outbound_times parameter. This parameter is optional. Example: `[{\"departure_id\":\"CDG\",\"arrival_id\":\"NRT\",\"date\":\"2026-01-10\"},{\"departure_id\":\"NRT\",\"arrival_id\":\"LAX,SEA\",\"date\":\"2026-01-17\"},{\"departure_id\":\"LAX,SEA\",\"arrival_id\":\"AUS\",\"date\":\"2026-01-24\",\"times\":\"8,18,9,23\"}]` The example is a multi-city flight from `CDG` to `NRT` on `2026-01-10`, then from `NRT` to `LAX` or `SEA` on `2026-01-17`, and finally from `LAX` or `SEA` to `AUS` on `2026-01-24`. The last flight has a departure time range from 8:00 AM to 7:00 PM and an arrival time range from 9:00 AM to 12:00 AM (Midnight).", + "group": "advanced_google_flights_parameters" + }, + "show_hidden": { + "type": "checkbox", + "description": "Set to `true` to include the hidden flight results. Default to `false`.", + "group": "advanced_google_flights_parameters" + }, + "exclude_basic": { + "type": "checkbox", + "description": "Set to `true` to exclude basic results. Resulting fares will have free seat selection and carry on bags. Default to `false`. As of now, this filter only works for domestic flights in the US. Parameter can only be used when gl is`us` and travel_class is`1`", + "group": "advanced_google_flights_parameters" + }, + "deep_search": { + "type": "checkbox", + "description": "Set to `true` to enable deep search, which may yield better results but with a longer response time. Deep search results are identical to those found on Google Flights pages in the browser. By default, this option is set to `false` for performance reasons.", + "group": "advanced_google_flights_parameters" + }, + "adults": { + "type": "number", + "description": "Parameter defines the number of adults. Default to 1.", + "group": "number_of_passengers" + }, + "children": { + "type": "number", + "description": "Parameter defines the number of children. Default to 0.", + "group": "number_of_passengers" + }, + "infants_in_seat": { + "type": "number", + "description": "Parameter defines the number of infants in seat. Default to 0.", + "group": "number_of_passengers" + }, + "infants_on_lap": { + "type": "number", + "description": "Parameter defines the number of infants on lap. Default to 0.", + "group": "number_of_passengers" + }, + "sort_by": { + "type": "select", + "options": [ + [ + "1", + "Top flights (default) - 1" + ], + [ + "2", + "Price - 2" + ], + [ + "3", + "Departure time - 3" + ], + [ + "4", + "Arrival time - 4" + ], + [ + "5", + "Duration - 5" + ], + [ + "6", + "Emissions - 6" + ] + ], + "description": "Parameter defines the sorting order of the results. Available options: `1` - Top flights (default) `2` - Price `3` - Departure time `4` - Arrival time `5` - Duration `6` - Emissions", + "group": "sorting" + }, + "stops": { + "type": "select", + "options": [ + [ + 0, + "Any number of stops (default) - 0" + ], + [ + 1, + "Nonstop only - 1" + ], + [ + 2, + "1 stop or fewer - 2" + ], + [ + 3, + "2 stops or fewer - 3" + ] + ], + "description": "Parameter defines the number of stops during the flight. Available options: `0` - Any number of stops (default) `1` - Nonstop only `2` - 1 stop or fewer `3` - 2 stops or fewer", + "group": "advanced_filters" + }, + "exclude_airlines": { + "description": "Parameter defines the airline codes to be excluded. Split multiple airlines with comma. It can't be used together with `include_airlines`. Each airline code should be a 2-character IATA code consisting of either two uppercase letters or one uppercase letter and one digit. You can search for airline codes on IATA. For example, `UA` is United Airlines. Additionally, alliances can be also included here: `STAR_ALLIANCE` - Star Alliance `SKYTEAM` - SkyTeam `ONEWORLD` - Oneworld exclude_airlines and include_airlines parameters can't be used together.", + "group": "advanced_filters" + }, + "include_airlines": { + "description": "Parameter defines the airline codes to be included. Split multiple airlines with comma. It can't be used together with `exclude_airlines`. Each airline code should be a 2-character IATA code consisting of either two uppercase letters or one uppercase letter and one digit. You can search for airline codes on IATA. For example, `UA` is United Airlines. Additionally, alliances can be also included here: `STAR_ALLIANCE` - Star Alliance `SKYTEAM` - SkyTeam `ONEWORLD` - Oneworld exclude_airlines and include_airlines parameters can't be used together.", + "group": "advanced_filters" + }, + "bags": { + "type": "number", + "description": "Parameter defines the number of carry-on bags. Default to `0`. Parameter should not exceed the total number of passengers with carry-on bag allowance (adults, children and infants_in_seat).", + "group": "advanced_filters" + }, + "max_price": { + "type": "number", + "description": "Parameter defines the maximum ticket price. Default to unlimited.", + "group": "advanced_filters" + }, + "outbound_times": { + "description": "Parameter defines the outbound times range. It's a string containing two (for departure only) or four (for departure and arrival) comma-separated numbers. Each number represents the beginning of an hour. For example: `4,18`: 4:00 AM - 7:00 PM departure `0,18`: 12:00 AM - 7:00 PM departure `19,23`: 7:00 PM - 12:00 AM departure `4,18,3,19`: 4:00 AM - 7:00 PM departure, 3:00 AM - 8:00 PM arrival `0,23,3,19`: unrestricted departure, 3:00 AM - 8:00 PM arrival", + "group": "advanced_filters" + }, + "return_times": { + "description": "Parameter defines the return times range. It's a string containing two (for departure only) or four (for departure and arrival) comma-separated numbers. Each number represents the beginning of an hour. For example: `4,18`: 4:00 AM - 7:00 PM departure `0,18`: 12:00 AM - 7:00 PM departure `19,23`: 7:00 PM - 12:00 AM departure `4,18,3,19`: 4:00 AM - 7:00 PM departure, 3:00 AM - 8:00 PM arrival `0,23,3,19`: unrestricted departure, 3:00 AM - 8:00 PM arrival Parameter should only be used when type parameter is set to: `1` (Round trip)", + "group": "advanced_filters" + }, + "emissions": { + "type": "select", + "options": [ + [ + 1, + "Less emissions only - 1" + ] + ], + "description": "Parameter defines the emission level of the flight. Available options: `1` - Less emissions only", + "group": "advanced_filters" + }, + "layover_duration": { + "description": "Parameter defines the layover duration, in minutes. It's a string containing two comma-separated numbers. For example, specify `90,330` for 1 hr 30 min - 5 hr 30 min.", + "group": "advanced_filters" + }, + "exclude_conns": { + "description": "Parameter defines the connecting airport codes to be excluded. An airport ID is an uppercase 3-letter code. You can search for it on Google Flights or IATA. For example, `CDG` is Paris Charles de Gaulle Airport and `AUS` is Austin-Bergstrom International Airport. You can also combine multiple Airports by joining them with a comma (`value` + `,` + `value`; eg: `CDG,AUS`).", + "group": "advanced_filters" + }, + "max_duration": { + "type": "number", + "description": "Parameter defines the maximum flight duration, in minutes. For example, specify `1500` for 25 hours.", + "group": "advanced_filters" + }, + "departure_token": { + "description": "Parameter is used to select the flight and get returning flights (for Round trip) or flights for the next leg of itinerary (for Multi-city). Find this token in the departure flight results. It cannot be used together with booking_token.", + "group": "next_flights" + }, + "booking_token": { + "description": "Parameter is used to get booking options for the selected flights. Find this token in the flight results. It cannot be used together with departure_token. When using this token, parameters related to date and parameters inside \"Advanced Filters\" section won't affect the result.", + "group": "booking_flights" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_flights` to use the Google Flights API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Flights results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_flights_autocomplete.json b/engines/google_flights_autocomplete.json new file mode 100644 index 0000000..0ce07e1 --- /dev/null +++ b/engines/google_flights_autocomplete.json @@ -0,0 +1,463 @@ +{ + "engine": "google_flights_autocomplete", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. A query that would be used to provide completion options.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Flights Autocomplete search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Flights Autocomplete search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "exclude_regions": { + "type": "checkbox", + "description": "Set to `true` to exclude region-level locations from suggestions. Regions include countries, sub-national regions, and multi-country areas (e.g. South Korea, South East England, South East Asia). Default to `false`.", + "group": "advanced_google_flights_autocomplete_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_flights_autocomplete` to use the Google Flights Autocomplete API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Flights Autocomplete results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_forums.json b/engines/google_forums.json new file mode 100644 index 0000000..9939fca --- /dev/null +++ b/engines/google_forums.json @@ -0,0 +1,492 @@ +{ + "engine": "google_forums", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. To search for events in a specific location, just include the location inside your search query (e.g. `Events in Austin, TX`).", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Forums search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Forums search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "nfpr": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude these results, or `0` to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_forums` to use the Google Forums API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Forums results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_hotels.json b/engines/google_hotels.json new file mode 100644 index 0000000..e6d1b1c --- /dev/null +++ b/engines/google_hotels.json @@ -0,0 +1,662 @@ +{ + "engine": "google_hotels", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Google Hotels search.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Hotels search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Hotels search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "currency": { + "type": "select", + "options": [ + "ALL", + "DZD", + "ARS", + "AMD", + "AWG", + "AUD", + "AZN", + "BSD", + "BHD", + "BYN", + "BMD", + "BAM", + "BRL", + "GBP", + "BGN", + "XPF", + "CAD", + "CLP", + "CNY", + "COP", + "CRC", + "CUP", + "CZK", + "DKK", + "DOP", + "EGP", + "EUR", + "GEL", + "HKD", + "HUF", + "ISK", + "INR", + "IDR", + "IRR", + "ILS", + "JMD", + "JPY", + "JOD", + "KZT", + "KWD", + "LBP", + "MKD", + "MYR", + "MXN", + "MDL", + "MAD", + "TWD", + "NZD", + "NOK", + "OMR", + "PKR", + "PAB", + "PEN", + "PHP", + "PLN", + "QAR", + "RON", + "RUB", + "SAR", + "RSD", + "SGD", + "ZAR", + "KRW", + "SEK", + "CHF", + "THB", + "TRY", + "USD", + "UAH", + "AED", + "VND" + ], + "description": "Parameter defines the currency of the returned prices. Default to `USD`. Head to the Google Travel Currencies page for a full list of supported currency codes.", + "group": "localization" + }, + "check_in_date": { + "required": true, + "description": "Parameter defines the check-in date. The format is YYYY-MM-DD. e.g. `2026-01-04`", + "group": "advanced_parameters" + }, + "check_out_date": { + "required": true, + "description": "Parameter defines the check-out date. The format is YYYY-MM-DD. e.g. `2026-01-05`", + "group": "advanced_parameters" + }, + "adults": { + "type": "number", + "description": "Parameter defines the number of adults. Default to `2`.", + "group": "advanced_parameters" + }, + "children": { + "type": "number", + "description": "Parameter defines the number of children. Default to `0`.", + "group": "advanced_parameters" + }, + "children_ages": { + "description": "Parameter defines the ages of children. The age range is from `1` to `17`, with children who haven't reached 1 year old being considered as `1`. Example for single child only: `5` Example for multiple children (separated by comma `,`): `5,8,10` The number of children's ages specified must match the children.", + "group": "advanced_parameters" + }, + "sort_by": { + "type": "select", + "options": [ + [ + "3", + "Lowest price - 3" + ], + [ + "8", + "Highest rating - 8" + ], + [ + "13", + "Most reviewed - 13" + ] + ], + "description": "Parameter is used for sorting the results. Default is sort by `Relevance`. Available options: `3` - Lowest price `8` - Highest rating `13` - Most reviewed", + "group": "advanced_filters" + }, + "min_price": { + "type": "number", + "description": "Parameter defines the lower bound of price range.", + "group": "advanced_filters" + }, + "max_price": { + "type": "number", + "description": "Parameter defines the upper bound of price range.", + "group": "advanced_filters" + }, + "property_types": { + "description": "Parameter defines to include only certain type of property in the results. Head to the Google Hotels Property Types page for a full list of supported Hotels property types. For Vacation Rentals, please refer to the Google Vacation Rentals Property Types page for a full list of supported Vacation Rentals property types. Example for single property type only: `17` Example for multiple property types (separated by comma `,`): `17,12,18`", + "group": "advanced_filters" + }, + "amenities": { + "description": "Parameter defines to include only results that offer specified amenities. Head to the Google Hotels Amenities page for a full list of supported Hotels amenities. For Vacation Rentals, please refer to the Google Vacation Rentals Amenities page for a full list of supported Vacation Rentals amenities. Example for single amenity only: `35` Example for multiple amenities (separated by comma `,`): `35,9,19`", + "group": "advanced_filters" + }, + "rating": { + "type": "select", + "options": [ + [ + "7", + "3.5+ - 7" + ], + [ + "8", + "4.0+ - 8" + ], + [ + "9", + "4.5+ - 9" + ] + ], + "description": "Parameter is used for filtering the results to certain rating. Available options: `7` - 3.5+ `8` - 4.0+ `9` - 4.5+", + "group": "advanced_filters" + }, + "brands": { + "description": "Parameter defines the brands where you want your search to be concentrated. ID values are accessible inside `brands` array, located in our JSON output (e.g. `brands[0].id`). Example for single brand only: `33` Example for multiple brands (separated by comma `,`): `33,67,101` This parameter isn't available for Vacation Rentals.", + "group": "hotels_filters" + }, + "hotel_class": { + "description": "Parameter defines to include only certain hotel class in the results. Available options: `2` - 2-star `3` - 3-star `4` - 4-star `5` - 5-star Example for single hotel class only: `2` Example for multiple hotel class (separated by comma `,`): `2,3,4` This parameter isn't available for Vacation Rentals.", + "group": "hotels_filters" + }, + "free_cancellation": { + "type": "checkbox", + "description": "Parameter defines to show results that offer free cancellation. This parameter isn't available for Vacation Rentals.", + "group": "hotels_filters" + }, + "special_offers": { + "type": "checkbox", + "description": "Parameter defines to show results that have special offers. This parameter isn't available for Vacation Rentals.", + "group": "hotels_filters" + }, + "eco_certified": { + "type": "checkbox", + "description": "Parameter defines to show results that are eco certified. This parameter isn't available for Vacation Rentals.", + "group": "hotels_filters" + }, + "vacation_rentals": { + "type": "checkbox", + "description": "Parameter defines to search for Vacation Rentals results. Default search is for Hotels.", + "group": "vacation_rentals_filters" + }, + "bedrooms": { + "type": "number", + "description": "Parameter defines the minimum number of bedrooms. Default to `0`. This parameter only available for Vacation Rentals.", + "group": "vacation_rentals_filters" + }, + "bathrooms": { + "type": "number", + "description": "Parameter defines the minimum number of bathrooms. Default to `0`. This parameter only available for Vacation Rentals.", + "group": "vacation_rentals_filters" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results.", + "group": "pagination" + }, + "property_token": { + "description": "Parameter is used to get property details which consists of name, address, phone, prices, nearby places, and etc. You can find property_token from Google Hotels Properties API.", + "group": "property_details" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_hotels` to use the Google Hotels API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Hotels results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_hotels_autocomplete.json b/engines/google_hotels_autocomplete.json new file mode 100644 index 0000000..a3f9959 --- /dev/null +++ b/engines/google_hotels_autocomplete.json @@ -0,0 +1,536 @@ +{ + "engine": "google_hotels_autocomplete", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. A query that would be used to provide completion options.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Hotels Autocomplete search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Hotels Autocomplete search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "currency": { + "type": "select", + "options": [ + "ALL", + "DZD", + "ARS", + "AMD", + "AWG", + "AUD", + "AZN", + "BSD", + "BHD", + "BYN", + "BMD", + "BAM", + "BRL", + "GBP", + "BGN", + "XPF", + "CAD", + "CLP", + "CNY", + "COP", + "CRC", + "CUP", + "CZK", + "DKK", + "DOP", + "EGP", + "EUR", + "GEL", + "HKD", + "HUF", + "ISK", + "INR", + "IDR", + "IRR", + "ILS", + "JMD", + "JPY", + "JOD", + "KZT", + "KWD", + "LBP", + "MKD", + "MYR", + "MXN", + "MDL", + "MAD", + "TWD", + "NZD", + "NOK", + "OMR", + "PKR", + "PAB", + "PEN", + "PHP", + "PLN", + "QAR", + "RON", + "RUB", + "SAR", + "RSD", + "SGD", + "ZAR", + "KRW", + "SEK", + "CHF", + "THB", + "TRY", + "USD", + "UAH", + "AED", + "VND" + ], + "description": "Parameter defines the currency used in `serpapi_google_hotels_link`. Default value is `USD`. Head to the Google Travel Currencies page for a full list of supported currency codes.", + "group": "localization" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_hotels_autocomplete` to use the Google Hotels Autocomplete API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Hotels Autocomplete results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_images.json b/engines/google_images.json new file mode 100644 index 0000000..644f1a1 --- /dev/null +++ b/engines/google_images.json @@ -0,0 +1,857 @@ +{ + "engine": "google_images", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Images search. e.g. `inurl:`, `site:`, `intitle:`.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Images search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Images search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French) Head to the Google languages for a full list of supported Google languages.", + "group": "localization" + }, + "cr": { + "description": "Parameter defines one or multiple countries to limit the search to. It uses `country{two-letter upper-case country code}` to specify countries and `|` as a delimiter. (e.g., `countryFR|countryDE` will only search French and German pages). Head to the Google cr countries page for a full list of supported countries.", + "group": "localization" + }, + "as_dt": { + "description": "Parameter controls whether to include or exclude results from the site named in the as_sitesearch parameter.", + "group": "advanced_search_query_parameters" + }, + "as_epq": { + "description": "Parameter identifies a phrase that all documents in the search results must contain. You can also use the phrase search query term to search for a phrase.", + "group": "advanced_search_query_parameters" + }, + "as_eq": { + "description": "Parameter identifies a word or phrase that should not appear in any documents in the search results. You can also use the exclude query term to ensure that a particular word or phrase will not appear in the documents in a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_lq": { + "description": "Parameter specifies that all search results should contain a link to a particular URL. You can also use the link: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_nlo": { + "description": "Parameter specifies the starting value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_nhi": { + "description": "Parameter specifies the ending value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_oq": { + "description": "Parameter provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_q": { + "description": "Parameter provides search terms to check for in a document. This parameter is also commonly used to allow users to specify additional terms to search for within a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_qdr": { + "description": "Parameter requests search results from a specified time period (quick date range). The following values are supported: `d[number]`: requests results from the specified number of past days. Example for the past 10 days: `as_qdr=d10` `w[number]`: requests results from the specified number of past weeks. `m[number]`: requests results from the specified number of past months. `y[number]`: requests results from the specified number of past years. Example for the past year: `as_qdr=y`", + "group": "advanced_search_query_parameters" + }, + "as_rq": { + "description": "Parameter specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. You can also use the related: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_sitesearch": { + "description": "Parameter allows you to specify that all search results should be pages from a given site. By setting the as_dt parameter, you can also use it to exclude pages from a given site from your search results.", + "group": "advanced_search_query_parameters" + }, + "period_unit": { + "type": "select", + "options": [ + "s", + "n", + "h", + "d", + "w", + "m", + "y" + ], + "description": "Parameter defines the time period unit to search for the recent images, e.g. from past minute, hour, day etc. Options: `s` - Second `n` - Minute `h` - Hour `d` - Day `w` - Week `m` - Month `y` - Year This parameter can't be used with `start_date`/`end_date` parameters. This parameter overrides `qdr` component of `tbs` parameter.", + "group": "time_period" + }, + "period_value": { + "type": "number", + "description": "Parameter defines an optional time period value that can be used with `period_unit` to describe time periods like `15 seconds`, `42 hours`, `178 days` etc. Default value: `1` Value range: `1..2147483647`", + "group": "time_period" + }, + "start_date": { + "description": "Parameter defines the start date of time period you want to limit the image search to. Format: `YYYYMMDD` Example: `20241201` This parameter can't be used with `period_unit`/`period_value` parameters. `start_date` with blank `end_date` produces date range `FROM start_date TO today`. This parameter overrides `cdr` and `cd_min` components of `tbs` parameter.", + "group": "time_period" + }, + "end_date": { + "description": "Parameter defines the end date of time period you want to limit the image search to. Format: `YYYYMMDD` Example: `20241231` This parameter can't be used with `period_unit`/`period_value` parameters. `end_date` with blank `start_date` produces date range `BEFORE end_date`. This parameter overrides `cdr` and `cd_max` components of `tbs` parameter.", + "group": "time_period" + }, + "chips": { + "description": "Parameter enables to filter image search. It's a string provided by Google as suggested search, like: red apple. Chips are provided under the section: `suggested_searches` when `ijn = 0`. Both `chips` and `serpapi_link` values are provided for each suggested search.", + "group": "advanced_filters" + }, + "tbs": { + "description": "(to be searched) parameter defines advanced search parameters that aren't possible in the regular query field.", + "group": "advanced_filters" + }, + "imgar": { + "type": "select", + "options": [ + "s", + "t", + "w", + "xw" + ], + "description": "Parameter defines the set aspect ratio of images. Options: `s` - Square `t` - Tall `w` - Wide `xw` - Panoramic", + "group": "advanced_filters" + }, + "imgsz": { + "type": "select", + "options": [ + "l", + "m", + "i", + "qsvga", + "vga", + "svga", + "xga", + "2mp", + "4mp", + "6mp", + "8mp", + "10mp", + "12mp", + "15mp", + "20mp", + "40mp", + "70mp" + ], + "description": "Parameter defines the size of images. Options: `l` - Large `m` - Medium `i` - Icon `qsvga` - Larger than 400\u00d7300 `vga` - Larger than 640\u00d7480 `svga` - Larger than 800\u00d7600 `xga` - Larger than 1024\u00d7768 `2mp` - Larger than 2 MP `4mp` - Larger than 4 MP `6mp` - Larger than 6 MP `8mp` - Larger than 8 MP `10mp` - Larger than 10 MP `12mp` - Larger than 12 MP `15mp` - Larger than 15 MP `20mp` - Larger than 20 MP `40mp` - Larger than 40 MP `70mp` - Larger than 70 MP", + "group": "advanced_filters" + }, + "image_color": { + "type": "select", + "options": [ + "bw", + "trans", + "red", + "orange", + "yellow", + "green", + "teal", + "blue", + "purple", + "pink", + "white", + "gray", + "black", + "brown" + ], + "description": "Parameter defines the color of images. Options: `bw` - Black and white `trans` - Transparent `red` - Red `orange` - Orange `yellow` - Yellow `green` - Green `teal` - Teal `blue` - Blue `purple` - Purple `pink` - Pink `white` - White `gray` - Gray `black` - Black `brown` - Brown This parameter overrides `ic` and `isc` components of `tbs` parameter", + "group": "advanced_filters" + }, + "image_type": { + "type": "select", + "options": [ + "face", + "photo", + "clipart", + "lineart", + "animated" + ], + "description": "Parameter defines the type of images. Options: `face` - Face `photo` - Photo `clipart` - Clip art `lineart` - Line drawing `animated` - Animated This parameter overrides `itp` component of `tbs` parameter", + "group": "advanced_filters" + }, + "licenses": { + "type": "select", + "options": [ + "f", + "fc", + "fm", + "fmc", + "cl", + "ol" + ], + "description": "Parameter defines the scope of licenses of images. Options: `f` - Free to use or share `fc` - Free to use or share, even commercially `fm` - Free to use, share or modify `fmc` - Free to use, share or modify, even commercially `cl` - Creative Commons licenses `ol` - Commercial and other licenses This parameter overrides `sur` component of `tbs` parameter", + "group": "advanced_filters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "nfpr": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude these results, or `0` to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + }, + "ijn": { + "type": "number", + "description": "Parameter defines the page number. Min. value:`0` Max. value:`99`", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_images` to use the Google Images API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Images results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_images_light.json b/engines/google_images_light.json new file mode 100644 index 0000000..a3b121f --- /dev/null +++ b/engines/google_images_light.json @@ -0,0 +1,853 @@ +{ + "engine": "google_images_light", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Images Light search. e.g. `inurl:`, `site:`, `intitle:`.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Images Light search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Images Light search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French) Head to the Google languages for a full list of supported Google languages.", + "group": "localization" + }, + "cr": { + "description": "Parameter defines one or multiple countries to limit the search to. It uses `country{two-letter upper-case country code}` to specify countries and `|` as a delimiter. (e.g., `countryFR|countryDE` will only search French and German pages). Head to the Google cr countries page for a full list of supported countries.", + "group": "localization" + }, + "as_dt": { + "description": "Parameter controls whether to include or exclude results from the site named in the as_sitesearch parameter.", + "group": "advanced_search_query_parameters" + }, + "as_epq": { + "description": "Parameter identifies a phrase that all documents in the search results must contain. You can also use the phrase search query term to search for a phrase.", + "group": "advanced_search_query_parameters" + }, + "as_eq": { + "description": "Parameter identifies a word or phrase that should not appear in any documents in the search results. You can also use the exclude query term to ensure that a particular word or phrase will not appear in the documents in a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_lq": { + "description": "Parameter specifies that all search results should contain a link to a particular URL. You can also use the link: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_nlo": { + "description": "Parameter specifies the starting value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_nhi": { + "description": "Parameter specifies the ending value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_oq": { + "description": "Parameter provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_q": { + "description": "Parameter provides search terms to check for in a document. This parameter is also commonly used to allow users to specify additional terms to search for within a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_qdr": { + "description": "Parameter requests search results from a specified time period (quick date range). The following values are supported: `d[number]`: requests results from the specified number of past days. Example for the past 10 days: `as_qdr=d10` `w[number]`: requests results from the specified number of past weeks. `m[number]`: requests results from the specified number of past months. `y[number]`: requests results from the specified number of past years. Example for the past year: `as_qdr=y`", + "group": "advanced_search_query_parameters" + }, + "as_rq": { + "description": "Parameter specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. You can also use the related: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_sitesearch": { + "description": "Parameter allows you to specify that all search results should be pages from a given site. By setting the as_dt parameter, you can also use it to exclude pages from a given site from your search results.", + "group": "advanced_search_query_parameters" + }, + "period_unit": { + "type": "select", + "options": [ + "s", + "n", + "h", + "d", + "w", + "m", + "y" + ], + "description": "Parameter defines the time period unit to search for the recent images, e.g. from past minute, hour, day etc. Options: `s` - Second `n` - Minute `h` - Hour `d` - Day `w` - Week `m` - Month `y` - Year This parameter can't be used with `start_date`/`end_date` parameters. This parameter overrides `qdr` component of `tbs` parameter.", + "group": "time_period" + }, + "period_value": { + "type": "number", + "description": "Parameter defines an optional time period value that can be used with `period_unit` to describe time periods like `15 seconds`, `42 hours`, `178 days` etc. Default value: `1` Value range: `1..2147483647`", + "group": "time_period" + }, + "start_date": { + "description": "Parameter defines the start date of time period you want to limit the image search to. Format: `YYYYMMDD` Example: `20241201` This parameter can't be used with `period_unit`/`period_value` parameters. `start_date` with blank `end_date` produces date range `FROM start_date TO today`. This parameter overrides `cdr` and `cd_min` components of `tbs` parameter.", + "group": "time_period" + }, + "end_date": { + "description": "Parameter defines the end date of time period you want to limit the image search to. Format: `YYYYMMDD` Example: `20241231` This parameter can't be used with `period_unit`/`period_value` parameters. `end_date` with blank `start_date` produces date range `BEFORE end_date`. This parameter overrides `cdr` and `cd_max` components of `tbs` parameter.", + "group": "time_period" + }, + "tbs": { + "description": "(to be searched) parameter defines advanced search parameters that aren't possible in the regular query field.", + "group": "advanced_filters" + }, + "imgar": { + "type": "select", + "options": [ + "s", + "t", + "w", + "xw" + ], + "description": "Parameter defines the set aspect ratio of images. Options: `s` - Square `t` - Tall `w` - Wide `xw` - Panoramic", + "group": "advanced_filters" + }, + "imgsz": { + "type": "select", + "options": [ + "l", + "m", + "i", + "qsvga", + "vga", + "svga", + "xga", + "2mp", + "4mp", + "6mp", + "8mp", + "10mp", + "12mp", + "15mp", + "20mp", + "40mp", + "70mp" + ], + "description": "Parameter defines the size of images. Options: `l` - Large `m` - Medium `i` - Icon `qsvga` - Larger than 400\u00d7300 `vga` - Larger than 640\u00d7480 `svga` - Larger than 800\u00d7600 `xga` - Larger than 1024\u00d7768 `2mp` - Larger than 2 MP `4mp` - Larger than 4 MP `6mp` - Larger than 6 MP `8mp` - Larger than 8 MP `10mp` - Larger than 10 MP `12mp` - Larger than 12 MP `15mp` - Larger than 15 MP `20mp` - Larger than 20 MP `40mp` - Larger than 40 MP `70mp` - Larger than 70 MP", + "group": "advanced_filters" + }, + "image_color": { + "type": "select", + "options": [ + "bw", + "trans", + "red", + "orange", + "yellow", + "green", + "teal", + "blue", + "purple", + "pink", + "white", + "gray", + "black", + "brown" + ], + "description": "Parameter defines the color of images. Options: `bw` - Black and white `trans` - Transparent `red` - Red `orange` - Orange `yellow` - Yellow `green` - Green `teal` - Teal `blue` - Blue `purple` - Purple `pink` - Pink `white` - White `gray` - Gray `black` - Black `brown` - Brown This parameter overrides `ic` and `isc` components of `tbs` parameter", + "group": "advanced_filters" + }, + "image_type": { + "type": "select", + "options": [ + "face", + "photo", + "clipart", + "lineart", + "animated" + ], + "description": "Parameter defines the type of images. Options: `face` - Face `photo` - Photo `clipart` - Clip art `lineart` - Line drawing `animated` - Animated This parameter overrides `itp` component of `tbs` parameter", + "group": "advanced_filters" + }, + "licenses": { + "type": "select", + "options": [ + "f", + "fc", + "fm", + "fmc", + "cl", + "ol" + ], + "description": "Parameter defines the scope of licenses of images. Options: `f` - Free to use or share `fc` - Free to use or share, even commercially `fm` - Free to use, share or modify `fmc` - Free to use, share or modify, even commercially `cl` - Creative Commons licenses `ol` - Commercial and other licenses This parameter overrides `sur` component of `tbs` parameter", + "group": "advanced_filters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "nfpr": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude these results, or `0` to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. Min. value:`0` Max. value:`999`", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_images_light` to use the Google Images Light API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Images Light results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_images_related_content.json b/engines/google_images_related_content.json new file mode 100644 index 0000000..788ee90 --- /dev/null +++ b/engines/google_images_related_content.json @@ -0,0 +1,462 @@ +{ + "engine": "google_images_related_content", + "params": { + "related_content_id": { + "required": true, + "description": "Parameter defines the unique ID for retrieving the Related Content of an image. You can acquire the ID by using our Google Images API.", + "group": "search_query" + }, + "q": { + "description": "Parameter defines the search query. To get the most precise results it is recommended to use the same query you used in the original Google Images search.", + "group": "advanced_filters" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Images search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French) Head to the Google languages for a full list of supported Google languages.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Images search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_images_related_content` to use the Google Images Related Content API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Images Related Content results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_immersive_product.json b/engines/google_immersive_product.json new file mode 100644 index 0000000..aaf7696 --- /dev/null +++ b/engines/google_immersive_product.json @@ -0,0 +1,53 @@ +{ + "engine": "google_immersive_product", + "params": { + "page_token": { + "required": true, + "description": "Parameter defines the token needed to show more product info in Google immersive popup.", + "group": "search_query" + }, + "more_stores": { + "required": false, + "type": "checkbox", + "description": "Parameter for fetching more stores results in single search. It can be set to `1` or `true`. By default, a search returns `3 to 5` stores. When the more_stores parameter is enabled, up to `13` stores will be returned, or the maximum available, depending on the product.", + "group": "advanced_parameters" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page of results for stores. The token is returned as `stores_next_page_token` from the search results.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_immersive_product` to use the Google Immersive Product API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Immersive Product results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_jobs.json b/engines/google_jobs.json new file mode 100644 index 0000000..bb4bb73 --- /dev/null +++ b/engines/google_jobs.json @@ -0,0 +1,681 @@ +{ + "engine": "google_jobs", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Jobs search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page of results. Up to `10` results are returned per page. The next page token can be found in the SerpApi JSON response: `serpapi_pagination -> next_page_token` Usage of start parameter (results offset) has been discontinued by Google.", + "group": "pagination" + }, + "chips": { + "description": "Parameter defines additional query conditions. Top of a job search page contains elements called chips, its values are extracted in order to be passed to chips parameter. E.g. `city:Owg_06VPwoli_nfhBo8LyA==` will return results for New York. This parameter has been deprecated by Google.", + "group": "advanced_google_jobs_parameters" + }, + "lrad": { + "type": "number", + "description": "Defines search radius in kilometers. Does not strictly limit the radius.", + "group": "advanced_google_jobs_parameters" + }, + "ltype": { + "type": "checkbox", + "description": "Parameter will filter the results by work from home. This parameter has been deprecated by Google.", + "group": "advanced_google_jobs_parameters" + }, + "uds": { + "description": "Parameter enables to filter search. It's a string provided by Google as a filter. `uds` values are provided under the section: `filters` with `uds`, `q` and `serpapi_link` values provided for each filter.", + "group": "advanced_google_jobs_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_jobs` to use the Google Jobs API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Jobs results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_jobs_listing.json b/engines/google_jobs_listing.json new file mode 100644 index 0000000..f1e3173 --- /dev/null +++ b/engines/google_jobs_listing.json @@ -0,0 +1,43 @@ +{ + "engine": "google_jobs_listing", + "params": { + "q": { + "required": true, + "description": "Parameter defines the `job_id` string which can be obtained from Google Jobs API.", + "group": "search_query" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_jobs_listing` to use the Google Jobs Listing API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Jobs Listing results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_lens.json b/engines/google_lens.json new file mode 100644 index 0000000..9288d6f --- /dev/null +++ b/engines/google_lens.json @@ -0,0 +1,396 @@ +{ + "engine": "google_lens", + "params": { + "url": { + "required": true, + "description": "Parameter defines the URL of an image to perform the Google Lens search.", + "group": "search_query" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Lens search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "country": { + "type": "select", + "options": [ + "ae", + "af", + "ag", + "ai", + "al", + "am", + "ao", + "ar", + "at", + "au", + "aw", + "az", + "ba", + "bb", + "bd", + "be", + "bg", + "bh", + "bj", + "bn", + "bo", + "br", + "bs", + "bw", + "by", + "bz", + "ca", + "cg", + "ch", + "ci", + "cl", + "cm", + "cn", + "co", + "cr", + "cv", + "cy", + "cz", + "de", + "dk", + "do", + "dz", + "ec", + "ee", + "eg", + "es", + "et", + "fi", + "fr", + "gb", + "ge", + "gh", + "gp", + "gr", + "gt", + "gy", + "hk", + "hn", + "hr", + "ht", + "hu", + "id", + "ie", + "il", + "in", + "iq", + "ir", + "is", + "it", + "jm", + "jo", + "jp", + "ke", + "kg", + "kh", + "kr", + "kw", + "ky", + "kz", + "la", + "lb", + "lc", + "lk", + "lt", + "lu", + "lv", + "ly", + "ma", + "md", + "me", + "mg", + "mk", + "ml", + "mm", + "mn", + "mo", + "mq", + "mt", + "mu", + "mv", + "mx", + "my", + "mz", + "na", + "nc", + "ng", + "ni", + "nl", + "no", + "np", + "nz", + "om", + "pa", + "pe", + "ph", + "pk", + "pl", + "pr", + "ps", + "pt", + "py", + "qa", + "re", + "ro", + "rs", + "ru", + "sa", + "sc", + "sd", + "se", + "sg", + "si", + "sk", + "sn", + "sr", + "sv", + "sy", + "th", + "tn", + "tr", + "tt", + "tw", + "tz", + "ua", + "ug", + "us", + "uy", + "uz", + "vc", + "ve", + "vn", + "xk", + "ye", + "za", + "zm", + "zw" + ], + "description": "Parameter defines the specific country location to use for the Google Lens search. It's a two-letter country code. (e.g., `us` for United States, `fr` for France, or `de` for Germany). Head to the Google Lens countries page for a full list of supported Google Lens countries.", + "group": "localization" + }, + "type": { + "required": true, + "type": "select", + "options": [ + "all", + "about_this_image", + "products", + "exact_matches", + "visual_matches" + ], + "description": "Parameter defines the type of search to perform. By default, the search type is `all`. Available options: `all` - All `about_this_image` - About This Image `products` - Products `exact_matches` - Exact Matches `visual_matches` - Visual Matches.", + "group": "search_type" + }, + "q": { + "description": "Parameter defines the search query to use along in the Google Lens search. It is only applicable when type is set to `all`, `visual_matches`, or `products`.", + "group": "advanced_parameters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_lens` to use the Google Lens API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Lens results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_light.json b/engines/google_light.json new file mode 100644 index 0000000..2d1d93c --- /dev/null +++ b/engines/google_light.json @@ -0,0 +1,741 @@ +{ + "engine": "google_light", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google search. e.g. `inurl:`, `site:`, `intitle:`. We also support advanced search query parameters such as as_dt and as_eq. See the full list of supported advanced search query parameters.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "lr": { + "description": "Parameter defines one or multiple languages to limit the search to. It uses `lang_{two-letter language code}` to specify languages and `|` as a delimiter. (e.g., `lang_fr|lang_de` will only search French and German pages). Head to the Google lr languages page for a full list of supported languages.", + "group": "localization" + }, + "as_dt": { + "description": "Parameter controls whether to include or exclude results from the site named in the as_sitesearch parameter.", + "group": "advanced_search_query_parameters" + }, + "as_epq": { + "description": "Parameter identifies a phrase that all documents in the search results must contain. You can also use the phrase search query term to search for a phrase.", + "group": "advanced_search_query_parameters" + }, + "as_eq": { + "description": "Parameter identifies a word or phrase that should not appear in any documents in the search results. You can also use the exclude query term to ensure that a particular word or phrase will not appear in the documents in a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_lq": { + "description": "Parameter specifies that all search results should contain a link to a particular URL. You can also use the link: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_nlo": { + "description": "Parameter specifies the starting value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_nhi": { + "description": "Parameter specifies the ending value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_oq": { + "description": "Parameter provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_q": { + "description": "Parameter provides search terms to check for in a document. This parameter is also commonly used to allow users to specify additional terms to search for within a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_qdr": { + "description": "Parameter requests search results from a specified time period (quick date range). The following values are supported: `d[number]`: requests results from the specified number of past days. Example for the past 10 days: `as_qdr=d10` `w[number]`: requests results from the specified number of past weeks. `m[number]`: requests results from the specified number of past months. `y[number]`: requests results from the specified number of past years. Example for the past year: `as_qdr=y`", + "group": "advanced_search_query_parameters" + }, + "as_rq": { + "description": "Parameter specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. You can also use the related: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_sitesearch": { + "description": "Parameter allows you to specify that all search results should be pages from a given site. By setting the as_dt parameter, you can also use it to exclude pages from a given site from your search results.", + "group": "advanced_search_query_parameters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "nfpr": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude these results, or `0` to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_light` to use the Google Light API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Light results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_local.json b/engines/google_local.json new file mode 100644 index 0000000..712632a --- /dev/null +++ b/engines/google_local.json @@ -0,0 +1,682 @@ +{ + "engine": "google_local", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Local search.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Local search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Local search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French) Head to the Google languages for a full list of supported Google languages.", + "group": "localization" + }, + "ludocid": { + "description": "Parameter defines the Google CID (customer identifier) of a place. This parameter can be found in Google Local API and Google Search API local results under the name of place_id, as well as in Google Maps API local results under the name of data_cid. You can also acquire it using Google's CID converter. Example CID for \"New York, NY, USA\": `14414772292044717666`.", + "group": "advanced_google_local_parameters" + }, + "tbs": { + "description": "(to be searched) parameter defines advanced search parameters that aren't possible in the regular query field.", + "group": "advanced_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. On desktop, parameter only accepts multiples of `20` (e.g. `20` for the second page results, `40` for the third page results, etc.). On mobile, parameter only accepts multiples of `10` (e.g. `10` for the second page results, `20` for the third page results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_local` to use the Google Local API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Local results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_local_services.json b/engines/google_local_services.json new file mode 100644 index 0000000..be9495f --- /dev/null +++ b/engines/google_local_services.json @@ -0,0 +1,1571 @@ +{ + "engine": "google_local_services", + "params": { + "q": { + "type": "select", + "options": [ + "acupuncturist", + "allergist", + "animal_shelter", + "appliance_repair", + "architect", + "audiologist", + "auto_body_shop", + "auto_repair_shop", + "bankruptcy_lawyer", + "barber_shop", + "beauty_school", + "business_lawyer", + "car_wash_and_detailing", + "carpenter", + "carpet_cleaning", + "cellphone_and_laptop_repair", + "child_care", + "chiropractor", + "contract_lawyer", + "countertop_pro", + "criminal_lawyer", + "dui_lawyer", + "dance_instructor", + "dentist", + "dermatologist", + "dietitian", + "disability_lawyer", + "drain_expert", + "driving_instructor", + "electrician", + "estate_lawyer", + "family_lawyer", + "fencing_pro", + "financial_planner", + "first_aid_trainer", + "flooring_pro", + "foundation_pro", + "funeral_home", + "garage_door_pro", + "general_contractor", + "hvac", + "hair_removal", + "hair_salon", + "handyman", + "home_inspector", + "home_insulation", + "home_security", + "home_theater", + "cleaning_service", + "immigration_lawyer", + "insurance_agency", + "ip_lawyer", + "interior_designer", + "junk_removal", + "labor_lawyer", + "landscaper", + "language_instructor", + "lawn_care", + "litigation_lawyer", + "locksmith", + "malpractice_lawyer", + "massage_school", + "massage_therapist", + "mover", + "nail_salon", + "occupational_therapist", + "ophthalmologist", + "optometrist", + "orthodontist", + "orthopedic_surgeon", + "painter", + "personal_injury_lawyer", + "personal_trainer", + "pest_control", + "pet_adoption", + "pet_boarding", + "pet_grooming", + "pet_trainer", + "physiotherapist", + "piercing_studio", + "plastic_surgeon", + "plumber", + "podiatrist", + "pool_cleaner", + "pool_contractor", + "preschool", + "primary_care", + "real_estate_agent", + "real_estate_lawyer", + "roofer", + "sewage_pro", + "siding_pro", + "snow_removal", + "solar_energy_contractor", + "storage", + "tattoo_studio", + "tax_lawyer", + "tax_specialist", + "tire_shop", + "towing", + "traffic_lawyer", + "tree_service", + "tutor", + "veterinarian", + "water_damage", + "weight_loss_service", + "window_cleaner", + "window_repair", + "yoga_instructor" + ], + "required": true, + "description": "Parameter defines the service you want to search for. Head to the Google local services queries page for a full list of supported Google local services queries.", + "group": "search_query" + }, + "data_cid": { + "required": true, + "type": "number", + "description": "Parameter defines the Google CID (customer identifier) of a place. This parameter can be found in Google Maps API local results, as well as in Google Search API and Google Local API local results under the name of place_id. You can also acquire it using Google's CID converter. Example CID for \"New York, NY, USA\": `14414772292044717666` Using data_cid for specific business locations or streets may produce inconsistent results due to limitations on Google's side; we recommend using the city or district level instead. Google Local Services API returns empty results for places outside of the USA. Parameter should not be confused with cid as they are different parameters.", + "group": "geographic_location" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Local Services search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "job_type": { + "type": "select", + "options": [ + "acupressure", + "acupuncture", + "cupping", + "gua_sha", + "heat_therapy", + "herbal_therapy", + "infrared_therapy", + "moxibustion", + "acupuncturist_other", + "qigong", + "shiatsu", + "tui_na", + "allergic_reaction_treatment", + "allergy_shots", + "allergy_testing", + "allergy_treatment", + "anaphylaxis_treatment", + "angioedema_treatment", + "asthma_treatment", + "chronic_sinusitis_treatment", + "drug_allergies_treatment", + "eosinophilic_esophagitis_treatment", + "eye_allergies_treatment", + "food_allergies_treatment", + "food_intolerance_treatment", + "immunotherapy", + "itchiness_treatment", + "allergist_other", + "pollen_allergy_treatment", + "seasonal_allergies_treatment", + "animal_shelter_cat_adoption", + "animal_shelter_dog_adoption", + "lost_stray_found_animals", + "animal_shelter_other", + "animal_shelter_other_animal_adoption", + "animal_shelter_other_veterinary_services", + "pet_license", + "pet_surrender", + "animal_shelter_spay_neuter", + "animal_shelter_vaccinations", + "appliance_other", + "repair_dishwasher", + "repair_dryer", + "repair_freezer", + "repair_microwave", + "repair_oven", + "repair_refrigerator", + "repair_refrigerator_freezer", + "repair_stove_cooktop", + "repair_stove_cooktop_oven", + "repair_washer", + "repair_washer_dryer", + "3d_architectural_rendering", + "adaptive_reuse_historical_renovation", + "architectural_designing", + "architectural_engineering", + "building_code_analysis_permit_coordination", + "consulting", + "feasibility_studies", + "planning_zoning_approval_assistance", + "project_managing_architect", + "site_master_planning", + "assistive_listening_device_evaluation", + "auditory_brainstem_response_testing", + "cochlear_implant_evaluation", + "cochlear_implant_mapping", + "dizziness_and_balance_evaluation", + "earwax_removal", + "hearing_aid_evaluation", + "hearing_aid_fitting", + "hearing_loss_treatment", + "hearing_test", + "audiologist_other", + "otoacoustic_emissions_test", + "tinnitus_treatment", + "tympanometry", + "bumper_repair", + "dents_and_scratches_repair", + "doors_repair", + "frame_repair", + "auto_body_shop_other", + "window_repair_and_replacement", + "brake_repair", + "car_maintenance", + "electrical_system_repair", + "engine_repair", + "exhaust_system_repair", + "auto_repair_shop_other", + "transmission_repair", + "agriculture_bankruptcy", + "bankruptcy_litigation", + "chapter_11_bankruptcy", + "chapter_13_bankruptcy", + "chapter_7_bankruptcy", + "corporate_bankruptcy", + "creditor_harassment", + "debt_settlement", + "foreclosure_bankruptcy_lawyer", + "personal_bankruptcy", + "repossession", + "wage_garnishment", + "beard_grooming", + "mustache_trim_and_lineup", + "mustache_and_beard_dyeing", + "mustache_and_beard_treatments", + "barber_shop_other", + "shaves", + "beauty_school_barbering", + "beauty_school_business_management", + "beauty_school_cosmetology", + "beauty_school_esthetics", + "beauty_school_hair_cutting", + "beauty_school_hair_design", + "beauty_school_makeup", + "beauty_school_massage_therapy", + "beauty_school_nail_technology", + "beauty_school_other", + "beauty_school_retail_training", + "banking_finance_law", + "business_licenses_permits", + "business_litigation", + "business_taxes", + "business_transactions_business_lawyer", + "commercial_bankruptcy", + "commercial_contracts_business_lawyer", + "employment_law_business_lawyer", + "incorporation_restructuring", + "insurance_law", + "intellectual_property_law", + "mergers_acquisitions_business_lawyer", + "partnership_agreements_business_lawyer", + "patents_copyrights_trademarks", + "securities_law", + "shareholder_disputes", + "engine_detailing", + "exterior_washing", + "interior_detailing", + "car_wash_and_detailing_other", + "tire_cleaning", + "waxing_and_ceramic_coating", + "cabinetry", + "decking", + "drywalling", + "fencing", + "general_installations", + "general_repairs_maintenance", + "remodeling", + "shelving_storage", + "clean_area_rugs", + "clean_carpet", + "clean_drapes_and_curtains", + "clean_upholstery", + "carpet_cleaning_other", + "remove_pet_stains_and_odors", + "data_recovery", + "hardware_repair", + "laptop_screen_replacement", + "cellphone_and_laptop_repair_other", + "phone_screen_repair", + "software_repair", + "after_school_care", + "all_hours_daycare", + "bilingual_daycare", + "drop_in_daycare", + "full_time_daycare", + "in_home_daycare", + "infant_programs", + "child_care_other", + "part_time_daycare", + "pre_kindergarten_programs", + "preschool_programs", + "school_age_programs", + "special_needs_daycare", + "summer_daycare", + "toddler_programs", + "weekend_daycare", + "back_sprain_treatment", + "chiropractic_adjustments_treatment", + "chronic_pain_treatment", + "kinesio_taping_treatment", + "muscle_stiffness_treatment", + "neck_sprain_treatment", + "chiropractor_other", + "sciatica_treatment", + "soft_tissue_therapy", + "spinal_traction_treatment", + "tens", + "ultrasound_therapy", + "whiplash_treatment", + "assignment_of_contract", + "business_transactions_contract_lawyer", + "commercial_contracts_contract_lawyer", + "contract_dispute", + "contract_negotiation", + "contract_review", + "employment_contracts_contract_lawyer", + "franchise_agreements", + "mergers_acquisitions_contract_lawyer", + "non_disclosure_agreements_contract_lawyer", + "contract_lawyer_other", + "partnership_agreements_contract_lawyer", + "power_of_attorney_contract_lawyer", + "security_agreements", + "warranties", + "bathroom_countertops", + "bathroom_wall_panels", + "countertop_design", + "countertop_installation", + "fireplace_facade", + "granite_countertops", + "kitchen_countertops", + "kitchen_wall_panels", + "laminate_countertops", + "marble_countertops", + "quartz_countertops", + "remodeling_countertop_pro", + "repair_maintenance_countertop_pro", + "stone_slab_countertops", + "tile_countertops", + "countertop_pro_other", + "corporate_representation", + "criminal_immigration_defense", + "duis_reckless_driving", + "domestic_violence", + "drug_possession", + "expungement", + "federal_crimes", + "felonies", + "criminal_lawyer_other", + "petty_crimes_misdemeanors", + "restraining_orders", + "sex_offenses", + "three_strikes_law", + "dui_with_accident", + "dui_injuries_dui_lawyer", + "dui_dwi_dui_lawyer", + "felony_dui", + "invalid_tests", + "multiple_offenses", + "dui_lawyer_other", + "reckless_driving_dui_lawyer", + "underage_dui", + "dance_instructor_african", + "dance_instructor_ballet", + "dance_instructor_ballroom", + "dance_instructor_belly", + "dance_instructor_bollywood", + "dance_instructor_contemporary", + "dance_instructor_folk_traditional", + "dance_instructor_hip_hop", + "dance_instructor_jazz", + "dance_instructor_kids_classes", + "dance_instructor_latin", + "dance_instructor_modern", + "dance_instructor_other", + "dance_instructor_tap", + "dance_instructor_wedding", + "bad_breath", + "cavities", + "chipped_tooth", + "cracked_tooth", + "crowns", + "dental_checkup", + "dental_implants", + "dentures", + "dry_mouth", + "fillings", + "gum_bleeding", + "gum_disease", + "missing_teeth_evaluation", + "mouth_sores", + "dentist_other", + "root_canal", + "sealants", + "teeth_cleaning", + "teeth_whitening", + "tooth_decay", + "tooth_infection", + "tooth_pain", + "tooth_sensitivity", + "tooth_extraction", + "acne_treatment", + "dry_skin_treatment", + "eczema_treatment", + "fillers", + "hair_loss_treatment", + "hives_treatment", + "hyperpigmentation_treatment", + "laser_treatment", + "melanoma_treatment", + "nail_fungus_treatment", + "dermatologist_other", + "psoriasis_treatment", + "ringworm_treatment", + "rosacea_treatment", + "scar_treatment", + "skin_cancer_exam", + "skin_infection_treatment", + "skin_rash_treatment", + "dermatologist_wart_removal", + "bariatric_nutrition", + "body_composition_analysis", + "cancer_nutrition", + "celiac_disease_nutrition", + "crohns_disease_nutrition", + "diabetes_nutrition", + "diabetes_self_management", + "eating_disorders_nutrition_counseling", + "failure_to_thrive_nutrition_counseling", + "nutrition_counseling", + "dietitian_other", + "prenatal_nutrition", + "sports_nutrition", + "ulcerative_colitis_nutrition", + "weight_loss_nutrition_counseling", + "weight_management_counseling", + "disability_hearings", + "long_term_disability", + "disability_lawyer_other", + "ssa_claim_reconsideration", + "ssa_disability_appeals", + "ssa_disability_applications", + "ssa_disability_benefits", + "ssa_family_benefits", + "ssa_impairment_listings", + "short_term_disability", + "social_security_disability_insurance", + "supplemental_security_income", + "veterans_disability_benefits", + "workers_compensation_disability_lawyer", + "channel_drains", + "dry_wells", + "french_drains", + "drain_expert_other", + "yard_drains_catch_basins", + "behind_the_wheel_lessons", + "commercial_license_training", + "defensive_driving_lessons", + "drivers_education_classes", + "manual_transmission_lessons", + "motorcycle_lessons", + "driving_instructor_other", + "traffic_school", + "electric_car_charger", + "install_fan", + "install_ground_wire", + "install_light_fixtures", + "install_outdoor_lighting", + "install_outlets_switches", + "install_security_system", + "electrician_other", + "relocate_outlets_switches", + "electrician_remodeling", + "repair_fan", + "repair_light_fixtures", + "repair_outlets_switches", + "repair_panel", + "replace_upgrade_panel", + "restore_power", + "charitable_giving", + "contests_litigation", + "deeds", + "estate_planning_lawyer", + "guardianship_estate_lawyer", + "medical_power_of_attorney", + "estate_lawyer_other", + "power_of_attorney_estate_lawyer", + "probate_estate_lawyer", + "trusts", + "wills", + "adoption", + "child_support", + "contested_divorce", + "debt_division", + "guardianship_family_lawyer", + "mediation_family_lawyer", + "modifications_of_orders", + "family_lawyer_other", + "parent_timesharing", + "paternity", + "prenuptial_postnuptial_agreements", + "probate_family_lawyer", + "property_divisions", + "protective_orders_domestic_violence_issues", + "spousal_support_alimony", + "uncontested_divorce", + "custom_construction", + "fence_design", + "installation_fencing_pro", + "fencing_other", + "repairs_maintenance_fencing_pro", + "education_savings", + "estate_financial_planning", + "financial_planning", + "home_purchase", + "insurance", + "investment_advising", + "financial_planning_other", + "retirement_savings", + "tax_planning", + "aed_defibrillator", + "advanced_cardiac_life_support", + "basic_life_support", + "cpr", + "first_aid", + "first_aid_trainer_other", + "pediatric_cpr_first_aid", + "pediatric_advanced_life_support", + "pet_cpr_first_aid", + "wilderness_first_aid", + "baseboards", + "carpet", + "polishing", + "refinishing", + "repair_maintenance_flooring_pro", + "hardwood", + "installation_flooring_pro", + "marble", + "flooring_other", + "stair_flooring", + "tile", + "wood_floor_sanding", + "basement_waterproofing", + "crawl_spaces", + "foundation_drainage", + "foundation_installation", + "foundation_raising", + "foundation_pro_other", + "repairs_maintenance_foundation_pro", + "slab_foundation", + "steel_pier_pilings", + "water_moisture_control", + "burials", + "caskets", + "cremation", + "funeral_home_flowers", + "funerals", + "gravestones", + "grief_services", + "memorials", + "funeral_home_other", + "funeral_home_transportation_transfers", + "urns", + "funeral_home_veteran_services", + "general_maintenance", + "install_garage_door", + "install_opener", + "garage_door_other", + "repair_cables", + "repair_garage_door", + "repair_gate", + "repair_rollers_tracks", + "replace_door_panels", + "replace_opener", + "replace_springs", + "accessory_buildings", + "bathroom_cabinets", + "bathroom_tiles", + "bathroom_remodel", + "general_contractor_commercial_projects", + "decks_patio", + "exterior_finishing", + "foundations_concrete", + "home_addition", + "home_building", + "home_remodel_renovation", + "interior_finishing", + "kitchen_backsplash", + "kitchen_cabinets", + "kitchen_island", + "kitchen_remodel", + "general_contractor_other", + "roofing", + "ac_maintenance", + "clean_ducts_vents", + "ductless_heating_and_ac_services", + "hvac_maintenance", + "heating_maintenance", + "install_ac", + "install_ducts_vents", + "install_heating_system", + "install_thermostat", + "hvac_other", + "repair_ac", + "repair_hvac", + "repair_ducts_vents", + "repair_heating_system", + "repair_thermostat", + "body_waxing", + "eyebrow_styling", + "facial_waxing", + "hair_removal_other", + "sugaring", + "hair_braiding_and_textured_hairstyle", + "hair_coloring", + "hair_extensions", + "hair_styling", + "hair_treatments", + "haircut", + "hair_salon_other", + "assemble_furniture", + "clean_gutters", + "install_drywall", + "install_fan", + "install_flooring", + "install_tile", + "install_water_fixtures", + "mount_tv", + "handyman_other", + "repair_drywall", + "repair_fan", + "repair_flooring", + "repair_water_fixtures", + "replace_tile", + "buyer_seller_inspection", + "commercial_properties", + "home_inspector_electrical", + "fire_safety", + "fireplace_chimney", + "home_inspector_foundation", + "full_home_inspection", + "home_inspector_hvac", + "home_warranty", + "home_inspector_mold", + "home_inspector_new_construction", + "home_inspector_other", + "home_inspector_plumbing", + "home_inspector_roof", + "home_inspector_structural", + "water_testing", + "well_or_septic_system", + "wood_insects", + "air_sealing", + "batt_insulation", + "blown_in_insulation", + "insulation_removal", + "home_insulation_other", + "spray_foam_insulation", + "access_control", + "alarm_systems", + "commercial_security_systems", + "home_security_doors", + "fire_smoke_detection", + "home_security_locks", + "monitoring_services", + "home_security_other", + "residential_security_systems", + "smart_home_integration", + "video_surveillance", + "home_security_windows", + "audio_video_installation", + "commercial_projects", + "home_theater_design", + "install_tv", + "home_theater_lighting", + "network_it_services", + "home_theater_other", + "outdoor_installations", + "home_theater_smart_home_integration", + "soundproofing", + "whole_house_audio_video", + "deep_clean", + "moving_clean", + "office_clean", + "cleaner_other", + "standard_clean", + "asylum", + "citizenship", + "deportation", + "family_based_immigration", + "green_card", + "investment_visa", + "immigration_lawyer_other", + "outbound_work_permits", + "student_visa", + "visitor_visa", + "work_visa", + "auto_insurance", + "homeowners_insurance", + "insurance_agency_other", + "renters_insurance", + "umbrella_insurance", + "advertisements", + "copyright", + "export_control", + "franchises", + "ip_strategy", + "ip_transactions", + "international_ip", + "licensing", + "litigation_ip_lawyer", + "non_disclosure_agreements_ip_lawyer", + "ip_lawyer_other", + "patents", + "technology_transfer", + "trade_secrets", + "trademarks", + "2d_3d_renderings", + "color_schemes", + "commercial_interior_design", + "decorating", + "event_decorating", + "full_service_interior_design", + "interior_designer_other", + "space_planning", + "appliance_removal", + "construction_waste_removal", + "donation_pickup", + "electronic_waste_removal", + "furniture_removal", + "general_junk_removal", + "hazardous_waste_removal", + "house_garage_cleanout", + "junk_removal_other", + "yard_waste_removal", + "employment_contracts_labor_lawyer", + "employment_law_labor_lawyer", + "exempt_employee_status", + "labor_law", + "labor_negotiations", + "labor_lawyer_other", + "privacy_rights", + "sexual_harassment", + "unpaid_overtime", + "whistle_blowing", + "workers_compensation_labor_lawyer", + "wrongful_termination", + "artificial_turf_installation", + "paving_driveway_walkway", + "garden_decorations", + "grading_resloping", + "hardscapes", + "landscape_design", + "landscape_installations", + "landscaper_other", + "outdoor_steps", + "outdoor_water_feature", + "retaining_walls", + "sod_seeding", + "stone_masonry", + "sidewalk_walkway_landscaping", + "concrete_masonry", + "driveway_landscaping", + "arabic", + "english", + "french", + "german", + "hebrew", + "italian", + "japanese", + "korean", + "mandarin", + "language_instructor_other", + "portuguese", + "russian", + "sign_language", + "spanish", + "irrigation_system_repair_maintenance", + "lawn_mowing_maintenance", + "lawn_pest_control", + "mulching", + "lawn_care_other", + "seeding", + "sod_installation", + "weed_control", + "yard_cleanup", + "appeals", + "case_assessment_litigation_lawyer", + "civil_litigation", + "commercial_litigation", + "contracts_and_agreements", + "criminal_litigation", + "mediation_litigation_lawyer", + "litigation_lawyer_other", + "settlements", + "building_lockout", + "copy_building_key", + "copy_vehicle_key", + "install_hardware", + "new_key_fob", + "locksmith_other", + "rekey_lock", + "repair_hardware", + "vehicle_lockout", + "consent_issues", + "diagnosis_errors", + "medical_negligence", + "malpractice_lawyer_other", + "treatment_errors", + "massage_school_advanced_neuromuscular_therapy", + "massage_school_business_and_ethics", + "massage_school_clinical_therapies", + "massage_school_continuing_education", + "massage_school_deep_tissue_massage", + "massage_school_energetics", + "massage_school_hydrotherapy", + "massage_school_lymphatic_massage", + "massage_theory", + "massage_therapy_training", + "massage_school_online_massage_therapy", + "massage_school_other", + "massage_school_prenatal_massage", + "massage_school_sports_massage", + "massage_school_student_massage_clinic", + "massage_school_swedish_massage", + "aromatherapy_massage", + "craniosacral_therapy_cst", + "deep_tissue_massage", + "geriatric_massage", + "hot_stone_massage", + "manual_lymphatic_drainage", + "massage_therapy_massage_therapist", + "myofascial_release_therapy", + "orthopedic_massage", + "massage_therapist_other", + "prenatal_massage", + "reflexology_massage", + "shiatsu_massage", + "swedish_massage", + "trigger_point_massage", + "in_state_move", + "moving_junk_removal", + "local_move", + "mover_other", + "out_of_state_move", + "oversized_item_move", + "packing_unpacking", + "senior_move", + "moving_storage", + "vehicle_transport", + "acrylic_mani_pedi", + "dip_powder_mani_pedi", + "gel_mani_pedi", + "nail_art", + "nail_salon_other", + "shellac_mani_pedi", + "traditional_manicure", + "traditional_pedicure", + "assistive_devices_evaluation", + "ergonomics_evaluation", + "geriatric_occupational_therapy", + "hand_therapy", + "in_home_ot_assessment", + "neurologic_rehab", + "occupational_therapy_consultation", + "occupational_therapist_other", + "pediatric_occupational_therapy", + "wheelchair_evaluation", + "blepharitis_treatment", + "cataract_surgery", + "dry_eyes_treatment", + "eye_infection_treatment", + "floaters_treatment", + "glaucoma_treatment", + "lasik_surgery", + "lens_replacement", + "macular_degeneration_treatment", + "ophthalmologist_other", + "vision_loss_treatment", + "astigmatism_treatment", + "blurry_vision_treatment", + "color_blindness_evaluation", + "contact_lens_fitting", + "diabetic_retinopathy_evaluation", + "double_vision_treatment", + "eye_exam", + "eye_strain_evaluation", + "eyeglass_prescription", + "lazy_eye_evaluation", + "nearsightedness_treatment", + "optometrist_other", + "pink_eye_treatment", + "retinal_imaging", + "strabismus_treatment", + "stye_evaluation", + "archwires", + "braces", + "brackets", + "clear_aligners", + "crooked_teeth_treatment", + "crossbite_treatment", + "grinding_teeth_treatment", + "mouthguards", + "orthodontic_accelerators", + "orthodontist_other", + "overbite_treatment", + "overcrowding_treatment", + "retainers", + "smile_improvement", + "tmj_treatment", + "underbite_treatment", + "acl_surgery", + "ankle_surgery", + "arthroscopic_surgery", + "carpal_tunnel_surgery", + "hip_surgery", + "joint_injections", + "knee_surgery", + "orthopedic_spine_surgery", + "orthopedic_surgeon_other", + "shoulder_surgery", + "tendon_and_ligament_repair", + "cabinet_painting", + "door_painting", + "furniture_painting", + "gutter_painting", + "painter_other", + "paint_indoors_painter", + "paint_outdoors_painter", + "spray_painting", + "stair_painting", + "wallpaper_removal", + "window_painting", + "assault_battery", + "auto_accidents", + "bicycle_accidents", + "catastrophic_injuries", + "dog_bites", + "dui_injuries_personal_injury_lawyer", + "medical_malpractice", + "motorcycle_accidents", + "uninsured_motorist_claims", + "personal_injury_lawyer_other", + "pain_suffering", + "pedestrian_accidents", + "product_liability", + "slip_fall", + "workers_compensation_personal_injury_lawyer", + "wrongful_death", + "aerobics", + "athletic_performance", + "circuit_training", + "endurance", + "fitness_assessment", + "hiit", + "nutritional_counseling", + "personal_trainer_other", + "strength_conditioning", + "weight_loss", + "yoga", + "ants", + "bed_bugs", + "bees", + "cockroaches", + "fleas_or_mites", + "hornets_or_wasps", + "pest_inspection", + "mosquitoes", + "pest_control_other", + "rodents", + "spiders", + "termites", + "pet_adoption_birds", + "pet_adoption_cats", + "pet_adoption_dogs", + "pet_adoption_farm_animals", + "pet_adoption_fish", + "pet_adoption_other", + "pet_adoption_reptiles", + "pet_adoption_small_mammals", + "pet_adoption_special_needs_animals", + "cat_boarding", + "cat_grooming", + "cat_sitting_in_home", + "dog_boarding", + "dog_boarding_with_training", + "dog_daycare", + "dog_grooming", + "dog_sitting_in_home", + "dog_training", + "dog_walking", + "pet_boarding_other", + "other_pet_boarding", + "other_pet_daycare", + "other_pet_grooming", + "other_pet_sitting_in_home", + "cat_bathing", + "cat_ear_cleaning", + "cat_grooming_and_styling", + "cat_nail_trimming", + "dog_anal_gland_expression", + "dog_bathing_and_blow_dry", + "dog_ear_cleaning", + "dog_flea_and_tick_treatment", + "dog_full_service_grooming", + "dog_grooming_and_styling", + "dog_nail_trimming", + "dog_teeth_brushing", + "pet_grooming_other", + "aggressive_dog_training", + "behavior_modification", + "obedience_training", + "offleash_training", + "pet_trainer_other", + "puppy_training", + "service_animal_training", + "sport_trick_training", + "training_other_animals", + "ankle_injuries_physical_therapy", + "balance_therapy", + "dizziness_physical_therapy", + "foot_pain_physical_therapy", + "hand_pain_physical_therapy", + "herniated_disc_pain_physical_therapy", + "hip_pain_physical_therapy", + "knee_pain_physical_therapy", + "lymphedema_treatment", + "massage_therapy", + "muscle_pain_physical_therapy", + "neck_pain_physical_therapy", + "physical_therapist_other", + "physical_therapist_physical_therapy", + "shoulder_pain_physical_therapy", + "sports_rehabilitation", + "vertigo_physical_therapy", + "wrist_pain_physical_therapy", + "body_piercing", + "ear_piercing", + "navel_piercing", + "nose_piercing", + "piercing_studio_other", + "tongue_piercing", + "abdominoplasty", + "blepharoplasty", + "breast_augmentation", + "breast_reduction", + "brow_lift", + "buttock_lift", + "facelift", + "facial_implant", + "hair_transplant", + "liposuction", + "neck_lift", + "plastic_surgeon_other", + "otoplasty", + "rhinoplasty", + "varicose_vein_removal", + "find_leak", + "install_faucet", + "install_garbage_disposal", + "install_shower", + "install_toilet", + "install_water_heater", + "plumbing_other", + "repair_faucet", + "repair_garbage_disposal", + "repair_outdoor_systems", + "repair_pipe", + "repair_sewer", + "repair_shower", + "repair_toilet", + "repair_water_heater", + "unclog_drain", + "achilles_tendon_surgery", + "athletes_foot_treatment", + "bunion_removal", + "bunions_treatment", + "callus_removal", + "corn_removal", + "diabetic_foot_care", + "foot_pain_treatment", + "hammertoes_treatment", + "heel_spurs_treatment", + "ingrown_toenails_treatment", + "mortons_neuroma_treatment", + "orthotics", + "podiatrist_other", + "plantar_fasciitis_treatment", + "tendon_injury_treatment", + "wart_removal", + "commercial_pool_cleaning_maintenance", + "equipment_maintenance_repair", + "one_time_pool_cleaning", + "ongoing_pool_cleaning", + "pool_cleaner_other", + "seasonal_opening_closing", + "spa_hot_tub_cleaning", + "spa_hot_tub_repairs", + "tile_pool_wall_cleaning", + "pool_cleaner_water_features", + "water_testing_balancing", + "pool_contractor_commercial_projects", + "pool_contractor_custom_designs", + "jetted_lap_pools", + "pool_contractor_other", + "pool_hot_tub_equipment", + "pool_construction", + "pool_contractor_renovation", + "pool_contractor_repair_cracks", + "pool_contractor_repair_tile", + "pool_contractor_resurfacing", + "spa_hot_tub_installation", + "pool_contractor_water_features", + "bilingual_programs", + "early_preschool", + "full_day_preschool", + "half_day_preschool", + "preschool_infant_programs", + "kindergarten_classes", + "montessori_programs", + "preschool_other", + "play_based_preschool", + "reggio_emilia_preschool", + "special_needs_programs", + "summer_camp", + "waldorf_preschool", + "annual_physical", + "birth_control", + "constipation_treatment", + "family_physician", + "high_blood_pressure_treatment", + "immunizations", + "internal_medicine_doctor", + "primary_care_other", + "primary_care_doctor", + "wellness_exam", + "buyer_agent", + "first_time_home_buyer", + "foreclosed_properties", + "luxury_properties", + "new_construction", + "real_estate_agent_other", + "property_management", + "relocation", + "rentals", + "sellers_agent", + "commercial_real_estate", + "easements", + "encroachment", + "foreclosure_real_esate_lawyer", + "landlord_tenant_law", + "litigation_real_estate_lawyer", + "mortgage_lending_law", + "neighbor_hoa_disputes", + "real_estate_lawyer_other", + "property_damage", + "purchase_agreements", + "real_estate_contracts_transactions", + "residential_real_estate", + "title_services", + "trespassing", + "attic_venting", + "gutter_installation", + "gutter_repair", + "roofer_other", + "storm_wind_damage_roof_repair", + "roof_inspection", + "roof_installation", + "roof_repair", + "skylight_installation", + "skylight_repair", + "sewage_cleaning", + "sewage_excavation", + "sewage_inspection", + "sewage_installation", + "sewage_locating", + "sewage_maintenance_repairs", + "sewage_pro_other", + "sewage_pumping", + "sewage_removal_demolition", + "siding_pro_other", + "remodeling_siding_pro", + "repair_maintenance_siding_pro", + "siding_installation", + "siding_removal", + "commercial_snow_removal", + "snow_removal_other", + "residential_plowing", + "residential_shoveling_blowing", + "salt_sand_deicing", + "snow_relocation", + "pv_system_maintenance", + "pv_system_monitoring", + "pv_system_repair", + "solar_battery_installation", + "solar_panels_installation", + "climate_controlled_storage", + "document_storage", + "moving_and_storage", + "offsite_storage", + "storage_other", + "self_storage", + "american_traditional_tattoos", + "tattoo_studio_other", + "popular_shapes_tattoo", + "popular_tattoo_styles", + "sleeve_tattoo", + "tattoo_cover_ups", + "tribal_tattoo", + "civil_tax_litigation", + "corporate_taxes", + "criminal_tax_litigation", + "estate_tax_planning", + "failure_to_file", + "irs_tax_problems", + "innocent_spouse_relief", + "international_tax_services", + "non_collectible_status", + "offer_in_compromise", + "tax_lawyer_other", + "tax_audits", + "tax_liens_levies", + "tax_planning_lawyer", + "tax_relief", + "accounting_support", + "cryptocurrency_taxes", + "irs_audit_representation", + "irs_filing", + "irs_problem_consulting", + "business_incorporation_restructuring", + "new_business_services", + "payroll_support", + "tax_planning_tax_specialist", + "tax_preparation", + "tax_problem_consulting_tax_specialist", + "tire_shop_other", + "tire_alignment", + "tire_balancing", + "tire_repair", + "tire_replacement", + "tire_rotation", + "accident_recovery", + "towing_company_other", + "private_property_towing", + "roadside_assistance", + "storage_for_wrecked_vehicles", + "towing_services", + "truck_roadside_assistance", + "cdl_traffic_ticket", + "case_assessment_traffic_lawyer", + "dui_dwi_traffic_lawyer", + "fixit_ticket", + "traffic_lawyer_other", + "parking_ticket", + "reckless_driving_traffic_lawyer", + "red_light_ticket", + "speeding_ticket", + "suspended_license", + "traffic_ticket", + "cabling_and_bracing", + "tree_service_other", + "stump_removal", + "tree_planting", + "tree_removal", + "tree_transplanting", + "tree_trimming_and_pruning", + "tutor_computer_science", + "tutor_foreign_languages", + "tutor_geography", + "tutor_government_and_economics", + "tutor_history", + "tutor_homework_help", + "tutor_math", + "tutor_other", + "tutor_reading_and_writing", + "tutor_science", + "tutor_special_education", + "tutor_test_prep_k8", + "tutor_test_pre_college_entrance", + "tutor_test_prep_grad_school_entrance", + "veterinarian_allergies", + "veterinarian_behavior_counseling", + "bird_exotic_animal_care", + "veterinarian_dental_care", + "veterinarian_dermatology", + "veterinarian_emergency_care", + "veterinarian_end_of_life_care", + "veterinarian_examinations", + "farm_barn_animal_care", + "microchipping", + "veterinarian_nutrition_counseling", + "veterinarian_other", + "veterinarian_preventive_care", + "veterinarian_spay_neuter", + "veterinarian_surgery", + "veterinarian_vaccinations", + "fire_damage_cleanup_repair", + "water_damage_flooring", + "water_damage_mold_inspection", + "water_damage_mold_removal", + "water_damage_other", + "water_damage_painting", + "water_damage_pest_control", + "water_damage_plumbing", + "water_damage_remodeling", + "water_damage_roofing", + "water_damage_sewage_cleanup", + "water_damage_cleanup_repair", + "adult_weight_loss_programs", + "weight_loss_consultation_and_training", + "diet_and_nutrition_counseling", + "weight_loss_fitness_programs", + "kids_weight_loss_programs", + "weight_loss_meal_planning", + "metabolic_testing", + "weight_loss_service_other", + "weight_loss_personal_training", + "weight_loss_wellness_programs", + "glass_and_mirror_cleaning", + "gutter_cleaning", + "window_cleaner_other", + "power_pressure_washing", + "rooftop_skylight_cleaning", + "window_cleaning", + "window_boardup", + "door_installation", + "door_repair", + "glass_installation", + "window_repair_other", + "skylight_installation", + "skylight_repair", + "window_installation", + "window_repair", + "ashtanga", + "hatha", + "hot_yoga", + "iyengar", + "kundalini", + "meditation", + "yoga_instructor_other", + "power_yoga", + "restorative", + "vinyasa", + "yin" + ], + "description": "Parameter defines the type of a job, or a subcategory of a service you have searched for. For example, if you search for \"electrician\", you can be more specific by adding a job_type (e.g. `job_type=restore_power`). Head to the Google local services job types page for a full list of supported Google local services job types.", + "group": "advanced_google_local_services_parameters" + }, + "cid": { + "type": "number", + "description": "Parameter defines a unique ID of a place. The ID is available in our Google Local Services API JSON response. Parameter is required when accessing a specific business and should be used with bid and pid parameters. Parameter should not be confused with data_cid which corresponds to Google CID (customer identifier) of a place.", + "group": "google_local_services_place_parameters" + }, + "bid": { + "type": "number", + "description": "Parameter defines a unique ID of a place. The ID is available in our Google Local Services API JSON response. Parameter is required when accessing a specific business and should be used with cid and pid parameters.", + "group": "google_local_services_place_parameters" + }, + "pid": { + "type": "number", + "description": "Parameter defines a unique ID of a place. The ID is available in our Google Local Services API JSON response. Parameter is required when accessing a specific business and should be used with cid and bid parameters.", + "group": "google_local_services_place_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_local_services` to use the Google Local Services API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Local Services results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_maps.json b/engines/google_maps.json new file mode 100644 index 0000000..8a92760 --- /dev/null +++ b/engines/google_maps.json @@ -0,0 +1,634 @@ +{ + "engine": "google_maps", + "params": { + "q": { + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Maps search. The parameter is only required if type is set to `search`.", + "group": "search_query" + }, + "ll": { + "description": "Parameter defines the GPS coordinates for the search origin. Its value must match the following format: `@` + `latitude` + `,` + `longitude` + `,` + `zoom/map_height` This will form a string that looks like: `@40.7455096,-74.0083012,14z` or `@43.8521864,11.2168835,10410m`. The minimum `zoom` value is `3z` (the map is completely zoomed out). The maximum effective `zoom` value depends on the location, ranging from `18z` to `23z`. Some locations may support even higher `zoom` values, so we allow values up to `30z`. Alternatively, you can specify `map_height` in meters. The minimum value is `1m`. The maximum value is `15028132m`, which roughly equals `3z` on the equator. Parameter is applied only when type is set to `search`. Parameter can't be used with ll, lat, lon, z, or m parameters. Results are not guaranteed to be within the requested geographic location.", + "group": "geographic_location" + }, + "location": { + "type": "location", + "description": "Parameter defines the location, whose GPS coordinates are used for the search origin. At the end, coordinates are encoded as part of the ll parameter. Parameter should be used with z or m parameter. Parameter can't be used with ll, lat or lon parameters.", + "group": "geographic_location" + }, + "lat": { + "type": "number", + "description": "Parameter defines a GPS latitude for the search origin. At the end, it is encoded as part of the ll parameter. Parameter is required when using lon parameter. Parameter should be used with z or m parameter. Parameter can't be used with ll or location parameters.", + "group": "geographic_location" + }, + "lon": { + "type": "number", + "description": "Parameter defines a GPS longitude for the search origin. At the end, it is encoded as part of the ll parameter. Parameter is required when using lat parameter. Parameter should be used with z or m parameter. Parameter can't be used with ll or location parameters.", + "group": "geographic_location" + }, + "z": { + "type": "number", + "description": "Parameter defines a map zoom level. The minimum value is `3` (the map is completely zoomed out). The maximum effective value depends on the location, ranging from `18` to `23`. Some locations may support even higher values, so we allow values up to `30`. At the end, it is encoded as part of the ll parameter. Either z or m is required when using location or lat/lon parameters.", + "group": "geographic_location" + }, + "m": { + "type": "number", + "description": "Parameter defines a map height in meters. The minimum value is `1`. The maximum value is `15028132`, which roughly equals `3z` on the equator. At the end, it is encoded as part of the ll parameter. Either m or z is required when using location or lat/lon parameters.", + "group": "geographic_location" + }, + "nearby": { + "type": "checkbox", + "description": "Parameter forces to return search results closer to the specified location. Parameter is highly recommended when q parameter includes `near me` keywords. Parameter is not recommended when q parameter includes location. Parameter should be used with ll, location, or lat/lon parameters.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "sq", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bn", + "bs", + "bg", + "my", + "ca", + "zh", + "zh-cn", + "zh-hk", + "zh-tw", + "hr", + "cs", + "da", + "nl", + "en", + "en-au", + "en-gb", + "et", + "fa", + "fil", + "fi", + "fr", + "fr-ca", + "gl", + "ka", + "de", + "el", + "gu", + "iw", + "hi", + "hu", + "is", + "id", + "it", + "ja", + "kn", + "kk", + "km", + "ko", + "ky", + "lo", + "lv", + "lt", + "mk", + "ms", + "ml", + "mr", + "mn", + "ne", + "no", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "ro", + "ru", + "sr", + "si", + "sk", + "sl", + "es", + "es-419", + "sw", + "sv", + "ta", + "te", + "th", + "tr", + "uk", + "ur", + "uz", + "vi", + "zu" + ], + "description": "Parameter defines the language to use for the Google Maps search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google Maps languages page for a full list of supported Google Maps languages.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Maps search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries. Parameter only affects Place Results API.", + "group": "localization" + }, + "data": { + "description": "This parameter is deprecated, please use place_id or data_cid instead. Parameter can be used to filter the search results. You can visit Google Maps website, set filters you want and simply copy the data value from their URL to SerpApi URL. One of the uses of the parameter is to search for a specific place; therefore, it is required if the type is set to `place`. To use the data parameter to search for a specific place, it needs to be constructed in the following sequence: `!4m5!3m4!1s` + `data_id` + `!8m2!3d` + `latitude` + `!4d` + `longitude` This will form a string that looks like this: `!4m5!3m4!1s0x89c259b7abdd4769:0xc385876db174521a!8m2!3d40.750231!4d-74.004019`. You can find the `data_id` using our Google Maps API.", + "group": "advanced_google_maps_parameters" + }, + "place_id": { + "description": "Parameter defines the unique reference to a place in Google Maps. Place IDs are available for most locations, including businesses, landmarks, parks, and intersections. You can find the place_id using our Google Maps API. You can read more about Place IDs here. place_id can be used without any other optional parameter. place_id and data_cid can't be used together. Parameter should not be confused with place_id in Google Search API and Google Local API which are the same as data_cid in Google Maps API.", + "group": "advanced_google_maps_parameters" + }, + "data_cid": { + "description": "Parameter defines the Google CID (customer identifier) of a place. This parameter can be found in Google Maps API local results, as well as in Google Search API and Google Local API local results under the name of place_id. You can also acquire it using Google's CID converter. data_cid can be used without any other optional parameter. data_cid and place_id can't be used together.", + "group": "advanced_google_maps_parameters" + }, + "type": { + "required": true, + "type": "select", + "options": [ + "search", + "place" + ], + "description": "Parameter defines the type of search you want to make. It can be set to: `search` - returns a list of results for the set q parameter, `place` - returns results for a specific place when data parameter is set Parameter is not required when using place_id or data_cid.", + "group": "search_type" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `20` is the 2nd page of results, `40` is the 3rd page of results, etc.). We recommend starting with `0` and increasing by `20` for the next page. There is no hard limit on the maximum offset number, but we recommend a maximum of `100` (page six) which is the same behavior as with the Google Maps web app. More than that, the result might be duplicated or irrelevant.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_maps` to use the Google Maps API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Maps results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_maps_autocomplete.json b/engines/google_maps_autocomplete.json new file mode 100644 index 0000000..85b8616 --- /dev/null +++ b/engines/google_maps_autocomplete.json @@ -0,0 +1,467 @@ +{ + "engine": "google_maps_autocomplete", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. A query that would be used to provide completion options.", + "group": "search_query" + }, + "ll": { + "required": true, + "description": "Parameter defines the GPS coordinates of the location where you want the search to originate from. Its value must match the following format: `@` + `latitude` + `,` + `longitude` + `,` + `zoom/map_height` This will form a string that looks like this: e.g. `@40.7455096,-74.0083012,14z` or `@43.8521864,11.2168835,10410m`. The `zoom` attribute ranges from `3z`, map completely zoomed out - to `21z`, map completely zoomed in. Alternatively, you can specify `map_height` in meters (e.g., `10410m`).", + "group": "geographic_location" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Maps Autocomplete search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Maps Autocomplete search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "cp": { + "description": "Cursor pointer defines the position of cursor for the query provided, position starts from 0 which is a case where cursor is placed before the query `|query`. If not provided acts as cursor is placed in the end of query `query|`.", + "group": "advanced_autocomplete_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_maps_autocomplete` to use the Google Maps Autocomplete API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Maps Autocomplete results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_maps_contributor_reviews.json b/engines/google_maps_contributor_reviews.json new file mode 100644 index 0000000..94a203b --- /dev/null +++ b/engines/google_maps_contributor_reviews.json @@ -0,0 +1,467 @@ +{ + "engine": "google_maps_contributor_reviews", + "params": { + "contributor_id": { + "required": true, + "description": "Parameter defines the Google Maps Contributor ID. It's a series of digits which can be found in the contributor reviews URL. For example, the contributor ID for the URL `https://www.google.com/maps/contrib/110382514725174877672/reviews` is `110382514725174877672`. It can also be found by using our Google Maps Place Results API and Google Maps Reviews API.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Maps Contributor Reviews search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Maps Contributor Reviews search. It's a two-letter language code, for example, `en` for English (default), `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results.", + "group": "pagination" + }, + "num": { + "type": "number", + "description": "Parameter defines the maximum number of results to return. (e.g., `10` (default) returns 10 results, and `200` returns 200 results). This parameter should not be larger than `200`.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_maps_contributor_reviews` to use the Google Maps Contributor Reviews API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Maps Contributor Reviews results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_maps_directions.json b/engines/google_maps_directions.json new file mode 100644 index 0000000..e34cb06 --- /dev/null +++ b/engines/google_maps_directions.json @@ -0,0 +1,558 @@ +{ + "engine": "google_maps_directions", + "params": { + "start_addr": { + "description": "Parameter defines the address of the starting point for the direction you want to search. You can use anything that you would use in a regular Google Maps Directions search. Alternatively, you can use start_data_id or start_coords.", + "group": "search_query" + }, + "end_addr": { + "description": "Parameter defines the address of the ending point for the direction you want to search. You can use anything that you would use in a regular Google Maps Directions search. Alternatively, you can use end_data_id or end_coords.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Maps Directions search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "travel_mode": { + "type": "select", + "options": [ + [ + "6", + "Best (Default) - 6" + ], + [ + "0", + "Driving - 0" + ], + [ + "9", + "Two-wheeler - 9" + ], + [ + "3", + "Transit - 3" + ], + [ + "2", + "Walking - 2" + ], + [ + "1", + "Cycling - 1" + ], + [ + "4", + "Flight - 4" + ] + ], + "description": "Parameter defines the travel mode. Available options: `6` - Best (Default) `0` - Driving `9` - Two-wheeler `3` - Transit `2` - Walking `1` - Cycling `4` - Flight", + "group": "advanced_google_maps_directions_parameters" + }, + "start_data_id": { + "description": "Parameter defines the data ID of the starting point for the direction you want to search. Find the data ID of a place using our Google Maps API. Alternatively, you can use start_addr or start_coords.", + "group": "advanced_google_maps_directions_parameters" + }, + "end_data_id": { + "description": "Parameter defines the data ID of the ending point for the direction you want to search. Find the data ID of a place using our Google Maps API. Alternatively, you can use end_addr or end_coords.", + "group": "advanced_google_maps_directions_parameters" + }, + "start_coords": { + "description": "Parameter defines the GPS coordinates of the starting point for the direction you want to search. The format is `latitude,longitude`. E.g. `30.197471099,-97.66635289`. Alternatively, you can use start_addr or start_data_id.", + "group": "advanced_google_maps_directions_parameters" + }, + "end_coords": { + "description": "Parameter defines the GPS coordinates of the ending point for the direction you want to search. The format is `latitude,longitude`. E.g. `30.197471099,-97.66635289`. Alternatively, you can use end_addr or end_data_id.", + "group": "advanced_google_maps_directions_parameters" + }, + "distance_unit": { + "type": "select", + "options": [ + [ + "1", + "miles - 1" + ], + [ + "0", + "km - 0" + ] + ], + "description": "Parameter defines the displayed distance unit. Available options: `1` - miles `0` - km", + "group": "advanced_options" + }, + "avoid": { + "description": "Parameter defines avoid options. Available options: `highways` - Highways `tolls` - Tolls `ferries` - Ferries You can also combine multiple options by joining them with a comma (e.g.: `highways,tolls`).", + "group": "advanced_options" + }, + "prefer": { + "description": "Parameter defines preferred transit options. Available options: `bus` - Bus `subway` - Subway `train` - Train `tram_light_rail` - Tram and light rail You can also combine multiple options by joining them with a comma (e.g.: `subway,train`). Parameter works only if travel_mode parameter is set to: `3` (Transit)", + "group": "advanced_options" + }, + "route": { + "type": "select", + "options": [ + [ + "2", + "Fewer transfers - 2" + ], + [ + "3", + "Less walking - 3" + ], + [ + "4", + "Wheelchair accessible - 4" + ] + ], + "description": "Parameter defines route options. Available options: `2` - Fewer transfers `3` - Less walking `4` - Wheelchair accessible Parameter works only if travel_mode parameter is set to: `3` (Transit)", + "group": "advanced_options" + }, + "time": { + "description": "Parameter defines the time to travel. Available options: `depart_at:xxxxxx` - Specifies the departure time, where `xxxxxx` is the timestamp. E.g. `depart_at:1698229538` specifies the departure time to 2023-10-25 10:25:38 GMT+0000 `arrive_by:xxxxxx` - Specifies the arrival time, where `xxxxxx` is the timestamp. E.g. `arrive_by:1698229538` specifies the arrival time to 2023-10-25 10:25:38 GMT+0000 `last_available` - Takes the last available transit. This option works only if travel_mode parameter is set to: `3` (Transit)", + "group": "advanced_options" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_maps_directions` to use the Google Maps Directions API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Maps Directions results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_maps_photo_meta.json b/engines/google_maps_photo_meta.json new file mode 100644 index 0000000..eabb59e --- /dev/null +++ b/engines/google_maps_photo_meta.json @@ -0,0 +1,43 @@ +{ + "engine": "google_maps_photo_meta", + "params": { + "data_id": { + "required": true, + "description": "Parameter defines the Google Maps Photos' data ID. Find the data ID of a photo using our Google Maps Photos API.", + "group": "search_query" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_maps_photo_meta` to use the Google Maps Photo Meta API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Maps Photo Meta results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_maps_photos.json b/engines/google_maps_photos.json new file mode 100644 index 0000000..7d2a092 --- /dev/null +++ b/engines/google_maps_photos.json @@ -0,0 +1,215 @@ +{ + "engine": "google_maps_photos", + "params": { + "data_id": { + "required": true, + "description": "Parameter defines the Google Maps data ID. Find the data ID of a place using our Google Maps API.", + "group": "search_query" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Maps Photos search. It's a two-letter language code, for example, `en` for English (default), `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "category_id": { + "description": "Parameter defines the ID of a category. You can find the value of an ID inside the `categories` array, using our Google Maps Photos API. The number, and the type of categories can vary between places.", + "group": "advanced_google_maps_photos_parameters" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results. `20` results are returned per page.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_maps_photos` to use the Google Maps Photos API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Maps Photos results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_maps_posts.json b/engines/google_maps_posts.json new file mode 100644 index 0000000..12c2f78 --- /dev/null +++ b/engines/google_maps_posts.json @@ -0,0 +1,47 @@ +{ + "engine": "google_maps_posts", + "params": { + "data_id": { + "required": true, + "description": "Parameter defines the Google Maps data ID. Find the data ID of a place using our Google Maps API.", + "group": "search_query" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results. `10` results are returned per page.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_maps_posts` to use the Google Maps Posts API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Maps Posts results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_maps_reviews.json b/engines/google_maps_reviews.json new file mode 100644 index 0000000..2570e4a --- /dev/null +++ b/engines/google_maps_reviews.json @@ -0,0 +1,237 @@ +{ + "engine": "google_maps_reviews", + "params": { + "data_id": { + "description": "Parameter defines the Google Maps data ID. Find the data ID by using our Google Maps API. Either data_id or place_id should be set.", + "group": "search_query" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Maps Reviews search. It's a two-letter language code, for example, `en` for English (default), `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "place_id": { + "description": "Parameter defines the unique reference to a place on a Google Map. Place IDs are available for most locations, including businesses, landmarks, parks, and intersections. You can find the place_id using our Google Maps API. You can read more about Place IDs here. Either data_id or place_id should be set.", + "group": "advanced_google_maps_reviews_parameters" + }, + "sort_by": { + "type": "select", + "options": [ + "qualityScore", + "newestFirst", + "ratingHigh", + "ratingLow" + ], + "description": "Parameter is used for sorting and refining results. Available options: `qualityScore` - the most relevant reviews (default). `newestFirst` - the most recent reviews. `ratingHigh` - the highest rating reviews. `ratingLow` - the lowest rating reviews.", + "group": "advanced_google_maps_reviews_parameters" + }, + "topic_id": { + "description": "Parameter defines the ID of the topic you want to use for filtering reviews. You can access IDs inside our structured JSON response. topic_id and query parameters can't be used together.", + "group": "advanced_google_maps_reviews_parameters" + }, + "query": { + "description": "Parameter defines a text query you want to use for filtering reviews. query and topic_id parameters can't be used together.", + "group": "advanced_google_maps_reviews_parameters" + }, + "num": { + "description": "Parameter defines the maximum number of results to return. It ranges from `1` to `20`. It defaults to `10`. Parameter cannot be used on the initial page when neither next_page_token, topic_id, nor query is set. It always returns `8` results.", + "group": "pagination" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results. Usage of start parameter (results offset) has been discontinued by Google.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_maps_reviews` to use the Google Maps Reviews API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Maps Reviews results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_news.json b/engines/google_news.json new file mode 100644 index 0000000..ad09866 --- /dev/null +++ b/engines/google_news.json @@ -0,0 +1,492 @@ +{ + "engine": "google_news", + "params": { + "q": { + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google News search. e.g. `site:`, `when:`. Parameter can't be used together with any of the Advanced Parameters.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google News search. It's a two-letter country code. (e.g., `us` for the United States (default), `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google News countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google News search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "topic_token": { + "description": "Parameter defines the Google News topic token. It is used for accessing the news results for a specific topic (e.g., \"World\", \"Business\", \"Technology\"). The token can be found in our JSON response or the URL of the Google News page (in the URL, it is a string of characters preceded by `/topics/`). Parameter can be used together with section_token.", + "group": "advanced_google_news_parameters" + }, + "kgmid": { + "description": "Parameter defines the Knowledge Graph ID (`KGMID`) of a topic or location for Google News results. It is a string that starts with `/m/` or `/g/`. You can look up entities on Wikidata and use their \"Freebase ID\" as the kgmid. For example, `/m/0vzm` is the kgmid for Austin, TX, and `/m/02mjmr` is the kgmid for Barack Obama. Parameter can only be used alone.", + "group": "advanced_google_news_parameters" + }, + "publication_token": { + "description": "Parameter defines the Google News publication token. It is used for accessing the news results from a specific publisher (e.g., \"CNN\", \"BBC\", \"The Guardian\"). The token can be found in our JSON response or the URL of the Google News page (in the URL, it is a string of characters preceded by `/publications/`). Parameter can be used together with section_token.", + "group": "advanced_google_news_parameters" + }, + "section_token": { + "description": "Parameter defines the Google News section token. It is used for accessing the sub-section of a specific topic. (e.g., \"Business -> Economy\"). The token can be found in our JSON response or the URL of the Google News page (in the URL, it is a string of characters preceded by `/sections/`) Parameter can be used together with topic_token, publication_token, and so.", + "group": "advanced_google_news_parameters" + }, + "story_token": { + "description": "Parameter defines the Google News story token. It is used for accessing the news results with full coverage of a specific story. The token can be found in our JSON response or the URL of the Google News page (in the URL, it is a string of characters preceded by `/stories/`) Parameter can be used together with so.", + "group": "advanced_google_news_parameters" + }, + "so": { + "type": "select", + "options": [ + [ + "0", + "Relevance" + ], + [ + "1", + "Date" + ] + ], + "description": "Parameter defines the sorting method. Results can be sorted by relevance or by date. By default, the results are sorted by relevance. List of supported values are: `0` - Relevance `1` - Date Parameter can be used together with story_token and section_token.", + "group": "advanced_google_news_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_news` to use the Google News API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google News results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_news_light.json b/engines/google_news_light.json new file mode 100644 index 0000000..94c9938 --- /dev/null +++ b/engines/google_news_light.json @@ -0,0 +1,741 @@ +{ + "engine": "google_news_light", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google search. e.g. `inurl:`, `site:`, `intitle:`. We also support advanced search query parameters such as as_dt and as_eq. See the full list of supported advanced search query parameters.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "lr": { + "description": "Parameter defines one or multiple languages to limit the search to. It uses `lang_{two-letter language code}` to specify languages and `|` as a delimiter. (e.g., `lang_fr|lang_de` will only search French and German pages). Head to the Google lr languages page for a full list of supported languages.", + "group": "localization" + }, + "as_dt": { + "description": "Parameter controls whether to include or exclude results from the site named in the as_sitesearch parameter.", + "group": "advanced_search_query_parameters" + }, + "as_epq": { + "description": "Parameter identifies a phrase that all documents in the search results must contain. You can also use the phrase search query term to search for a phrase.", + "group": "advanced_search_query_parameters" + }, + "as_eq": { + "description": "Parameter identifies a word or phrase that should not appear in any documents in the search results. You can also use the exclude query term to ensure that a particular word or phrase will not appear in the documents in a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_lq": { + "description": "Parameter specifies that all search results should contain a link to a particular URL. You can also use the link: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_nlo": { + "description": "Parameter specifies the starting value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_nhi": { + "description": "Parameter specifies the ending value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_oq": { + "description": "Parameter provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_q": { + "description": "Parameter provides search terms to check for in a document. This parameter is also commonly used to allow users to specify additional terms to search for within a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_qdr": { + "description": "Parameter requests search results from a specified time period (quick date range). The following values are supported: `d[number]`: requests results from the specified number of past days. Example for the past 10 days: `as_qdr=d10` `w[number]`: requests results from the specified number of past weeks. `m[number]`: requests results from the specified number of past months. `y[number]`: requests results from the specified number of past years. Example for the past year: `as_qdr=y`", + "group": "advanced_search_query_parameters" + }, + "as_rq": { + "description": "Parameter specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. You can also use the related: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_sitesearch": { + "description": "Parameter allows you to specify that all search results should be pages from a given site. By setting the as_dt parameter, you can also use it to exclude pages from a given site from your search results.", + "group": "advanced_search_query_parameters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "nfpr": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude these results, or `0` to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_news_light` to use the Google News Light API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google News Light results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_patents.json b/engines/google_patents.json new file mode 100644 index 0000000..254cce1 --- /dev/null +++ b/engines/google_patents.json @@ -0,0 +1,138 @@ +{ + "engine": "google_patents", + "params": { + "q": { + "description": "Parameter defines the query you want to search. You can split multiple search terms with semicolon `;`. For advanced search syntax, please refer to About Google Patents. Example for single search term: `(Coffee) OR (Tea)` Example for multiple search terms (separated by semicolon `;`): `(Coffee) OR (Tea);(A47J)`", + "group": "search_query" + }, + "page": { + "type": "number", + "description": "Parameter defines the page number. It's used for pagination. (e.g., `1` (default) is the first page of results, `2` is the 2nd page of results, etc.).", + "group": "pagination" + }, + "num": { + "type": "number", + "description": "Parameter controls the number of results per page. Minimum: `10`, Maximum: `100`.", + "group": "pagination" + }, + "sort": { + "type": "select", + "options": [ + "new", + "old" + ], + "description": "Parameter defines the sorting method. By default, the results are sorted by Relevance. List of supported values are: `new` - Newest `old` - Oldest Patent results are sorted by `filing_date` while scholar results are sorted by `publication_date` for `new` and `old` values.", + "group": "advanced_google_patents_parameters" + }, + "clustered": { + "type": "select", + "options": [ + "true" + ], + "description": "Parameter defines how the results should be grouped. List of supported values are: `true` - Classification", + "group": "advanced_google_patents_parameters" + }, + "dups": { + "type": "select", + "options": [ + "language" + ], + "description": "Parameter defines the method of deduplication. Either Family (default) or Publication. List of supported values are: `language` - Publication", + "group": "advanced_google_patents_parameters" + }, + "patents": { + "type": "checkbox", + "description": "Parameter controls whether or not to include Google Patents results. (Defaults to true)", + "group": "advanced_google_patents_parameters" + }, + "scholar": { + "type": "checkbox", + "description": "Parameter controls whether or not to include Google Scholar results. (Defaults to false)", + "group": "advanced_google_patents_parameters" + }, + "before": { + "description": "Parameter defines the maximum date of the results. The format of this field is `type:YYYYMMDD`. `type` can be one of `priority`, `filing`, and `publication`. Example: - `priority:20221231` - `publication:20230101`", + "group": "date_range" + }, + "after": { + "description": "Parameter defines the minimum date of the results. The format of this field is `type:YYYYMMDD`. `type` can be one of `priority`, `filing`, and `publication`. Example: - `priority:20221231` - `publication:20230101`", + "group": "date_range" + }, + "inventor": { + "description": "Parameter defines the inventors of the patents. Split multiple inventors with `,` (comma)", + "group": "participants" + }, + "assignee": { + "description": "Parameter defines the assignees of the patents. Split multiple assignees with `,` (comma)", + "group": "participants" + }, + "country": { + "description": "Parameter filters patent results by countries. Split multiple country codes with `,` (comma). List of supported country codes. Example:`WO,US`.", + "group": "advanced_filters" + }, + "language": { + "description": "Parameter filters patent results by languages. Split multiple languages with `,` (comma). List of supported values are: `ENGLISH`, `GERMAN`, `CHINESE`, `FRENCH`, `SPANISH`, `ARABIC`, `JAPANESE`, `KOREAN`, `PORTUGUESE`, `RUSSIAN`, `ITALIAN`, `DUTCH`, `SWEDISH`, `FINNISH`, `NORWEGIAN`, `DANISH`. Example:`ENGLISH,GERMAN`.", + "group": "advanced_filters" + }, + "status": { + "type": "select", + "options": [ + "GRANT", + "APPLICATION" + ], + "description": "Parameter filters patent results by status. List of supported values are: `GRANT` - Grant `APPLICATION` - Application", + "group": "advanced_filters" + }, + "type": { + "type": "select", + "options": [ + "PATENT", + "DESIGN" + ], + "description": "Parameter filters patent results by type. List of supported values are: `PATENT` - Patent `DESIGN` - Design", + "group": "advanced_filters" + }, + "litigation": { + "type": "select", + "options": [ + "YES", + "NO" + ], + "description": "Parameter filters patent results by litigation status. List of supported values are: `YES` - Has Related Litigation `NO` - No Known Litigation", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_patents` to use the Google Patents API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Patents results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_patents_details.json b/engines/google_patents_details.json new file mode 100644 index 0000000..8c1a49d --- /dev/null +++ b/engines/google_patents_details.json @@ -0,0 +1,43 @@ +{ + "engine": "google_patents_details", + "params": { + "patent_id": { + "required": true, + "description": "Parameter defines the ID of the patent you want to retrieve. You can get it from the results of our Google Patents API. It can be: - A patent ID: `patent//`, the country code can be omitted (e.g. `patent/US11734097B1/en` or `patent/US11734097B1`) - A scholar ID: `scholar/` (e.g. `scholar/6497879044063343659`)", + "group": "search_query" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_patents_details` to use the Google Patents Details API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Patents Details results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_play.json b/engines/google_play.json new file mode 100644 index 0000000..6ca1c80 --- /dev/null +++ b/engines/google_play.json @@ -0,0 +1,538 @@ +{ + "engine": "google_play", + "params": { + "q": { + "description": "Parameter defines the query you want to search in Google Play Apps Store.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Play search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). You can find the full list of Google Play country availability here: Google Play Countries. Afterwards, head to the Google countries page page for a two-letter country code.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Play search. It's a two-letter language code. (e.g., `en` (default) for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "apps_category": { + "type": "select", + "options": [ + "ART_AND_DESIGN", + "AUTO_AND_VEHICLES", + "BEAUTY", + "BOOKS_AND_REFERENCE", + "BUSINESS", + "COMICS", + "COMMUNICATION", + "DATING", + "EDUCATION", + "ENTERTAINMENT", + "EVENTS", + "FINANCE", + "FOOD_AND_DRINK", + "HEALTH_AND_FITNESS", + "HOUSE_AND_HOME", + "LIBRARIES_AND_DEMO", + "LIFESTYLE", + "MAPS_AND_NAVIGATION", + "MEDICAL", + "MUSIC_AND_AUDIO", + "NEWS_AND_MAGAZINES", + "PARENTING", + "PERSONALIZATION", + "PHOTOGRAPHY", + "PRODUCTIVITY", + "SHOPPING", + "SOCIAL", + "SPORTS", + "TOOLS", + "TRAVEL_AND_LOCAL", + "VIDEO_PLAYERS", + "ANDROID_WEAR", + "WATCH_FACE", + "WEATHER", + "FAMILY" + ], + "description": "Parameter defines the apps store category. Head to the Google Play store Apps Categories for a full list of supported Google Play Apps store categories.", + "group": "google_play_categories" + }, + "store_device": { + "type": "select", + "options": [ + "phone", + "tablet", + "tv", + "chromebook", + "watch", + "car" + ], + "description": "Parameter defines the device for sorting results. This parameter cannot be used with apps_category or q parameters. Available options: `phone` - Phone device (default) `tablet` - Tablet device `tv` - TV device `chromebook` - Chromebook device `watch` - Watch device `car` - Car device", + "group": "advanced_google_play_parameters" + }, + "age": { + "type": "select", + "options": [ + "AGE_RANGE1", + "AGE_RANGE2", + "AGE_RANGE3" + ], + "description": "Parameter defines age subcategory. age works, and should only be used with `apps_category=FAMILY`(Kids Apps) It can be set to: `AGE_RANGE1` - Ages up to 5 `AGE_RANGE2` - Ages 6-8 `AGE_RANGE3` - Ages 9-12 The default value for age is: - All ages up to 12", + "group": "advanced_google_play_parameters" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results. It shouldn't be used with the section_page_token, see_more_token, and chart parameters.", + "group": "pagination" + }, + "section_page_token": { + "description": "Parameter defines the section page token used for retrieving the pagination results from individual sections. This parameter is a safer version of see_more_token, and is found in every row you can paginate into. It shouldn't be used with the next_page_token, see_more_token, and chart parameters", + "group": "pagination" + }, + "chart": { + "description": "Parameter is used for showing top charts. It can return up to `50` results. Each store contains different charts which require different values for retrieving results. To get the value of a specific chart you can use our Google Play Apps Store API JSON output: `chart_options[index].value` (e.g. `chart=topselling_free`). It shouldn't be used with the section_page_token, see_more_token, and next_page_token parameters", + "group": "pagination" + }, + "see_more_token": { + "description": "Parameter defines the see more token used for retrieving the pagination results from individual sections It is usually found in next page results. It shouldn't be used with the section_page_token, next_page_token, and chart, parameters", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_play` to use the Google Play API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Play results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_play_books.json b/engines/google_play_books.json new file mode 100644 index 0000000..70515a8 --- /dev/null +++ b/engines/google_play_books.json @@ -0,0 +1,959 @@ +{ + "engine": "google_play_books", + "params": { + "q": { + "description": "Parameter defines the query you want to search in Google Play Books Store.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Play search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). You can find the full list of Google Play country availability here: Google Play Countries. Afterwards, head to the Google countries page page for a two-letter country code.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Play search. It's a two-letter language code. (e.g., `en` (default) for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "books_category": { + "type": "select", + "options": [ + "coll_1665", + "subj_Art___Humor.AH_Art", + "subj_Art___Humor.AH_Drama", + "subj_Art___Humor.AH_Humor", + "subj_Art___Humor.AH_Music", + "subj_Art___Humor.AH_Performing_Arts", + "coll_1204", + "subj_Biography___Autobiography.General", + "subj_Biography___Autobiography.Adventurers___Explorers", + "subj_Biography___Autobiography.Business", + "subj_Biography___Autobiography.Composers___Musicians", + "subj_Biography___Autobiography.Criminals___Outlaws", + "subj_Biography___Autobiography.Cultural_Heritage", + "subj_Biography___Autobiography.Entertainment___Performing_Arts", + "subj_Biography___Autobiography.Historical", + "subj_Biography___Autobiography.Literary", + "subj_Biography___Autobiography.Medical", + "subj_Biography___Autobiography.Military", + "subj_Biography___Autobiography.Personal_Memoirs", + "subj_Biography___Autobiography.Political", + "subj_Biography___Autobiography.Presidents___Heads_of_State", + "subj_Biography___Autobiography.Religious", + "subj_Biography___Autobiography.Rich___Famous", + "subj_Biography___Autobiography.Royalty", + "subj_Biography___Autobiography.Science___Technology", + "subj_Biography___Autobiography.Sports", + "subj_Biography___Autobiography.Women", + "coll_1668", + "coll_1205", + "subj_Business___Economics.General", + "subj_Business___Economics.Accounting", + "subj_Business___Economics.Advertising___Promotion", + "subj_Business___Economics.Business_Communication", + "subj_Business___Economics.Careers", + "subj_Business___Economics.Decision-Making___Problem_Solving", + "subj_Business___Economics.Development", + "subj_Business___Economics.E-Commerce", + "subj_Business___Economics.Economic_History", + "subj_Business___Economics.Economics", + "subj_Business___Economics.Entrepreneurship", + "subj_Business___Economics.Finance", + "subj_Business___Economics.Human_Resources___Personnel_Management", + "subj_Business___Economics.Industries", + "subj_Business___Economics.International", + "subj_Business___Economics.Investments___Securities", + "subj_Business___Economics.Leadership", + "subj_Business___Economics.Management", + "subj_Business___Economics.Management_Science", + "subj_Business___Economics.Marketing", + "subj_Business___Economics.Motivational", + "subj_Business___Economics.Organizational_Behavior", + "subj_Business___Economics.Personal_Finance", + "subj_Business___Economics.Real_Estate", + "subj_Business___Economics.Sales___Selling", + "subj_Business___Economics.Skills", + "subj_Business___Economics.Small_Business", + "subj_Business___Economics.Strategic_Planning", + "subj_Business___Economics.Time_Management", + "subj_Business___Economics.Workplace_Culture", + "coll_1207", + "subj_Computers.General", + "subj_Computers.Desktop_Applications", + "subj_Computers.Electronic_Publishing", + "subj_Computers.Enterprise_Applications", + "subj_Computers.Hardware", + "subj_Computers.Internet", + "subj_Computers.Networking", + "subj_Computers.Operating_Systems", + "subj_Computers.Programming", + "subj_Computers.Programming_Languages", + "subj_Computers.Security", + "subj_Computers.Software_Development___Engineering", + "subj_Computers.Systems_Architecture", + "subj_Computers.Web", + "coll_1208", + "subj_Cooking.General", + "subj_Cooking.Beverages", + "subj_Cooking.Courses___Dishes", + "subj_Cooking.Health___Healing", + "subj_Cooking.Methods", + "subj_Cooking.Regional___Ethnic", + "subj_Cooking.Specific_Ingredients", + "subj_Cooking.Tablesetting", + "subj_Cooking.Vegetarian___Vegan", + "coll_1670", + "subj_Education.E_General", + "subj_Education.English_as_a_Second_Language", + "subj_Education.Higher", + "subj_Education.Teaching_Methods___Materials", + "coll_1261", + "subj_Technology___Engineering.General", + "subj_Technology___Engineering.Agriculture", + "subj_Technology___Engineering.Electronics", + "subj_Technology___Engineering.Industrial_Technology", + "subj_Technology___Engineering.Military_Science", + "subj_Technology___Engineering.Mobile___Wireless_Communications", + "subj_Technology___Engineering.Nanotechnology___MEMS", + "subj_Technology___Engineering.Remote_Sensing___Geographic_Information_Systems", + "coll_1200", + "subj_Fiction.General", + "subj_Fiction.Action___Adventure", + "subj_Fiction.African_American", + "subj_Fiction.Alternative_History", + "subj_Fiction.Anthologies__multiple_authors_", + "subj_Fiction.Biographical", + "subj_Fiction.Christian", + "subj_Fiction.Classics", + "subj_Fiction.Coming_of_Age", + "subj_Fiction.Contemporary_Women", + "subj_Fiction.Crime", + "subj_Fiction.Cultural_Heritage", + "subj_Fiction.Erotica", + "subj_Fiction.Fairy_Tales__Folk_Tales__Legends___Mythology", + "subj_Fiction.Family_Life", + "subj_Fiction.Fantasy", + "subj_Fiction.Gay", + "subj_Fiction.Ghost", + "subj_Fiction.Historical", + "subj_Fiction.Horror", + "subj_Fiction.Humorous", + "subj_Fiction.Legal", + "subj_Fiction.Lesbian", + "subj_Fiction.Literary", + "subj_Fiction.Media_Tie-In", + "subj_Fiction.Medical", + "subj_Fiction.Men_s_Adventure", + "subj_Fiction.Mystery___Detective", + "subj_Fiction.Occult___Supernatural", + "subj_Fiction.Political", + "subj_Fiction.Psychological", + "subj_Fiction.Religious", + "subj_Fiction.Romance", + "subj_Fiction.Sagas", + "subj_Fiction.Satire", + "subj_Fiction.Science_Fiction", + "subj_Fiction.Sea_Stories", + "subj_Fiction.Short_Stories__single_author_", + "subj_Fiction.Sports", + "subj_Fiction.Thrillers", + "subj_Fiction.War___Military", + "subj_Fiction.Westerns", + "coll_1605", + "subj_Health__Mind___Body.HMB_General", + "subj_Health__Mind___Body.Alternative_Therapies", + "subj_Health__Mind___Body.Astrology", + "subj_Health__Mind___Body.Beauty___Grooming", + "subj_Health__Mind___Body.Creativity", + "subj_Health__Mind___Body.Death__Grief__Bereavement", + "subj_Health__Mind___Body.Exercise", + "subj_Health__Mind___Body.Healing", + "subj_Health__Mind___Body.Healthy_Living", + "subj_Health__Mind___Body.Motivational___Inspirational", + "subj_Health__Mind___Body.Personal_Growth", + "subj_Health__Mind___Body.Spirituality", + "subj_Health__Mind___Body.Yoga", + "coll_1209", + "subj_History.General", + "subj_History.Africa", + "subj_History.Americas__North__Central__South__West_Indies_", + "subj_History.Ancient", + "subj_History.Asia", + "subj_History.Europe", + "subj_History.Holocaust", + "subj_History.Latin_America", + "subj_History.Medieval", + "subj_History.Middle_East", + "subj_History.Military", + "subj_History.Modern", + "subj_History.Native_American", + "subj_History.Revolutionary", + "subj_History.Social_History", + "subj_History.United_States", + "subj_History.World", + "coll_1211", + "subj_House___Home.HH_General", + "subj_House___Home.Crocheting", + "subj_House___Home.Do-It-Yourself", + "subj_House___Home.Fruit", + "subj_House___Home.Furniture", + "subj_House___Home.Knitting", + "subj_House___Home.Models", + "subj_House___Home.Quilts___Quilting", + "subj_House___Home.Sustainable_Living", + "subj_House___Home.Woodwork", + "coll_1667", + "subj_Law.General", + "subj_Law.Criminal_Law", + "subj_Law.Emigration___Immigration", + "coll_1669", + "subj_Medical.General", + "subj_Medical.Cardiology", + "subj_Medical.Caregiving", + "subj_Medical.Family___General_Practice", + "subj_Medical.Neuroscience", + "subj_Medical.Nursing", + "subj_Medical.Practice_Management___Reimbursement", + "subj_Medical.Preventive_Medicine", + "coll_1615", + "subj_Fiction.Mystery___Detective.General", + "subj_Fiction.Mystery___Detective.Hard-Boiled", + "subj_Fiction.Mystery___Detective.Historical", + "subj_Fiction.Mystery___Detective.Police_Procedural", + "subj_Fiction.Mystery___Detective.Suspense", + "subj_Fiction.Mystery___Detective.Traditional_British", + "subj_Fiction.Mystery___Detective.True_Crime", + "subj_Fiction.Mystery___Detective.Women_Sleuths", + "coll_1214", + "subj_Family___Relationships.General", + "subj_Family___Relationships.Abuse", + "subj_Family___Relationships.Children_with_Special_Needs", + "subj_Family___Relationships.Conflict_Resolution", + "subj_Family___Relationships.Divorce___Separation", + "subj_Family___Relationships.Family_Relationships", + "subj_Family___Relationships.Interpersonal_Relations", + "subj_Family___Relationships.Life_Stages", + "subj_Family___Relationships.Love___Romance", + "subj_Family___Relationships.Marriage", + "subj_Family___Relationships.Parenting", + "coll_1215", + "subj_Political_Science.General", + "subj_Political_Science.Essays", + "subj_Political_Science.History___Theory", + "subj_Political_Science.International_Relations", + "subj_Political_Science.Political_Ideologies", + "subj_Political_Science.Political_Process", + "subj_Political_Science.Public_Affairs___Administration", + "subj_Political_Science.Public_Policy", + "coll_1217", + "subj_Religion.General", + "subj_Religion.Biblical_Commentary", + "subj_Religion.Biblical_Criticism___Interpretation", + "subj_Religion.Biblical_Reference", + "subj_Religion.Biblical_Studies", + "subj_Religion.Buddhism", + "subj_Religion.Christian_Church", + "subj_Religion.Christian_Education", + "subj_Religion.Christian_Life", + "subj_Religion.Christian_Ministry", + "subj_Religion.Christian_Rituals___Practice", + "subj_Religion.Christian_Theology", + "subj_Religion.Christianity", + "subj_Religion.Comparative_Religion", + "subj_Religion.Counseling", + "subj_Religion.Eastern", + "subj_Religion.Hinduism", + "subj_Religion.History", + "subj_Religion.Inspirational", + "subj_Religion.Judaism", + "subj_Religion.Philosophy", + "subj_Religion.Prayer", + "subj_Religion.Sikhism", + "subj_Religion.Spirituality", + "subj_Religion.Theology", + "coll_1218", + "subj_Fiction.Romance.General", + "subj_Fiction.Romance.Contemporary", + "subj_Fiction.Romance.Fantasy", + "subj_Fiction.Romance.Historical", + "subj_Fiction.Romance.Paranormal", + "subj_Fiction.Romance.Suspense", + "subj_Fiction.Romance.Time_Travel", + "subj_Fiction.Romance.Western", + "coll_1671", + "coll_1604", + "subj_Science_Fiction___Fantasy.SFF_General", + "subj_Science_Fiction___Fantasy.Contemporary", + "subj_Science_Fiction___Fantasy.Epic", + "subj_Science_Fiction___Fantasy.SFF_Historical", + "subj_Science_Fiction___Fantasy.Military", + "subj_Science_Fiction___Fantasy.Paranormal", + "subj_Science_Fiction___Fantasy.Space_Opera", + "coll_1222", + "subj_Sports___Recreation.General", + "subj_Sports___Recreation.Baseball", + "subj_Sports___Recreation.Basketball", + "subj_Sports___Recreation.Bodybuilding___Weight_Training", + "subj_Sports___Recreation.Coaching", + "subj_Sports___Recreation.Essays", + "subj_Sports___Recreation.Extreme_Sports", + "subj_Sports___Recreation.Fishing", + "subj_Sports___Recreation.Football", + "subj_Sports___Recreation.Golf", + "subj_Sports___Recreation.Hiking", + "subj_Sports___Recreation.History", + "coll_1673", + "coll_1224", + "subj_Travel.General", + "subj_Travel.Essays___Travelogues", + "subj_Travel.Europe", + "subj_Travel.Special_Interest", + "subj_Travel.United_States", + "coll_1672", + "audiobooks", + "audiobooks_coll_1665", + "audiobooks_subj_Arts___Entertainment.Celebrity_Bios", + "audiobooks_subj_Arts___Entertainment.Humor", + "audiobooks_subj_Arts___Entertainment.TV___Film", + "audiobooks_coll_1204", + "audiobooks_subj_Biographies___Memoirs.Artists__Writers____Musicians", + "audiobooks_subj_Biographies___Memoirs.Business_Leaders", + "audiobooks_subj_Biographies___Memoirs.Celebrities", + "audiobooks_subj_Biographies___Memoirs.Criminal", + "audiobooks_subj_Biographies___Memoirs.Personal_Memoirs", + "audiobooks_subj_Biographies___Memoirs.Political_Figures", + "audiobooks_subj_Biographies___Memoirs.Religious_Figures", + "audiobooks_subj_Biographies___Memoirs.Science___Technology_Leaders", + "audiobooks_coll_1205", + "audiobooks_subj_Business___Investing.Career_Skills", + "audiobooks_subj_Business___Investing.Commerce___Economy", + "audiobooks_subj_Business___Investing.Leadership", + "audiobooks_subj_Business___Investing.Management", + "audiobooks_subj_Business___Investing.Marketing", + "audiobooks_subj_Business___Investing.Personal_Finance___Investing", + "audiobooks_subj_Business___Investing.Sales", + "audiobooks_coll_1689", + "audiobooks_coll_1200", + "audiobooks_subj_Fiction___Literature.African_American", + "audiobooks_subj_Fiction___Literature.Classics", + "audiobooks_subj_Fiction___Literature.Historical", + "audiobooks_subj_Fiction___Literature.Horror", + "audiobooks_subj_Fiction___Literature.Humor", + "audiobooks_subj_Fiction___Literature.Literary", + "audiobooks_subj_Fiction___Literature.Media_Tie-In", + "audiobooks_subj_Fiction___Literature.Religion___Spirituality", + "audiobooks_subj_Fiction___Literature.Short_Stories___Anthologies", + "audiobooks_subj_Fiction___Literature.Western", + "audiobooks_coll_1605", + "audiobooks_subj_Health__Mind___Body.Alternative_Therapies", + "audiobooks_subj_Health__Mind___Body.Astrology", + "audiobooks_subj_Health__Mind___Body.Beauty___Grooming", + "audiobooks_subj_Health__Mind___Body.Creativity", + "audiobooks_subj_Health__Mind___Body.Exercise", + "audiobooks_subj_Health__Mind___Body.Healing", + "audiobooks_subj_Health__Mind___Body.Healthy_Living", + "audiobooks_subj_Health__Mind___Body.Spirituality", + "audiobooks_coll_1209", + "audiobooks_subj_History.20th_Century", + "audiobooks_subj_History.21st_Century", + "audiobooks_subj_History.American", + "audiobooks_subj_History.Ancient", + "audiobooks_subj_History.European", + "audiobooks_subj_History.Kids___Young_Adults", + "audiobooks_subj_History.Military", + "audiobooks_subj_History.World", + "audiobooks_coll_1676", + "audiobooks_subj_Language_Instruction.French", + "audiobooks_subj_Language_Instruction.German", + "audiobooks_subj_Language_Instruction.Italian", + "audiobooks_subj_Language_Instruction.Spanish", + "audiobooks_coll_1615", + "audiobooks_subj_Mystery___Thrillers.Cozy_Mysteries", + "audiobooks_subj_Mystery___Thrillers.Espionage", + "audiobooks_subj_Mystery___Thrillers.Historical", + "audiobooks_subj_Mystery___Thrillers.International_Mystery___Crime", + "audiobooks_subj_Mystery___Thrillers.Legal_Thrillers", + "audiobooks_subj_Mystery___Thrillers.Medical_Thrillers", + "audiobooks_subj_Mystery___Thrillers.Military", + "audiobooks_subj_Mystery___Thrillers.Noir", + "audiobooks_subj_Mystery___Thrillers.Police_Procedural", + "audiobooks_subj_Mystery___Thrillers.Political", + "audiobooks_subj_Mystery___Thrillers.Psychological", + "audiobooks_subj_Mystery___Thrillers.Suspense", + "audiobooks_subj_Mystery___Thrillers.True_Crime", + "audiobooks_coll_1217", + "audiobooks_subj_Religion___Spirituality.Buddhism___Eastern_Religions", + "audiobooks_subj_Religion___Spirituality.Christianity", + "audiobooks_subj_Religion___Spirituality.Islam", + "audiobooks_subj_Religion___Spirituality.Judaism", + "audiobooks_subj_Religion___Spirituality.Religious_Thought", + "audiobooks_subj_Religion___Spirituality.Sermons___Ministries", + "audiobooks_coll_1716", + "audiobooks_subj_Romance_US.Christian_Romance", + "audiobooks_subj_Romance_US.Contemporary", + "audiobooks_subj_Romance_US.Erotica", + "audiobooks_subj_Romance_US.Fantasy", + "audiobooks_subj_Romance_US.Historical", + "audiobooks_subj_Romance_US.LGBT", + "audiobooks_subj_Romance_US.Paranormal", + "audiobooks_subj_Romance_US.Regency", + "audiobooks_subj_Romance_US.Romantic_Comedy", + "audiobooks_subj_Romance_US.Science_Fiction___Fantasy", + "audiobooks_subj_Romance_US.Sports", + "audiobooks_subj_Romance_US.Suspense", + "audiobooks_subj_Romance_US.Western", + "audiobooks_subj_Romance_US.Young_Adult", + "audiobooks_coll_1219", + "audiobooks_subj_Science___Technology.Astronomy", + "audiobooks_subj_Science___Technology.Biology", + "audiobooks_subj_Science___Technology.Environment", + "audiobooks_subj_Science___Technology.Physics", + "audiobooks_coll_1604", + "audiobooks_subj_Science_Fiction___Fantasy.Alternate_History", + "audiobooks_subj_Science_Fiction___Fantasy.Contemporary", + "audiobooks_subj_Science_Fiction___Fantasy.Dark_Fantasy", + "audiobooks_subj_Science_Fiction___Fantasy.Fantasy__Epic", + "audiobooks_subj_Science_Fiction___Fantasy.Military_Sci-Fi", + "audiobooks_subj_Science_Fiction___Fantasy.Paranormal", + "audiobooks_subj_Science_Fiction___Fantasy.Post_Apocalyptic", + "audiobooks_subj_Science_Fiction___Fantasy.Short_Stories___Anthologies", + "audiobooks_subj_Science_Fiction___Fantasy.Space_Opera", + "audiobooks_subj_Science_Fiction___Fantasy.Steampunk", + "audiobooks_subj_Science_Fiction___Fantasy.Superheroes", + "audiobooks_subj_Science_Fiction___Fantasy.Time_Travel", + "audiobooks_coll_1545", + "audiobooks_subj_Self-Help.Communication_Skills", + "audiobooks_subj_Self-Help.How-To", + "audiobooks_subj_Self-Help.Hypnosis", + "audiobooks_subj_Self-Help.Meditation", + "audiobooks_subj_Self-Help.Motivation___Inspiration", + "audiobooks_subj_Self-Help.Parenting", + "audiobooks_subj_Self-Help.Personal_Finance", + "audiobooks_subj_Self-Help.Relationships", + "audiobooks_subj_Self-Help.Sexuality", + "audiobooks_coll_1222", + "audiobooks_subj_Sports.Baseball", + "audiobooks_subj_Sports.Basketball", + "audiobooks_subj_Sports.Football", + "audiobooks_subj_Sports.Golf", + "audiobooks_coll_1224", + "audiobooks_subj_Travel.Adventure___Exploration", + "audiobooks_subj_Travel.Essays___Travelogues", + "audiobooks_subj_Travel.Guided_Tours", + "audiobooks_coll_1672", + "audiobooks_subj_Young_Adult.Family___Relationships", + "audiobooks_subj_Young_Adult.Health___Sports", + "audiobooks_subj_Young_Adult.History___Historical_Fiction", + "audiobooks_subj_Young_Adult.Mystery___Thrillers", + "audiobooks_subj_Young_Adult.Myths___Legends", + "audiobooks_subj_Young_Adult.Religion___Spirituality", + "audiobooks_subj_Young_Adult.Romance___Friendship", + "audiobooks_subj_Young_Adult.Science_Fiction___Fantasy", + "audiobooks_subj_Young_Adult.Social_Issues", + "coll_1401", + "subj_Comics___Graphic_Novels.General", + "subj_Comics___Graphic_Novels.Crime___Mystery", + "subj_Comics___Graphic_Novels.Fantasy", + "subj_Comics___Graphic_Novels.Horror", + "subj_Comics___Graphic_Novels.Literary", + "subj_Comics___Graphic_Novels.Manga", + "subj_Comics___Graphic_Novels.Media_Tie-In", + "subj_Comics___Graphic_Novels.Science_Fiction", + "subj_Comics___Graphic_Novels.Superheroes", + "coll_1689", + "coll_1690", + "coll_1691", + "coll_1693", + "coll_1692", + "coll_1694", + "coll_1696", + "coll_1698", + "coll_1699", + "coll_1702", + "coll_1704", + "coll_1705" + ], + "description": "Parameter defines the books store category. Head to the Google Play store Books Categories for a full list of supported Google Play Books store categories.", + "group": "google_play_categories" + }, + "price": { + "type": "select", + "options": [ + [ + "1", + "Free" + ], + [ + "2", + "Paid" + ] + ], + "description": "Parameter is used for sorting items by price. It should be used only in combination with the q parameter. It can be set to: `1` - Free `2` - Paid", + "group": "advanced_google_play_parameters" + }, + "age": { + "type": "select", + "options": [ + "AGE_RANGE1", + "AGE_RANGE2", + "AGE_RANGE3" + ], + "description": "Parameter defines age subcategory. age works, and should only be used with `books_category=coll_1689` (Children's books) It can be set to: `AGE_RANGE1` - Ages up to 5 `AGE_RANGE2` - Ages 6-8 `AGE_RANGE3` - Ages 9-12 The default value for age is: - All ages up to 12", + "group": "advanced_google_play_parameters" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results. It shouldn't be used with the section_page_token, see_more_token, and chart parameters.", + "group": "pagination" + }, + "section_page_token": { + "description": "Parameter defines the section page token used for retrieving the pagination results from individual sections. This parameter is a safer version of see_more_token, and is found in every row you can paginate into. It shouldn't be used with the next_page_token, see_more_token, and chart parameters", + "group": "pagination" + }, + "chart": { + "description": "Parameter is used for showing top charts. It can return up to `50` results. Each store contains different charts which require different values for retrieving results. To get the value of a specific chart you can use our Google Play Books Store API JSON output: `chart_options[index].value` (e.g. `chart=topselling_free`). It shouldn't be used with the section_page_token, see_more_token, and next_page_token parameters", + "group": "pagination" + }, + "see_more_token": { + "description": "Parameter defines the see more token used for retrieving the pagination results from individual sections It is usually found in next page results. It shouldn't be used with the section_page_token, next_page_token, and chart, parameters", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_play_books` to use the Google Play Books API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Play Books results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_play_games.json b/engines/google_play_games.json new file mode 100644 index 0000000..9b42eb5 --- /dev/null +++ b/engines/google_play_games.json @@ -0,0 +1,511 @@ +{ + "engine": "google_play_games", + "params": { + "q": { + "description": "Parameter defines the query you want to search in Google Play Games Store.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Play search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). You can find the full list of Google Play country availability here: Google Play Countries. Afterwards, head to the Google countries page page for a two-letter country code.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Play search. It's a two-letter language code. (e.g., `en` (default) for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "games_category": { + "type": "select", + "options": [ + "GAME", + "GAME_ACTION", + "GAME_ADVENTURE", + "GAME_ARCADE", + "GAME_BOARD", + "GAME_CARD", + "GAME_CASINO", + "GAME_CASUAL", + "GAME_EDUCATIONAL", + "GAME_MUSIC", + "GAME_PUZZLE", + "GAME_RACING", + "GAME_ROLE_PLAYING", + "GAME_SIMULATION", + "GAME_SPORTS", + "GAME_STRATEGY", + "GAME_TRIVIA", + "GAME_WORD" + ], + "description": "Parameter defines the games store category. Head to the Google Play store Games Categories for a full list of supported Google Play Games store categories.", + "group": "google_play_categories" + }, + "store_device": { + "type": "select", + "options": [ + "phone", + "windows", + "tablet", + "tv", + "chromebook", + "watch" + ], + "description": "Parameter defines the device for sorting results. This parameter cannot be used with games_category or q parameters. Available options: `phone` - Phone device (default) `windows` - Windows device `tablet` - Tablet device `tv` - TV device `chromebook` - Chromebook device `watch` - Watch device", + "group": "advanced_google_play_parameters" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results. It shouldn't be used with the section_page_token, see_more_token, and chart parameters.", + "group": "pagination" + }, + "section_page_token": { + "description": "Parameter defines the section page token used for retrieving the pagination results from individual sections. This parameter is a safer version of see_more_token, and is found in every row you can paginate into. It shouldn't be used with the next_page_token, see_more_token, and chart parameters", + "group": "pagination" + }, + "chart": { + "description": "Parameter is used for showing top charts. It can return up to `50` results. Each store contains different charts which require different values for retrieving results. To get the value of a specific chart you can use our Google Play Games Store API JSON output: `chart_options[index].value` (e.g. `chart=topselling_free`). It shouldn't be used with the section_page_token, see_more_token, and next_page_token parameters", + "group": "pagination" + }, + "see_more_token": { + "description": "Parameter defines the see more token used for retrieving the pagination results from individual sections It is usually found in next page results. It shouldn't be used with the section_page_token, next_page_token, and chart, parameters", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_play_games` to use the Google Play Games API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Play Games results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_play_movies.json b/engines/google_play_movies.json new file mode 100644 index 0000000..037cc24 --- /dev/null +++ b/engines/google_play_movies.json @@ -0,0 +1,645 @@ +{ + "engine": "google_play_movies", + "params": { + "q": { + "description": "Parameter defines the query you want to search in Google Play Movies Store.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Play search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). You can find the full list of Google Play country availability here: Google Play Countries. Afterwards, head to the Google countries page for a two-letter country code.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Play search. It's a two-letter language code. (e.g., `en` (default) for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "movies_category": { + "type": "select", + "options": [ + "MOVIE", + [ + "1", + "Movies - Action & adventure" + ], + [ + "2", + "Movies - Animation" + ], + [ + "40", + "Movies - Anime" + ], + [ + "3", + "Movies - Classics" + ], + [ + "4", + "Movies - Comedy" + ], + [ + "5", + "Movies - Crime" + ], + [ + "7", + "Movies - Documentary" + ], + [ + "6", + "Movies - Drama" + ], + [ + "8", + "Movies - Family" + ], + [ + "27", + "Movies - Independent" + ], + [ + "18", + "Movies - Indian cinema" + ], + [ + "25", + "Movies - Music" + ], + [ + "11", + "Movies - Mystery & suspense" + ], + [ + "12", + "Movies - Romance" + ], + [ + "13", + "Movies - Sci-fi & fantasy" + ], + [ + "26", + "Movies - Short films" + ], + [ + "15", + "Movies - Sports" + ], + [ + "36", + "Movies - Thriller" + ], + [ + "9", + "Movies - World cinema" + ], + "TV", + [ + "1001", + "TV - Action & adventure" + ], + [ + "1002", + "TV - Animation" + ], + [ + "1030", + "TV - Anime" + ], + [ + "1004", + "TV - Comedy" + ], + [ + "1017", + "TV - Documentary" + ], + [ + "1005", + "TV - Drama" + ], + [ + "1029", + "TV - Family" + ], + [ + "1025", + "TV - Health & fitness" + ], + [ + "1026", + "TV - Learning & education" + ], + [ + "1008", + "TV - Reality & game shows" + ], + [ + "1013", + "TV - Sports" + ], + "FAMILY", + [ + "3001", + "Family - TV" + ], + [ + "2001", + "Family - Action & adventure" + ], + [ + "2002", + "Family - Animation" + ], + [ + "2003", + "Family - Classics" + ], + [ + "2004", + "Family - Comedy" + ], + [ + "2007", + "Family - Education" + ], + [ + "2005", + "Family - Music" + ], + [ + "2006", + "Family - Sci-fi & fantasy" + ] + ], + "description": "Parameter defines the movies store category. Head to the Google Play store Movies Categories for a full list of supported Google Play Books store categories.", + "group": "google_play_categories" + }, + "age": { + "type": "select", + "options": [ + "AGE_RANGE1", + "AGE_RANGE2", + "AGE_RANGE3" + ], + "description": "Parameter defines age subcategory. age works, and should only be used with `movies_category=FAMILY` (Family Movies) It can be set to: `AGE_RANGE1` - Ages up to 5 `AGE_RANGE2` - Ages 6-8 `AGE_RANGE3` - Ages 9-12 The default value for age is: - All ages up to 12", + "group": "advanced_google_play_parameters" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results. It shouldn't be used with the section_page_token, see_more_token, and chart parameters.", + "group": "pagination" + }, + "section_page_token": { + "description": "Parameter defines the section page token used for retrieving the pagination results from individual sections. This parameter is a safer version of see_more_token, and is found in every row you can paginate into. It shouldn't be used with the next_page_token, see_more_token, and chart parameters", + "group": "pagination" + }, + "chart": { + "description": "Parameter is used for showing top charts. It can return up to `50` results. Each store contains different charts which require different values for retrieving results. To get the value of a specific chart you can use our Google Play Movies Store API JSON output: `chart_options[index].value` (e.g. `chart=topselling_free`). It shouldn't be used with the section_page_token, see_more_token, and next_page_token parameters", + "group": "pagination" + }, + "see_more_token": { + "description": "Parameter defines the see more token used for retrieving the pagination results from individual sections It is usually found in next page results. It shouldn't be used with the section_page_token, next_page_token, and chart, parameters", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_play_movies` to use the Google Play Movies API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Play Movies results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_play_product.json b/engines/google_play_product.json new file mode 100644 index 0000000..aa1cc05 --- /dev/null +++ b/engines/google_play_product.json @@ -0,0 +1,548 @@ +{ + "engine": "google_play_product", + "params": { + "product_id": { + "required": true, + "description": "Parameter defines the ID of a product you want to get the results for.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Play search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). You can find the full list of Google Play country availability here: Google Play Countries. Afterwards, head to the Google countries page page for a two-letter country code.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Play search. It's a two-letter language code. (e.g., `en` (default) for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "store": { + "type": "select", + "options": [ + "apps", + "movies", + "tv", + "books", + "audiobooks" + ], + "required": true, + "description": "Parameter defines the type of Google Play store. There are five types in total: `apps` (default), `movies`, `tv`, `books` and `audiobooks` store.", + "group": "google_play_categories" + }, + "season_id": { + "description": "Parameter defines the ID of a season you want to get the results for. It should be used only when store parameter is set to `tv`. e.g. `store=tv`.", + "group": "tv_store_parameters" + }, + "all_reviews": { + "type": "checkbox", + "description": "Parameter is used for retrieving all reviews of a product. It can be set to `true` or `false` (default).", + "group": "reviews_parameters" + }, + "platform": { + "type": "select", + "options": [ + "phone", + "tablet", + "watch", + "chromebook", + "tv", + "car" + ], + "description": "Parameter is used for filtering reviews by platform. It can be set to: `phone`: Phone (default), `tablet`: Tablet, `watch`: Watch, `chromebook`: Chromebook, `tv`: TV. It should be used only when all_reviews parameter is set to `true`.", + "group": "reviews_parameters" + }, + "rating": { + "type": "select", + "options": [ + [ + "1", + "1-star" + ], + [ + "2", + "2-star" + ], + [ + "3", + "3-star" + ], + [ + "4", + "4-star" + ], + [ + "5", + "5-star" + ] + ], + "description": "Parameter is used for filtering reviews by rating. It can be set to: `1`: 1-star, `2`: 2-star, `3`: 3-star, `4`: 4-star, `5`: 5-star. It should be used only when all_reviews parameter is set to `true`.", + "group": "reviews_parameters" + }, + "sort_by": { + "type": "select", + "options": [ + [ + "1", + "Most relevant" + ], + [ + "2", + "Newest" + ], + [ + "3", + "Rating" + ] + ], + "description": "Parameter is used for sorting reviews by relevance. It can be set to: `1`: Most relevant (default), `2`: Newest, `3`: Rating. It should be used only when all_reviews parameter is set to `true`.", + "group": "reviews_parameters" + }, + "num": { + "type": "number", + "description": "Parameter defines the maximum number of reviews to return. (e.g., `40` (default) returns 40 reviews, `80` returns 80 reviews, and `100` returns 100 reviews). Maximum number of reviews you can return per search is `199`. It should be used only when all_reviews parameter is set to `true`.", + "group": "reviews_parameters" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results. It should be used only when all_reviews parameter is set to `true`.", + "group": "reviews_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_play_product` to use the Google Play Product API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Play Product results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_related_questions.json b/engines/google_related_questions.json new file mode 100644 index 0000000..f73d8dc --- /dev/null +++ b/engines/google_related_questions.json @@ -0,0 +1,43 @@ +{ + "engine": "google_related_questions", + "params": { + "next_page_token": { + "required": true, + "description": "Parameter defines the token needed to show the additional related questions that Google generates when a specific question gets clicked. This token can be found in the Related Questions block returned in a regular Google Search API response.", + "group": "search_query" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_related_questions` to use the Google Related Questions API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Related Questions results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_reverse_image.json b/engines/google_reverse_image.json new file mode 100644 index 0000000..0ab38cb --- /dev/null +++ b/engines/google_reverse_image.json @@ -0,0 +1,696 @@ +{ + "engine": "google_reverse_image", + "params": { + "q": { + "required": false, + "description": "Parameter defines the query you want to search. You can also include location in a query as location parameter doesn't work for this kind of search.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Reverse Image search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "lr": { + "description": "Parameter defines one or multiple languages to limit the search to. It uses `lang_{two-letter language code}` to specify languages and `|` as a delimiter. (e.g., `lang_fr|lang_de` will only search French and German pages).", + "group": "localization" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "image_url": { + "required": true, + "description": "Parameter defines URL for an image to perform reverse search.", + "group": "advanced_reverse_image_parameters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "tbs": { + "description": "(to be searched) parameter defines advanced search parameters that aren't possible in the regular query field. (e.g., advanced search for dates, size, etc.).", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_reverse_image` to use the Google Reverse Image API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Reverse Image results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_scholar.json b/engines/google_scholar.json new file mode 100644 index 0000000..26e5175 --- /dev/null +++ b/engines/google_scholar.json @@ -0,0 +1,282 @@ +{ + "engine": "google_scholar", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can also use helpers in your query such as: `author:`, or `source:`. Usage of `cites` parameter makes `q` optional. Usage of `cites` together with `q` triggers search within citing articles. Usage of `cluster` together with `q` and `cites` parameters is prohibited. Use `cluster` parameter only.", + "group": "search_query" + }, + "cites": { + "description": "Parameter defines unique ID for an article to trigger Cited By searches. Usage of `cites` will bring up a list of citing documents in Google Scholar. Example value: `cites=1275980731835430123`. Usage of `cites` and `q` parameters triggers search within citing articles.", + "group": "advanced_google_scholar_parameters" + }, + "as_ylo": { + "type": "number", + "description": "Parameter defines the year from which you want the results to be included. (e.g. if you set as_ylo parameter to the year `2018`, the results before that year will be omitted.). This parameter can be combined with the as_yhi parameter.", + "group": "advanced_google_scholar_parameters" + }, + "as_yhi": { + "type": "number", + "description": "Parameter defines the year until which you want the results to be included. (e.g. if you set as_yhi parameter to the year `2018`, the results after that year will be omitted.). This parameter can be combined with the as_ylo parameter.", + "group": "advanced_google_scholar_parameters" + }, + "scisbd": { + "type": "select", + "options": [ + [ + 1, + "Abstracts" + ], + [ + 2, + "Everything" + ] + ], + "description": "Parameter defines articles added in the last year, sorted by date. It can be set to `1` to include only abstracts, or `2` to include everything. The default value is `0` which means that the articles are sorted by relevance.", + "group": "advanced_google_scholar_parameters" + }, + "cluster": { + "description": "Parameter defines unique ID for an article to trigger All Versions searches. Example value: `cluster=1275980731835430123`. Usage of `cluster` together with `q` and `cites` parameters is prohibited. Use `cluster` parameter only.", + "group": "advanced_google_scholar_parameters" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Scholar search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "lr": { + "description": "Parameter defines one or multiple languages to limit the search to. It uses `lang_{two-letter language code}` to specify languages and `|` as a delimiter. (e.g., `lang_fr|lang_de` will only search French and German pages). Head to the Google lr languages for a full list of supported languages.", + "group": "localization" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "num": { + "type": "number", + "description": "Parameter defines the maximum number of results to return, ranging from `1` to `20`, with a default of `10`.", + "group": "pagination" + }, + "as_sdt": { + "description": "Parameter can be used either as a search type or a filter. As a Filter (only works when searching articles): `0` - exclude patents (default). `7` - include patents. As a Search Type: `4` - Select case law (US courts only). This will select all the State and Federal courts. e.g. `as_sdt=4` - Selects case law (all courts) To select specific courts, see the full list of supported Google Scholar courts. e.g. `as_sdt=4,33,192` - `4` is the required value and should always be in the first position, `33` selects all New York courts and `192` selects Tax Court. Values have to be separated by comma (`,`)", + "group": "search_type" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + }, + "as_vis": { + "type": "checkbox", + "description": "Parameter defines whether you would like to include citations or not. It can be set to `1` to exclude these results, or `0` (default) to include them.", + "group": "advanced_filters" + }, + "as_rr": { + "type": "checkbox", + "description": "Parameter defines whether you would like to show only review articles or not (these articles consist of topic reviews, or discuss the works or authors you have searched for). It can be set to `1` to enable this filter, or `0` (default) to show all results.", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_scholar` to use the Google Scholar API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Scholar results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_scholar_author.json b/engines/google_scholar_author.json new file mode 100644 index 0000000..c27eec1 --- /dev/null +++ b/engines/google_scholar_author.json @@ -0,0 +1,239 @@ +{ + "engine": "google_scholar_author", + "params": { + "author_id": { + "required": true, + "description": "Parameter defines the ID of an author. You can find the ID either by using our Google Scholar Profiles API or by going to the Google Scholar user profile page and getting it from there (e.g., `https://scholar.google.com/citations?user={author_id}`).", + "group": "search_query" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Scholar Author search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "view_op": { + "type": "select", + "options": [ + "view_citation", + "list_colleagues" + ], + "description": "Parameter is used for viewing specific parts of a page. It has two options: `view_citation` - Select to view citations. citation_id is required. `list_colleagues` - Select to view all co-authors", + "group": "advanced_google_scholar_author_parameters" + }, + "sort": { + "type": "select", + "options": [ + "title", + "pubdate" + ], + "description": "Parameter is used for sorting and refining articles. Available options: `title` - Sorts articles by \"Title\". `pubdate` - Sorts articles by publish \"date\". By default, articles are sorted by the number of citations.", + "group": "advanced_google_scholar_author_parameters" + }, + "citation_id": { + "description": "Parameter is used for retrieving individual article citation. It is a required parameter when `view_op=view_citation` is selected. You can access IDs inside our structured JSON response.", + "group": "advanced_google_scholar_author_parameters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `20` is the 2nd page of results, `40` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "num": { + "type": "number", + "description": "Parameter defines the number of results to return. (e.g., `20` (default) returns 20 results, `40` returns 40 results, etc.). Maximum number of results to return is `100`.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_scholar_author` to use the Google Scholar Author API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Scholar Author results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_scholar_cite.json b/engines/google_scholar_cite.json new file mode 100644 index 0000000..8010888 --- /dev/null +++ b/engines/google_scholar_cite.json @@ -0,0 +1,207 @@ +{ + "engine": "google_scholar_cite", + "params": { + "q": { + "required": true, + "description": "Parameter defines the ID of an individual Google Scholar organic search result. You can find the ID inside the `result_id` by using our Google Scholar API.", + "group": "search_query" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Scholar Cite. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_scholar_cite` to use the Google Scholar Cite API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Scholar Cite results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_shopping.json b/engines/google_shopping.json new file mode 100644 index 0000000..18f2299 --- /dev/null +++ b/engines/google_shopping.json @@ -0,0 +1,592 @@ +{ + "engine": "google_shopping", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Shopping search.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "ai", + "ar", + "aw", + "au", + "at", + "be", + "bm", + "br", + "io", + "ca", + "ky", + "cl", + "cx", + "cc", + "co", + "cz", + "dk", + "fk", + "fi", + "fr", + "gf", + "pf", + "tf", + "de", + "gr", + "gp", + "hm", + "hk", + "hu", + "in", + "id", + "ie", + "il", + "it", + "jp", + "kr", + "my", + "mq", + "yt", + "mx", + "ms", + "nl", + "nc", + "nz", + "nf", + "no", + "ph", + "pl", + "pt", + "re", + "ro", + "ru", + "pm", + "sa", + "sg", + "sk", + "za", + "gs", + "es", + "se", + "ch", + "tw", + "th", + "tk", + "tr", + "tc", + "ua", + "ae", + "uk", + "gb", + "us", + "vn", + "vg", + "wf" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google Shopping countries for a full list of supported Google Shopping countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Shopping search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French) Head to the Google languages for a full list of supported Google languages.", + "group": "localization" + }, + "as_dt": { + "description": "Parameter controls whether to include or exclude results from the site named in the as_sitesearch parameter.", + "group": "advanced_search_query_parameters" + }, + "as_epq": { + "description": "Parameter identifies a phrase that all documents in the search results must contain. You can also use the phrase search query term to search for a phrase.", + "group": "advanced_search_query_parameters" + }, + "as_eq": { + "description": "Parameter identifies a word or phrase that should not appear in any documents in the search results. You can also use the exclude query term to ensure that a particular word or phrase will not appear in the documents in a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_lq": { + "description": "Parameter specifies that all search results should contain a link to a particular URL. You can also use the link: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_nlo": { + "description": "Parameter specifies the starting value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_nhi": { + "description": "Parameter specifies the ending value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_oq": { + "description": "Parameter provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_q": { + "description": "Parameter provides search terms to check for in a document. This parameter is also commonly used to allow users to specify additional terms to search for within a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_qdr": { + "description": "Parameter requests search results from a specified time period (quick date range). The following values are supported: `d[number]`: requests results from the specified number of past days. Example for the past 10 days: `as_qdr=d10` `w[number]`: requests results from the specified number of past weeks. `m[number]`: requests results from the specified number of past months. `y[number]`: requests results from the specified number of past years. Example for the past year: `as_qdr=y`", + "group": "advanced_search_query_parameters" + }, + "as_rq": { + "description": "Parameter specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. You can also use the related: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_sitesearch": { + "description": "Parameter allows you to specify that all search results should be pages from a given site. By setting the as_dt parameter, you can also use it to exclude pages from a given site from your search results.", + "group": "advanced_search_query_parameters" + }, + "shoprs": { + "description": "The parameter defines the token that includes metadata about query and search filter(s). Providing q parameter alongside the shoprs is not required. To apply multiple filters join them with `||` separator, e.g. `shoprs_1||shoprs_2||shoprs_3`.", + "group": "advanced_filters" + }, + "min_price": { + "type": "number", + "description": "Lower bound of price range query. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "max_price": { + "type": "number", + "description": "Upper bound of price range query. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "sort_by": { + "type": "select", + "options": [ + [ + "1", + "Price: low to high" + ], + [ + "2", + "Price: high to low" + ] + ], + "description": "Parameter defines the sorting order of the results. Available options: `1` - Price: low to high `2` - Price: high to low This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "free_shipping": { + "type": "checkbox", + "description": "Show only products with free shipping. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "on_sale": { + "type": "checkbox", + "description": "Show only products that are on sale. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "small_business": { + "type": "checkbox", + "description": "Show only products from small business. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `60` is the 2nd page of results, `120` is the 3rd page of results, etc.). For the new layout, the parameter is not recommended. To easily retrieve paginated results accurately, it is advisable to follow the link provided in `serpapi_pagination.next`.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_shopping` to use the Google Shopping API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Shopping results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_shopping_filters.json b/engines/google_shopping_filters.json new file mode 100644 index 0000000..401f0c0 --- /dev/null +++ b/engines/google_shopping_filters.json @@ -0,0 +1,493 @@ +{ + "engine": "google_shopping_filters", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Shopping search.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "ai", + "ar", + "aw", + "au", + "at", + "be", + "bm", + "br", + "io", + "ca", + "ky", + "cl", + "cx", + "cc", + "co", + "cz", + "dk", + "fk", + "fi", + "fr", + "gf", + "pf", + "tf", + "de", + "gr", + "gp", + "hm", + "hk", + "hu", + "in", + "id", + "ie", + "il", + "it", + "jp", + "kr", + "my", + "mq", + "yt", + "mx", + "ms", + "nl", + "nc", + "nz", + "nf", + "no", + "ph", + "pl", + "pt", + "re", + "ro", + "ru", + "pm", + "sa", + "sg", + "sk", + "za", + "gs", + "es", + "se", + "ch", + "tw", + "th", + "tk", + "tr", + "tc", + "ua", + "ae", + "uk", + "gb", + "us", + "vn", + "vg", + "wf" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Shopping search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French) Head to the Google languages for a full list of supported Google languages.", + "group": "localization" + }, + "shoprs": { + "description": "The parameter defines the token that includes metadata about query and search filter(s).", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_shopping_filters` to use the Google Shopping Filters API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Shopping Filters results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_shopping_light.json b/engines/google_shopping_light.json new file mode 100644 index 0000000..a49ad9d --- /dev/null +++ b/engines/google_shopping_light.json @@ -0,0 +1,548 @@ +{ + "engine": "google_shopping_light", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Shopping search.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "ai", + "ar", + "aw", + "au", + "at", + "be", + "bm", + "br", + "io", + "ca", + "ky", + "cl", + "cx", + "cc", + "co", + "cz", + "dk", + "fk", + "fi", + "fr", + "gf", + "pf", + "tf", + "de", + "gr", + "gp", + "hm", + "hk", + "hu", + "in", + "id", + "ie", + "il", + "it", + "jp", + "kr", + "my", + "mq", + "yt", + "mx", + "ms", + "nl", + "nc", + "nz", + "nf", + "no", + "ph", + "pl", + "pt", + "re", + "ro", + "ru", + "pm", + "sa", + "sg", + "sk", + "za", + "gs", + "es", + "se", + "ch", + "tw", + "th", + "tk", + "tr", + "tc", + "ua", + "ae", + "uk", + "gb", + "us", + "vn", + "vg", + "wf" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google Shopping countries for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Shopping search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French) Head to the Google languages for a full list of supported Google languages.", + "group": "localization" + }, + "shoprs": { + "description": "The parameter defines the token that includes metadata about query and search filter(s). Providing q parameter alongside the shoprs is not required. To apply multiple filters join them with `||` separator, e.g. `shoprs_1||shoprs_2||shoprs_3`. Values for this parameter are not available through the Google Shopping Light API. You can use our Google Shopping API to retrieve the values, or you can visit the Google Shopping website directly, set filters you want and simply copy shoprs value from their URL to SerpApi URL.", + "group": "advanced_filters" + }, + "min_price": { + "type": "number", + "description": "Lower bound of price range query. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "max_price": { + "type": "number", + "description": "Upper bound of price range query. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "sort_by": { + "type": "select", + "options": [ + [ + "1", + "Price: low to high" + ], + [ + "2", + "Price: high to low" + ] + ], + "description": "Parameter defines the sorting order of the results. Available options: `1` - Price: low to high `2` - Price: high to low This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "free_shipping": { + "type": "checkbox", + "description": "Show only products with free shipping. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "on_sale": { + "type": "checkbox", + "description": "Show only products that are on sale. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "small_business": { + "type": "checkbox", + "description": "Show only products from small business. This parameter overrides corresponding filter embedded into shoprs parameter.", + "group": "advanced_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_shopping_light` to use the Google Shopping Light API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Shopping Light results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_short_videos.json b/engines/google_short_videos.json new file mode 100644 index 0000000..56bc6c9 --- /dev/null +++ b/engines/google_short_videos.json @@ -0,0 +1,745 @@ +{ + "engine": "google_short_videos", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Short Videos search. e.g. `inurl:`, `site:`, `intitle:`. We also support advanced search query parameters such as as_dt and as_eq. See the full list of supported advanced search query parameters.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "lr": { + "description": "Parameter defines one or multiple languages to limit the search to. It uses `lang_{two-letter language code}` to specify languages and `|` as a delimiter. (e.g., `lang_fr|lang_de` will only search French and German pages). Head to the Google lr languages page for a full list of supported languages.", + "group": "localization" + }, + "as_dt": { + "description": "Parameter controls whether to include or exclude results from the site named in the as_sitesearch parameter.", + "group": "advanced_search_query_parameters" + }, + "as_epq": { + "description": "Parameter identifies a phrase that all documents in the search results must contain. You can also use the phrase search query term to search for a phrase.", + "group": "advanced_search_query_parameters" + }, + "as_eq": { + "description": "Parameter identifies a word or phrase that should not appear in any documents in the search results. You can also use the exclude query term to ensure that a particular word or phrase will not appear in the documents in a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_lq": { + "description": "Parameter specifies that all search results should contain a link to a particular URL. You can also use the link: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_nlo": { + "description": "Parameter specifies the starting value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_nhi": { + "description": "Parameter specifies the ending value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_oq": { + "description": "Parameter provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_q": { + "description": "Parameter provides search terms to check for in a document. This parameter is also commonly used to allow users to specify additional terms to search for within a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_qdr": { + "description": "Parameter requests search results from a specified time period (quick date range). The following values are supported: `d[number]`: requests results from the specified number of past days. Example for the past 10 days: `as_qdr=d10` `w[number]`: requests results from the specified number of past weeks. `m[number]`: requests results from the specified number of past months. `y[number]`: requests results from the specified number of past years. Example for the past year: `as_qdr=y`", + "group": "advanced_search_query_parameters" + }, + "as_rq": { + "description": "Parameter specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. You can also use the related: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_sitesearch": { + "description": "Parameter allows you to specify that all search results should be pages from a given site. By setting the as_dt parameter, you can also use it to exclude pages from a given site from your search results.", + "group": "advanced_search_query_parameters" + }, + "tbs": { + "description": "(to be searched) parameter defines advanced search parameters that aren't possible in the regular query field. (e.g., advanced search for patents, dates, news, videos, images, apps, or text contents).", + "group": "advanced_filters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "nfpr": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude these results, or `0` to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `12` (desktop) or `8` (mobile) is the 2nd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_short_videos` to use the Google Short Videos API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Short Videos results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_travel_explore.json b/engines/google_travel_explore.json new file mode 100644 index 0000000..3f5524e --- /dev/null +++ b/engines/google_travel_explore.json @@ -0,0 +1,705 @@ +{ + "engine": "google_travel_explore", + "params": { + "departure_id": { + "description": "Parameter defines the departure airport code or city location kgmid. An airport code is an uppercase 3-letter code. You can search for it on Google Flights or IATA. For example, `CDG` is Paris Charles de Gaulle Airport and `AUS` is Austin-Bergstrom International Airport. A location kgmid is a string that starts with `/m/`. You can search for a location on Wikidata and use its \"Freebase ID\" as the location kgmid. For example, `/m/0vzm` is the location kgmid for Austin, TX. You can specify multiple departure airports by separating them with a comma. For example, `CDG,ORY,/m/04jpl`.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google Travel Explore search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Travel Explore search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "currency": { + "type": "select", + "options": [ + "ALL", + "DZD", + "ARS", + "AMD", + "AWG", + "AUD", + "AZN", + "BSD", + "BHD", + "BYN", + "BMD", + "BAM", + "BRL", + "GBP", + "BGN", + "XPF", + "CAD", + "CLP", + "CNY", + "COP", + "CRC", + "CUP", + "CZK", + "DKK", + "DOP", + "EGP", + "EUR", + "GEL", + "HKD", + "HUF", + "ISK", + "INR", + "IDR", + "IRR", + "ILS", + "JMD", + "JPY", + "JOD", + "KZT", + "KWD", + "LBP", + "MKD", + "MYR", + "MXN", + "MDL", + "MAD", + "TWD", + "NZD", + "NOK", + "OMR", + "PKR", + "PAB", + "PEN", + "PHP", + "PLN", + "QAR", + "RON", + "RUB", + "SAR", + "RSD", + "SGD", + "ZAR", + "KRW", + "SEK", + "CHF", + "THB", + "TRY", + "USD", + "UAH", + "AED", + "VND" + ], + "description": "Parameter defines the currency of the returned prices. Default to `USD`. Head to the Google Travel Currencies page for a full list of supported currency codes.", + "group": "localization" + }, + "arrival_area_id": { + "description": "Parameter defines the arrival region or country as a location kgmid. A location kgmid is a string that starts with `/m/`. You can search for a region or country on Wikidata and use its \"Freebase ID\" as the location kgmid. For example, `/m/02j9z` is the location kgmid for Europe, and `/m/0f8l9c` is the location kgmid for France. This parameter is used when exploring flights to broader areas (regions or countries) rather than specific cities or airports.", + "group": "advanced_google_travel_explore_parameters" + }, + "arrival_id": { + "description": "Parameter defines the arrival airport code or city location kgmid. An airport code is an uppercase 3-letter code. You can search for it on Google Flights or IATA. For example, `CDG` is Paris Charles de Gaulle Airport and `AUS` is Austin-Bergstrom International Airport. A location kgmid is a string that starts with `/m/`. You can search for a location on Wikidata and use its \"Freebase ID\" as the location kgmid. For example, `/m/0vzm` is the location kgmid for Austin, TX.", + "group": "advanced_google_travel_explore_parameters" + }, + "type": { + "type": "select", + "options": [ + [ + "1", + "Round trip (default) - 1" + ], + [ + "2", + "One way - 2" + ] + ], + "description": "Parameter defines the type of the flights. Available options: `1` - Round trip (default) `2` - One way When this parameter is set to `3`, use multi_city_json to set the flight information.", + "group": "advanced_google_travel_explore_parameters" + }, + "outbound_date": { + "description": "Parameter defines the outbound date. The format is YYYY-MM-DD. e.g. `2026-01-04`", + "group": "advanced_google_travel_explore_parameters" + }, + "return_date": { + "description": "Parameter defines the return date. The format is YYYY-MM-DD. e.g. `2026-01-10` Parameter is required if type parameter is set to: `1` (Round trip)", + "group": "advanced_google_travel_explore_parameters" + }, + "month": { + "description": "Parameter defines the month of the trip with flexible travel dates. The value must be a number from `1` to `12`, where `1` = January, `2` = February, \u2026, `12` = December. `0` (default) means all months within the next 6 months are considered. Only the next 6 months from the current date are available for selection.", + "group": "advanced_google_travel_explore_parameters" + }, + "travel_duration": { + "type": "select", + "options": [ + [ + 1, + "Weekend - 1" + ], + [ + 2, + "1 week (default) - 2" + ], + [ + 3, + "2 weeks - 3" + ] + ], + "description": "Parameter defines the duration of the trip with flexible travel dates. Available options: `1` - Weekend `2` - 1 week (default) `3` - 2 weeks", + "group": "advanced_google_travel_explore_parameters" + }, + "travel_class": { + "type": "select", + "options": [ + [ + 1, + "Economy (default) - 1" + ], + [ + 2, + "Premium economy - 2" + ], + [ + 3, + "Business - 3" + ], + [ + 4, + "First - 4" + ] + ], + "description": "Parameter defines the travel class. Available options: `1` - Economy (default) `2` - Premium economy `3` - Business `4` - First", + "group": "advanced_google_travel_explore_parameters" + }, + "adults": { + "type": "number", + "description": "Parameter defines the number of adults. Default to 1.", + "group": "number_of_passengers" + }, + "children": { + "type": "number", + "description": "Parameter defines the number of children. Default to 0.", + "group": "number_of_passengers" + }, + "infants_in_seat": { + "type": "number", + "description": "Parameter defines the number of infants in seat. Default to 0.", + "group": "number_of_passengers" + }, + "infants_on_lap": { + "type": "number", + "description": "Parameter defines the number of infants on lap. Default to 0.", + "group": "number_of_passengers" + }, + "stops": { + "type": "select", + "options": [ + [ + 0, + "Any number of stops (default) - 0" + ], + [ + 1, + "Nonstop only - 1" + ], + [ + 2, + "1 stop or fewer - 2" + ], + [ + 3, + "2 stops or fewer - 3" + ] + ], + "description": "Parameter defines the number of stops during the flight. Available options: `0` - Any number of stops (default) `1` - Nonstop only `2` - 1 stop or fewer `3` - 2 stops or fewer", + "group": "advanced_filters" + }, + "travel_mode": { + "type": "select", + "options": [ + [ + "0", + "All (default) - 0" + ], + [ + "1", + "Flight only - 1" + ] + ], + "description": "Parameter defines the travel mode. Available options: `0` - All (default) `1` - Flight only travel_mode and interest parameters can't be used together.", + "group": "advanced_filters" + }, + "interest": { + "type": "select", + "options": [ + [ + "0", + "Popular (default)" + ], + "/g/11bc58l13w", + "/m/0b3yr", + "/m/09cmq", + "/m/03g3w", + "/m/071k0" + ], + "description": "Parameter defines the interest of the destination. Available options: `0` - Popular (default) `/g/11bc58l13w` - Outdoors `/m/0b3yr` - Beaches `/m/09cmq` - Museum `/m/03g3w` - History `/m/071k0` - Skiing travel_mode and interest parameters can't be used together.", + "group": "advanced_filters" + }, + "include_airlines": { + "description": "Parameter defines the airline codes to be included. Split multiple airlines with comma. Each airline code should be a 2-character IATA code consisting of either two uppercase letters or one uppercase letter and one digit. You can search for airline codes on IATA. For example, `UA` is United Airlines. Additionally, alliances can be also included here: `STAR_ALLIANCE` - Star Alliance `SKYTEAM` - SkyTeam `ONEWORLD` - Oneworld", + "group": "advanced_filters" + }, + "bags": { + "type": "number", + "description": "Parameter defines the number of carry-on bags. Default to `0`. Parameter should not exceed the total number of passengers with carry-on bag allowance (adults, children and infants_in_seat).", + "group": "advanced_filters" + }, + "max_price": { + "type": "number", + "description": "Parameter defines the maximum ticket price. Default to unlimited.", + "group": "advanced_filters" + }, + "max_duration": { + "type": "number", + "description": "Parameter defines the maximum flight duration, in minutes. For example, specify `1500` for 25 hours.", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_travel_explore` to use the Google Travel Explore API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Travel Explore results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_trends.json b/engines/google_trends.json new file mode 100644 index 0000000..f048130 --- /dev/null +++ b/engines/google_trends.json @@ -0,0 +1,9028 @@ +{ + "engine": "google_trends", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query or queries you want to search. You can use anything that you would use in a regular Google Trends search. The maximum number of queries per search is `5` (this only applies to \"Interest over time\" and \"Compared breakdown by region\" data_type, other types of data will only accept `1` query per search). When passing multiple queries you need to use a comma (`,`) to separate them (e.g. `coffee,pizza,dark chocolate,/m/027lnzs,bread`). Query can be a \"Search term\" (e.g. `World Cup`, `Eminem`, `iPhone`, etc.) or a \"Topic\" (e.g. `/m/0663v`, `/m/027lnzs`, `/g/11mw8j71m4`, etc.). Queries that are \"Topics\" are encoded. To retrieve these values you can use our Google Trends Autocomplete API. Maximum length for each query is 100 characters.", + "group": "search_query" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Trends search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "geographic_location" + }, + "geo": { + "type": "select", + "options": [ + "", + "AF", + "AF-BDS", + "AF-BDG", + "AF-BGL", + "AF-BAL", + "AF-BAM", + "AF-DAY", + "AF-FRA", + "AF-FYB", + "AF-GHA", + "AF-GHO", + "AF-HEL", + "AF-HER", + "AF-JOW", + "AF-KAB", + "AF-KAN", + "AF-KAP", + "AF-KHO", + "AF-KNR", + "AF-KDZ", + "AF-LAG", + "AF-LOG", + "AF-NAN", + "AF-NIM", + "AF-NUR", + "AF-URU", + "AF-PIA", + "AF-PKA", + "AF-PAN", + "AF-PAR", + "AF-SAM", + "AF-SAR", + "AF-TAK", + "AF-WAR", + "AF-ZAB", + "AX", + "AL", + "AL-01", + "AL-09", + "AL-02", + "AL-03", + "AL-04", + "AL-05", + "AL-06", + "AL-07", + "AL-08", + "AL-10", + "AL-11", + "AL-12", + "DZ", + "DZ-01", + "DZ-44", + "DZ-46", + "DZ-16", + "DZ-23", + "DZ-05", + "DZ-08", + "DZ-06", + "DZ-07", + "DZ-09", + "DZ-34", + "DZ-10", + "DZ-35", + "DZ-02", + "DZ-25", + "DZ-17", + "DZ-32", + "DZ-39", + "DZ-36", + "DZ-47", + "DZ-24", + "DZ-33", + "DZ-18", + "DZ-40", + "DZ-03", + "DZ-28", + "DZ-29", + "DZ-26", + "DZ-43", + "DZ-27", + "DZ-45", + "DZ-31", + "DZ-30", + "DZ-04", + "DZ-11", + "DZ-48", + "DZ-20", + "DZ-19", + "DZ-22", + "DZ-21", + "DZ-41", + "DZ-12", + "DZ-14", + "DZ-37", + "DZ-42", + "DZ-38", + "DZ-15", + "DZ-13", + "AS", + "AD", + "AD-07", + "AD-02", + "AD-03", + "AD-08", + "AD-04", + "AD-05", + "AD-06", + "AO", + "AO-BGO", + "AO-BGU", + "AO-BIE", + "AO-CAB", + "AO-CCU", + "AO-CNO", + "AO-CUS", + "AO-CNN", + "AO-HUA", + "AO-HUI", + "AO-LUA", + "AO-LNO", + "AO-LSU", + "AO-MAL", + "AO-MOX", + "AO-NAM", + "AO-UIG", + "AO-ZAI", + "AI", + "AQ", + "AG", + "AG-10", + "AG-11", + "AG-03", + "AG-04", + "AG-05", + "AG-06", + "AG-07", + "AG-08", + "AR", + "AR-C", + "AR-B", + "AR-K", + "AR-H", + "AR-U", + "AR-X", + "AR-W", + "AR-E", + "AR-P", + "AR-Y", + "AR-L", + "AR-F", + "AR-M", + "AR-N", + "AR-Q", + "AR-R", + "AR-A", + "AR-J", + "AR-D", + "AR-Z", + "AR-S", + "AR-G", + "AR-V", + "AR-T", + "AM", + "AM-AG", + "AM-AR", + "AM-AV", + "AM-GR", + "AM-KT", + "AM-LO", + "AM-SH", + "AM-SU", + "AM-TV", + "AM-VD", + "AM-ER", + "AW", + "AU", + "AU-ACT", + "AU-NSW", + "AU-NT", + "AU-QLD", + "AU-SA", + "AU-TAS", + "AU-VIC", + "AU-WA", + "AT", + "AT-1", + "AT-2", + "AT-3", + "AT-5", + "AT-6", + "AT-7", + "AT-4", + "AT-9", + "AT-8", + "AZ", + "AZ-NX", + "BS", + "BS-AK", + "BS-BY", + "BS-BI", + "BS-BP", + "BS-CI", + "BS-CO", + "BS-CS", + "BS-CE", + "BS-CK", + "BS-EG", + "BS-EX", + "BS-FP", + "BS-GC", + "BS-HI", + "BS-HT", + "BS-IN", + "BS-LI", + "BS-MC", + "BS-MG", + "BS-MI", + "BS-NO", + "BS-NS", + "BS-NE", + "BS-RI", + "BS-RC", + "BS-SS", + "BS-SO", + "BS-SA", + "BS-SE", + "BS-SW", + "BS-WG", + "BH", + "BH-13", + "BH-16", + "BH-15", + "BH-17", + "BH-14", + "BD", + "BD-A", + "BD-B", + "BD-C", + "BD-D", + "BD-E", + "BD-F", + "BD-G", + "BB", + "BB-01", + "BB-02", + "BB-03", + "BB-04", + "BB-05", + "BB-06", + "BB-07", + "BB-08", + "BB-09", + "BB-10", + "BB-11", + "BY", + "BY-BR", + "BY-HO", + "BY-HR", + "BY-MI", + "BY-MA", + "BY-VI", + "BE", + "BE-BRU", + "BE-VLG", + "BE-WAL", + "BZ", + "BZ-BZ", + "BZ-CY", + "BZ-CZL", + "BZ-OW", + "BZ-SC", + "BZ-TOL", + "BJ", + "BJ-AL", + "BJ-AK", + "BJ-AQ", + "BJ-BO", + "BJ-CO", + "BJ-DO", + "BJ-KO", + "BJ-LI", + "BJ-MO", + "BJ-OU", + "BJ-PL", + "BJ-ZO", + "BM", + "BT", + "BT-33", + "BT-12", + "BT-22", + "BT-GA", + "BT-13", + "BT-44", + "BT-42", + "BT-11", + "BT-43", + "BT-23", + "BT-45", + "BT-14", + "BT-31", + "BT-15", + "BT-41", + "BT-TY", + "BT-32", + "BT-21", + "BT-24", + "BT-34", + "BO", + "BO-B", + "BO-H", + "BO-C", + "BO-L", + "BO-O", + "BO-N", + "BO-P", + "BO-S", + "BO-T", + "BA", + "BA-BRC", + "BA-BIH", + "BA-SRP", + "BW", + "BW-CE", + "BW-GH", + "BW-KG", + "BW-KL", + "BW-KW", + "BW-NW", + "BW-NE", + "BW-SE", + "BW-SO", + "BV", + "BR", + "BR-DF", + "BR-AC", + "BR-AL", + "BR-AP", + "BR-AM", + "BR-BA", + "BR-CE", + "BR-ES", + "BR-GO", + "BR-MA", + "BR-MT", + "BR-MS", + "BR-MG", + "BR-PA", + "BR-PB", + "BR-PR", + "BR-PE", + "BR-PI", + "BR-RJ", + "BR-RN", + "BR-RS", + "BR-RO", + "BR-RR", + "BR-SC", + "BR-SP", + "BR-SE", + "BR-TO", + "IO", + "VG", + "BN", + "BN-BE", + "BN-BM", + "BN-TE", + "BN-TU", + "BG", + "BG-01", + "BG-02", + "BG-08", + "BG-07", + "BG-26", + "BG-28", + "BG-09", + "BG-10", + "BG-11", + "BG-12", + "BG-13", + "BG-14", + "BG-15", + "BG-16", + "BG-17", + "BG-18", + "BG-27", + "BG-19", + "BG-20", + "BG-21", + "BG-22", + "BG-23", + "BG-24", + "BG-25", + "BG-03", + "BG-04", + "BG-05", + "BG-06", + "BF", + "BF-01", + "BF-02", + "BF-03", + "BF-04", + "BF-05", + "BF-06", + "BF-07", + "BF-08", + "BF-09", + "BF-10", + "BF-11", + "BF-12", + "BF-13", + "BI", + "BI-BB", + "BI-BM", + "BI-BL", + "BI-BR", + "BI-CA", + "BI-CI", + "BI-GI", + "BI-KR", + "BI-KY", + "BI-KI", + "BI-MA", + "BI-MU", + "BI-MY", + "BI-MW", + "BI-NG", + "BI-RT", + "BI-RY", + "KH", + "KH-1", + "KH-2", + "KH-3", + "KH-4", + "KH-5", + "KH-6", + "KH-7", + "KH-8", + "KH-23", + "KH-9", + "KH-10", + "KH-11", + "KH-22", + "KH-24", + "KH-12", + "KH-18", + "KH-13", + "KH-14", + "KH-15", + "KH-16", + "KH-17", + "KH-19", + "KH-20", + "KH-21", + "KH-25", + "CM", + "CM-AD", + "CM-CE", + "CM-ES", + "CM-EN", + "CM-LT", + "CM-NO", + "CM-NW", + "CM-SU", + "CM-SW", + "CM-OU", + "CA", + "CA-AB", + "CA-BC", + "CA-MB", + "CA-NB", + "CA-NL", + "CA-NT", + "CA-NS", + "CA-NU", + "CA-ON", + "CA-PE", + "CA-QC", + "CA-SK", + "CA-YT", + "CV", + "CV-BV", + "CV-BR", + "CV-MA", + "CV-MO", + "CV-PA", + "CV-PN", + "CV-PR", + "CV-RB", + "CV-RG", + "CV-RS", + "CV-SL", + "CV-CA", + "CV-CF", + "CV-CR", + "CV-SD", + "CV-SF", + "CV-SO", + "CV-SM", + "CV-SS", + "CV-SV", + "CV-TA", + "CV-TS", + "BQ", + "BQ-BO", + "BQ-SA", + "BQ-SE", + "KY", + "CF", + "CF-BB", + "CF-BGF", + "CF-BK", + "CF-HM", + "CF-HK", + "CF-KG", + "CF-LB", + "CF-HS", + "CF-MB", + "CF-KB", + "CF-NM", + "CF-MP", + "CF-UK", + "CF-AC", + "CF-OP", + "CF-SE", + "CF-VK", + "TD", + "TD-BG", + "TD-BA", + "TD-BO", + "TD-CB", + "TD-EN", + "TD-GR", + "TD-HL", + "TD-KA", + "TD-LC", + "TD-LO", + "TD-LR", + "TD-MA", + "TD-ME", + "TD-MO", + "TD-MC", + "TD-ND", + "TD-OD", + "TD-SI", + "TD-TA", + "TD-TI", + "TD-WF", + "TD-SA", + "CL", + "CL-AN", + "CL-AR", + "CL-AP", + "CL-AT", + "CL-BI", + "CL-CO", + "CL-LL", + "CL-LR", + "CL-MA", + "CL-ML", + "CL-LI", + "CL-RM", + "CL-TA", + "CL-VS", + "CL-AI", + "CN", + "CN-34", + "CN-11", + "CN-50", + "CN-35", + "CN-62", + "CN-44", + "CN-45", + "CN-52", + "CN-46", + "CN-13", + "CN-23", + "CN-41", + "CN-42", + "CN-43", + "CN-15", + "CN-32", + "CN-36", + "CN-22", + "CN-21", + "CN-64", + "CN-63", + "CN-61", + "CN-37", + "CN-31", + "CN-14", + "CN-51", + "CN-12", + "CN-54", + "CN-65", + "CN-53", + "CN-33", + "CX", + "CC", + "CO", + "CO-AMA", + "CO-ANT", + "CO-ARA", + "CO-ATL", + "CO-DC", + "CO-BOL", + "CO-BOY", + "CO-CAL", + "CO-CAQ", + "CO-CAS", + "CO-CAU", + "CO-CES", + "CO-CHO", + "CO-COR", + "CO-CUN", + "CO-GUA", + "CO-GUV", + "CO-HUI", + "CO-LAG", + "CO-MAG", + "CO-MET", + "CO-NAR", + "CO-NSA", + "CO-PUT", + "CO-QUI", + "CO-RIS", + "CO-SAP", + "CO-SAN", + "CO-SUC", + "CO-TOL", + "CO-VAC", + "CO-VAU", + "CO-VID", + "KM", + "KM-M", + "KM-G", + "KM-A", + "CG", + "CG-11", + "CG-BZV", + "CG-8", + "CG-15", + "CG-5", + "CG-2", + "CG-7", + "CG-9", + "CG-14", + "CG-16", + "CG-12", + "CG-13", + "CD", + "CD-BN", + "CD-BC", + "CD-EQ", + "CD-KW", + "CD-KE", + "CD-KA", + "CD-KN", + "CD-MA", + "CD-NK", + "CD-OR", + "CD-SK", + "CK", + "CR", + "CR-A", + "CR-G", + "CR-H", + "CR-L", + "CR-C", + "CR-P", + "CR-SJ", + "CI", + "CI-16", + "CI-17", + "CI-09", + "CI-10", + "CI-06", + "CI-18", + "CI-02", + "CI-07", + "CI-01", + "CI-12", + "CI-19", + "CI-05", + "CI-11", + "CI-03", + "CI-15", + "CI-13", + "CI-04", + "CI-14", + "CI-08", + "HR", + "HR-07", + "HR-12", + "HR-21", + "HR-19", + "HR-18", + "HR-04", + "HR-06", + "HR-02", + "HR-09", + "HR-20", + "HR-14", + "HR-11", + "HR-08", + "HR-15", + "HR-03", + "HR-17", + "HR-05", + "HR-10", + "HR-16", + "HR-13", + "HR-01", + "CU", + "CU-15", + "CU-09", + "CU-08", + "CU-06", + "CU-12", + "CU-14", + "CU-03", + "CU-11", + "CU-99", + "CU-10", + "CU-04", + "CU-16", + "CU-01", + "CU-07", + "CU-13", + "CU-05", + "CW", + "CY", + "CY-04", + "CY-06", + "CY-03", + "CY-02", + "CY-01", + "CY-05", + "CZ", + "CZ-ST", + "CZ-KR", + "CZ-KA", + "CZ-LI", + "CZ-MO", + "CZ-OL", + "CZ-PA", + "CZ-PL", + "CZ-PR", + "CZ-JC", + "CZ-JM", + "CZ-US", + "CZ-VY", + "CZ-ZL", + "DK", + "DK-84", + "DK-82", + "DK-81", + "DK-83", + "DK-85", + "DJ", + "DJ-AS", + "DJ-AR", + "DJ-DI", + "DJ-DJ", + "DJ-OB", + "DJ-TA", + "DM", + "DM-02", + "DM-03", + "DM-04", + "DM-05", + "DM-06", + "DM-07", + "DM-08", + "DM-09", + "DM-10", + "DM-11", + "DO", + "DO-02", + "DO-03", + "DO-04", + "DO-05", + "DO-01", + "DO-06", + "DO-08", + "DO-07", + "DO-09", + "DO-30", + "DO-19", + "DO-10", + "DO-11", + "DO-12", + "DO-13", + "DO-14", + "DO-28", + "DO-15", + "DO-29", + "DO-16", + "DO-17", + "DO-18", + "DO-20", + "DO-21", + "DO-31", + "DO-22", + "DO-23", + "DO-24", + "DO-25", + "DO-26", + "DO-32", + "DO-27", + "EC", + "EC-A", + "EC-B", + "EC-F", + "EC-C", + "EC-H", + "EC-X", + "EC-O", + "EC-E", + "EC-W", + "EC-G", + "EC-I", + "EC-L", + "EC-R", + "EC-M", + "EC-S", + "EC-D", + "EC-Y", + "EC-P", + "EC-N", + "EC-SE", + "EC-SD", + "EC-U", + "EC-T", + "EC-Z", + "EG", + "EG-KB", + "EG-ALX", + "EG-SHR", + "EG-AST", + "EG-ASN", + "EG-BNS", + "EG-C", + "EG-DK", + "EG-DT", + "EG-BH", + "EG-FYM", + "EG-GH", + "EG-GZ", + "EG-IS", + "EG-KFS", + "EG-LX", + "EG-MT", + "EG-MN", + "EG-MNF", + "EG-WAD", + "EG-SIN", + "EG-PTS", + "EG-KN", + "EG-BA", + "EG-SHG", + "EG-JS", + "EG-SUZ", + "SV", + "SV-AH", + "SV-CA", + "SV-CH", + "SV-CU", + "SV-LI", + "SV-PA", + "SV-UN", + "SV-MO", + "SV-SM", + "SV-SS", + "SV-SV", + "SV-SA", + "SV-SO", + "SV-US", + "GQ", + "GQ-AN", + "GQ-BN", + "GQ-BS", + "GQ-CS", + "GQ-KN", + "GQ-LI", + "GQ-WN", + "ER", + "ER-AN", + "ER-MA", + "ER-GB", + "ER-SK", + "ER-DU", + "ER-DK", + "EE", + "EE-37", + "EE-39", + "EE-44", + "EE-51", + "EE-49", + "EE-57", + "EE-59", + "EE-67", + "EE-65", + "EE-70", + "EE-74", + "EE-78", + "EE-82", + "EE-84", + "EE-86", + "SZ", + "SZ-HH", + "SZ-LU", + "SZ-MA", + "SZ-SH", + "ET", + "ET-AA", + "ET-AF", + "ET-AM", + "ET-BE", + "ET-DD", + "ET-GA", + "ET-HA", + "ET-OR", + "ET-SO", + "ET-SN", + "ET-TI", + "FK", + "FO", + "FJ", + "FJ-C", + "FJ-E", + "FJ-N", + "FJ-R", + "FJ-W", + "FI", + "FI-08", + "FI-07", + "FI-05", + "FI-09", + "FI-10", + "FI-13", + "FI-14", + "FI-15", + "FI-12", + "FI-16", + "FI-11", + "FI-17", + "FI-02", + "FI-03", + "FI-04", + "FI-19", + "FI-06", + "FI-18", + "FR", + "FR-A", + "FR-B", + "FR-C", + "FR-E", + "FR-D", + "FR-F", + "FR-G", + "FR-H", + "FR-I", + "FR-J", + "FR-K", + "FR-L", + "FR-M", + "FR-P", + "FR-N", + "FR-O", + "FR-R", + "FR-S", + "FR-T", + "FR-U", + "FR-V", + "FR-Q", + "GF", + "PF", + "TF", + "GA", + "GA-1", + "GA-2", + "GA-3", + "GA-4", + "GA-5", + "GA-6", + "GA-7", + "GA-8", + "GA-9", + "GM", + "GM-B", + "GM-M", + "GM-L", + "GM-N", + "GM-U", + "GM-W", + "GE", + "GE-AB", + "GE-AJ", + "GE-GU", + "GE-IM", + "GE-KA", + "GE-KK", + "GE-MM", + "GE-RL", + "GE-SZ", + "GE-SJ", + "GE-SK", + "GE-TB", + "DE", + "DE-BW", + "DE-BY", + "DE-BE", + "DE-BB", + "DE-HB", + "DE-HH", + "DE-HE", + "DE-NI", + "DE-MV", + "DE-NW", + "DE-RP", + "DE-SL", + "DE-SN", + "DE-ST", + "DE-SH", + "DE-TH", + "GH", + "GH-AH", + "GH-BA", + "GH-CP", + "GH-EP", + "GH-AA", + "GH-NP", + "GH-UE", + "GH-UW", + "GH-TV", + "GH-WP", + "GI", + "GR", + "GL", + "GL-KU", + "GL-QA", + "GL-QE", + "GL-SM", + "GD", + "GD-10", + "GD-01", + "GD-02", + "GD-03", + "GD-04", + "GD-05", + "GD-06", + "GP", + "GU", + "GT", + "GT-AV", + "GT-BV", + "GT-CM", + "GT-CQ", + "GT-PR", + "GT-ES", + "GT-GU", + "GT-HU", + "GT-IZ", + "GT-JA", + "GT-JU", + "GT-PE", + "GT-QZ", + "GT-QC", + "GT-RE", + "GT-SA", + "GT-SM", + "GT-SR", + "GT-SO", + "GT-SU", + "GT-TO", + "GT-ZA", + "GG", + "GN", + "GN-B", + "GN-C", + "GN-F", + "GN-K", + "GN-D", + "GN-L", + "GN-M", + "GN-N", + "GW", + "GW-BA", + "GW-BM", + "GW-BS", + "GW-BL", + "GW-CA", + "GW-GA", + "GW-OI", + "GW-QU", + "GW-TO", + "GY", + "GY-BA", + "GY-CU", + "GY-DE", + "GY-EB", + "GY-ES", + "GY-MA", + "GY-PM", + "GY-PT", + "GY-UD", + "GY-UT", + "HT", + "HT-AR", + "HT-CE", + "HT-GA", + "HT-NI", + "HT-ND", + "HT-NE", + "HT-NO", + "HT-OU", + "HT-SD", + "HT-SE", + "HM", + "HN", + "HN-AT", + "HN-IB", + "HN-CH", + "HN-CL", + "HN-CM", + "HN-CP", + "HN-CR", + "HN-EP", + "HN-FM", + "HN-GD", + "HN-IN", + "HN-LP", + "HN-LE", + "HN-OC", + "HN-OL", + "HN-SB", + "HN-VA", + "HN-YO", + "HK", + "HU", + "HU-BK", + "HU-BA", + "HU-BE", + "HU-BZ", + "HU-BU", + "HU-CS", + "HU-FE", + "HU-GS", + "HU-HB", + "HU-HE", + "HU-JN", + "HU-KE", + "HU-NO", + "HU-PE", + "HU-SO", + "HU-SZ", + "HU-TO", + "HU-VA", + "HU-VE", + "HU-ZA", + "IS", + "IS-1", + "IS-7", + "IS-6", + "IS-5", + "IS-8", + "IS-2", + "IS-3", + "IS-4", + "IN", + "IN-AN", + "IN-AP", + "IN-AR", + "IN-AS", + "IN-BR", + "IN-CH", + "IN-CT", + "IN-DN", + "IN-DD", + "IN-DL", + "IN-GA", + "IN-GJ", + "IN-HR", + "IN-HP", + "IN-JK", + "IN-JH", + "IN-KA", + "IN-KL", + "IN-LD", + "IN-MP", + "IN-MH", + "IN-MN", + "IN-ML", + "IN-MZ", + "IN-NL", + "IN-OR", + "IN-PY", + "IN-PB", + "IN-RJ", + "IN-SK", + "IN-TN", + "IN-TG", + "IN-TR", + "IN-UP", + "IN-UT", + "IN-WB", + "ID", + "ID-AC", + "ID-BA", + "ID-BB", + "ID-BT", + "ID-BE", + "ID-JT", + "ID-KT", + "ID-ST", + "ID-JI", + "ID-KI", + "ID-NT", + "ID-GO", + "ID-JA", + "ID-LA", + "ID-MA", + "ID-KU", + "ID-MU", + "ID-SA", + "ID-SU", + "ID-PA", + "ID-RI", + "ID-KR", + "ID-SG", + "ID-KS", + "ID-SN", + "ID-SS", + "ID-JK", + "ID-YO", + "ID-JB", + "ID-KB", + "ID-NB", + "ID-PB", + "ID-SR", + "ID-SB", + "IR", + "IR-32", + "IR-03", + "IR-06", + "IR-08", + "IR-01", + "IR-14", + "IR-19", + "IR-27", + "IR-24", + "IR-23", + "IR-05", + "IR-04", + "IR-15", + "IR-17", + "IR-30", + "IR-10", + "IR-18", + "IR-16", + "IR-20", + "IR-22", + "IR-21", + "IR-31", + "IR-28", + "IR-26", + "IR-12", + "IR-13", + "IR-29", + "IR-07", + "IR-02", + "IR-25", + "IR-11", + "IQ", + "IQ-AN", + "IQ-MU", + "IQ-QA", + "IQ-NA", + "IQ-BB", + "IQ-BG", + "IQ-BA", + "IQ-DQ", + "IQ-DI", + "IQ-DA", + "IQ-AR", + "IQ-KA", + "IQ-TS", + "IQ-MA", + "IQ-NI", + "IQ-SD", + "IQ-SU", + "IQ-WA", + "IE", + "IM", + "IL", + "IL-M", + "IL-HA", + "IL-JM", + "IL-Z", + "IL-D", + "IL-TA", + "IT", + "IT-65", + "IT-23", + "IT-75", + "IT-77", + "IT-78", + "IT-72", + "IT-45", + "IT-36", + "IT-62", + "IT-42", + "IT-25", + "IT-57", + "IT-67", + "IT-21", + "IT-88", + "IT-82", + "IT-32", + "IT-52", + "IT-55", + "IT-34", + "JM", + "JM-13", + "JM-09", + "JM-01", + "JM-12", + "JM-04", + "JM-02", + "JM-06", + "JM-14", + "JM-11", + "JM-08", + "JM-05", + "JM-03", + "JM-07", + "JM-10", + "JP", + "JP-23", + "JP-05", + "JP-02", + "JP-12", + "JP-38", + "JP-18", + "JP-40", + "JP-07", + "JP-21", + "JP-10", + "JP-34", + "JP-01", + "JP-28", + "JP-08", + "JP-17", + "JP-03", + "JP-37", + "JP-46", + "JP-14", + "JP-39", + "JP-43", + "JP-26", + "JP-24", + "JP-04", + "JP-45", + "JP-20", + "JP-42", + "JP-29", + "JP-15", + "JP-44", + "JP-33", + "JP-47", + "JP-27", + "JP-41", + "JP-11", + "JP-25", + "JP-32", + "JP-22", + "JP-09", + "JP-36", + "JP-13", + "JP-31", + "JP-16", + "JP-30", + "JP-06", + "JP-35", + "JP-19", + "JE", + "JO", + "JO-AJ", + "JO-AM", + "JO-AQ", + "JO-BA", + "JO-IR", + "JO-JA", + "JO-KA", + "JO-MN", + "JO-MD", + "JO-MA", + "JO-AT", + "JO-AZ", + "KZ", + "KZ-AKM", + "KZ-AKT", + "KZ-ALM", + "KZ-ATY", + "KZ-VOS", + "KZ-ZHA", + "KZ-KAR", + "KZ-KUS", + "KZ-KZY", + "KZ-MAN", + "KZ-SEV", + "KZ-PAV", + "KZ-YUZ", + "KZ-ZAP", + "KE", + "KI", + "KI-G", + "KI-L", + "KI-P", + "XK", + "KW", + "KW-AH", + "KW-KU", + "KW-FA", + "KW-JA", + "KW-HA", + "KW-MU", + "KG", + "KG-B", + "KG-C", + "KG-J", + "KG-N", + "KG-O", + "KG-T", + "KG-Y", + "LA", + "LA-AT", + "LA-BK", + "LA-BL", + "LA-CH", + "LA-HO", + "LA-KH", + "LA-LP", + "LA-LM", + "LA-OU", + "LA-PH", + "LA-SL", + "LA-SV", + "LA-XA", + "LA-VI", + "LA-VT", + "LA-XE", + "LA-XI", + "LV", + "LV-011", + "LV-001", + "LV-002", + "LV-003", + "LV-004", + "LV-005", + "LV-006", + "LV-007", + "LV-008", + "LV-009", + "LV-010", + "LV-012", + "LV-013", + "LV-014", + "LV-015", + "LV-016", + "LV-017", + "LV-018", + "LV-019", + "LV-020", + "LV-022", + "LV-021", + "LV-023", + "LV-024", + "LV-DGV", + "LV-025", + "LV-026", + "LV-027", + "LV-028", + "LV-029", + "LV-030", + "LV-031", + "LV-032", + "LV-033", + "LV-034", + "LV-035", + "LV-036", + "LV-037", + "LV-038", + "LV-039", + "LV-040", + "LV-JKB", + "LV-042", + "LV-JEL", + "LV-041", + "LV-JUR", + "LV-043", + "LV-044", + "LV-051", + "LV-052", + "LV-045", + "LV-046", + "LV-047", + "LV-048", + "LV-049", + "LV-050", + "LV-053", + "LV-LPX", + "LV-055", + "LV-054", + "LV-056", + "LV-057", + "LV-058", + "LV-059", + "LV-061", + "LV-062", + "LV-060", + "LV-063", + "LV-064", + "LV-065", + "LV-066", + "LV-067", + "LV-068", + "LV-069", + "LV-070", + "LV-071", + "LV-072", + "LV-073", + "LV-074", + "LV-075", + "LV-076", + "LV-077", + "LV-REZ", + "LV-078", + "LV-RIX", + "LV-079", + "LV-080", + "LV-081", + "LV-082", + "LV-084", + "LV-083", + "LV-085", + "LV-086", + "LV-087", + "LV-088", + "LV-089", + "LV-090", + "LV-091", + "LV-092", + "LV-093", + "LV-094", + "LV-095", + "LV-096", + "LV-097", + "LV-098", + "LV-099", + "LV-100", + "LV-101", + "LV-VMR", + "LV-102", + "LV-103", + "LV-104", + "LV-105", + "LV-VEN", + "LV-106", + "LV-107", + "LV-108", + "LV-109", + "LV-110", + "LB", + "LB-BA", + "LB-BI", + "LB-JL", + "LB-NA", + "LB-AS", + "LB-JA", + "LS", + "LS-D", + "LS-B", + "LS-C", + "LS-E", + "LS-A", + "LS-F", + "LS-J", + "LS-H", + "LS-G", + "LS-K", + "LR", + "LR-BM", + "LR-BG", + "LR-GP", + "LR-GB", + "LR-CM", + "LR-GG", + "LR-GK", + "LR-LO", + "LR-MG", + "LR-MY", + "LR-MO", + "LR-NI", + "LR-RI", + "LR-RG", + "LR-SI", + "LY", + "LY-BU", + "LY-JA", + "LY-JG", + "LY-JI", + "LY-JU", + "LY-KF", + "LY-MJ", + "LY-MB", + "LY-WA", + "LY-NQ", + "LY-ZA", + "LY-BA", + "LY-DR", + "LY-GT", + "LY-MI", + "LY-MQ", + "LY-NL", + "LY-SB", + "LY-SR", + "LY-TB", + "LY-WD", + "LY-WS", + "LI", + "LI-01", + "LI-02", + "LI-03", + "LI-04", + "LI-05", + "LI-06", + "LI-07", + "LI-08", + "LI-09", + "LI-10", + "LI-11", + "LT", + "LT-AL", + "LT-KU", + "LT-KL", + "LT-MR", + "LT-PN", + "LT-SA", + "LT-TA", + "LT-TE", + "LT-UT", + "LT-VL", + "LU", + "LU-D", + "LU-G", + "LU-L", + "MO", + "MG", + "MG-T", + "MG-D", + "MG-F", + "MG-M", + "MG-A", + "MG-U", + "MW", + "MW-C", + "MW-N", + "MW-S", + "MY", + "MY-14", + "MY-01", + "MY-02", + "MY-03", + "MY-15", + "MY-04", + "MY-05", + "MY-06", + "MY-07", + "MY-08", + "MY-09", + "MY-16", + "MY-12", + "MY-13", + "MY-10", + "MY-11", + "MV", + "MV-CE", + "MV-MLE", + "MV-NC", + "MV-NO", + "MV-SC", + "MV-SU", + "MV-UN", + "MV-US", + "ML", + "ML-BKO", + "ML-7", + "ML-1", + "ML-8", + "ML-2", + "ML-5", + "ML-4", + "ML-3", + "ML-6", + "MT", + "MH", + "MH-ALL", + "MH-ALK", + "MH-ARN", + "MH-AUR", + "MH-EBO", + "MH-ENI", + "MH-JAB", + "MH-JAL", + "MH-KIL", + "MH-KWA", + "MH-LAE", + "MH-LIB", + "MH-LIK", + "MH-MAJ", + "MH-MAL", + "MH-MEJ", + "MH-MIL", + "MH-NMK", + "MH-NMU", + "MH-RON", + "MH-UJA", + "MH-UTI", + "MH-WTH", + "MH-WTJ", + "MQ", + "MR", + "MR-07", + "MR-03", + "MR-05", + "MR-08", + "MR-04", + "MR-10", + "MR-01", + "MR-02", + "MR-12", + "MR-NKC", + "MR-09", + "MR-11", + "MR-06", + "MU", + "MU-AG", + "MU-BL", + "MU-CC", + "MU-FL", + "MU-GP", + "MU-MO", + "MU-PA", + "MU-PW", + "MU-PL", + "MU-RR", + "MU-RO", + "MU-SA", + "YT", + "MX", + "MX-AGU", + "MX-BCN", + "MX-BCS", + "MX-CAM", + "MX-CHP", + "MX-CHH", + "MX-COA", + "MX-COL", + "MX-DUR", + "MX-GUA", + "MX-GRO", + "MX-HID", + "MX-JAL", + "MX-DIF", + "MX-MIC", + "MX-MOR", + "MX-NAY", + "MX-NLE", + "MX-OAX", + "MX-PUE", + "MX-QUE", + "MX-ROO", + "MX-SLP", + "MX-SIN", + "MX-SON", + "MX-MEX", + "MX-TAB", + "MX-TAM", + "MX-TLA", + "MX-VER", + "MX-YUC", + "MX-ZAC", + "FM", + "FM-TRK", + "FM-KSA", + "FM-PNI", + "FM-YAP", + "MD", + "MD-AN", + "MD-BA", + "MD-BS", + "MD-BD", + "MD-BR", + "MD-CA", + "MD-CL", + "MD-CT", + "MD-CS", + "MD-CU", + "MD-CM", + "MD-CR", + "MD-DO", + "MD-DR", + "MD-DU", + "MD-ED", + "MD-FA", + "MD-FL", + "MD-GA", + "MD-GL", + "MD-HI", + "MD-IA", + "MD-LE", + "MD-NI", + "MD-OC", + "MD-OR", + "MD-RE", + "MD-RI", + "MD-SI", + "MD-SD", + "MD-SO", + "MD-SV", + "MD-ST", + "MD-TA", + "MD-TE", + "MD-SN", + "MD-UN", + "MC", + "MN", + "MN-073", + "MN-071", + "MN-069", + "MN-067", + "MN-037", + "MN-061", + "MN-063", + "MN-059", + "MN-065", + "MN-064", + "MN-039", + "MN-043", + "MN-041", + "MN-035", + "MN-049", + "MN-051", + "MN-047", + "MN-1", + "MN-053", + "MN-046", + "MN-055", + "MN-057", + "ME", + "ME-01", + "ME-02", + "ME-03", + "ME-04", + "ME-05", + "ME-06", + "ME-07", + "ME-08", + "ME-09", + "ME-10", + "ME-11", + "ME-12", + "ME-13", + "ME-14", + "ME-15", + "ME-16", + "ME-17", + "ME-18", + "ME-19", + "ME-20", + "ME-21", + "MS", + "MA", + "MA-09", + "MA-10", + "MA-05", + "MA-02", + "MA-08", + "MA-14", + "MA-15", + "MA-11", + "MA-06", + "MA-04", + "MA-07", + "MA-13", + "MA-12", + "MA-01", + "MA-03", + "MZ", + "MZ-P", + "MZ-G", + "MZ-I", + "MZ-B", + "MZ-MPM", + "MZ-L", + "MZ-N", + "MZ-A", + "MZ-S", + "MZ-T", + "MZ-Q", + "MM", + "MM-07", + "MM-02", + "MM-14", + "MM-11", + "MM-12", + "MM-13", + "MM-03", + "MM-04", + "MM-15", + "MM-18", + "MM-16", + "MM-01", + "MM-17", + "MM-05", + "MM-06", + "NA", + "NA-ER", + "NA-HA", + "NA-KA", + "NA-OK", + "NA-KH", + "NA-KU", + "NA-OW", + "NA-OH", + "NA-OS", + "NA-ON", + "NA-OT", + "NA-OD", + "NA-CA", + "NR", + "NR-01", + "NR-02", + "NR-03", + "NR-04", + "NR-05", + "NR-06", + "NR-07", + "NR-08", + "NR-09", + "NR-10", + "NR-11", + "NR-12", + "NR-13", + "NR-14", + "NP", + "NP-1", + "NP-4", + "NP-5", + "NP-2", + "NP-3", + "NL", + "NL-DR", + "NL-FL", + "NL-FR", + "NL-GE", + "NL-GR", + "NL-LI", + "NL-NB", + "NL-NH", + "NL-OV", + "NL-ZH", + "NL-UT", + "NL-ZE", + "NC", + "NZ", + "NZ-AUK", + "NZ-BOP", + "NZ-CAN", + "NZ-CIT", + "NZ-GIS", + "NZ-HKB", + "NZ-MWT", + "NZ-MBH", + "NZ-NSN", + "NZ-NTL", + "NZ-OTA", + "NZ-STL", + "NZ-TKI", + "NZ-TAS", + "NZ-WKO", + "NZ-WGN", + "NZ-WTC", + "NI", + "NI-AN", + "NI-AS", + "NI-BO", + "NI-CA", + "NI-CI", + "NI-CO", + "NI-ES", + "NI-GR", + "NI-JI", + "NI-LE", + "NI-MD", + "NI-MN", + "NI-MS", + "NI-MT", + "NI-NS", + "NI-SJ", + "NI-RI", + "NE", + "NE-1", + "NE-2", + "NE-3", + "NE-4", + "NE-8", + "NE-5", + "NE-6", + "NE-7", + "NG", + "NG-AB", + "NG-AD", + "NG-AK", + "NG-AN", + "NG-BA", + "NG-BY", + "NG-BE", + "NG-BO", + "NG-CR", + "NG-DE", + "NG-EB", + "NG-ED", + "NG-EK", + "NG-EN", + "NG-FC", + "NG-GO", + "NG-IM", + "NG-JI", + "NG-KD", + "NG-KN", + "NG-KT", + "NG-KE", + "NG-KO", + "NG-KW", + "NG-LA", + "NG-NA", + "NG-NI", + "NG-OG", + "NG-ON", + "NG-OS", + "NG-OY", + "NG-PL", + "NG-RI", + "NG-SO", + "NG-TA", + "NG-YO", + "NG-ZA", + "NU", + "NU-TOI", + "NF", + "KP", + "KP-04", + "KP-07", + "KP-09", + "KP-06", + "KP-03", + "KP-01", + "KP-13", + "KP-10", + "KP-08", + "KP-05", + "KP-02", + "MK", + "MK-07", + "MK-08", + "MK-78", + "MK-80", + "MK-23", + "MK-26", + "MK-19", + "MK-51", + "MK-53", + "MK-02", + "MK-03", + "MK-04", + "MK-05", + "MK-06", + "MK-81", + "MK-82", + "MK-21", + "MK-22", + "MK-25", + "MK-24", + "MK-27", + "MK-18", + "MK-20", + "MK-34", + "MK-35", + "MK-37", + "MK-36", + "MK-40", + "MK-42", + "MK-41", + "MK-43", + "MK-44", + "MK-45", + "MK-46", + "MK-47", + "MK-48", + "MK-49", + "MK-52", + "MK-50", + "MK-54", + "MK-55", + "MK-56", + "MK-60", + "MK-59", + "MK-61", + "MK-62", + "MK-65", + "MK-66", + "MK-67", + "MK-83", + "MK-70", + "MK-72", + "MK-11", + "MK-13", + "MK-12", + "MK-14", + "MK-31", + "MK-30", + "MK-33", + "MK-58", + "MK-63", + "MK-64", + "MK-85", + "MK-71", + "MK-73", + "MK-74", + "MK-69", + "MK-75", + "MK-76", + "MK-10", + "MK-16", + "MK-32", + "MP", + "NO", + "NO-02", + "NO-09", + "NO-06", + "NO-20", + "NO-04", + "NO-12", + "NO-15", + "NO-17", + "NO-18", + "NO-05", + "NO-03", + "NO-01", + "NO-11", + "NO-14", + "NO-16", + "NO-08", + "NO-19", + "NO-10", + "NO-07", + "OM", + "OM-DA", + "OM-ZA", + "OM-BS", + "OM-BJ", + "OM-BU", + "OM-WU", + "OM-SS", + "OM-SJ", + "OM-ZU", + "OM-MU", + "OM-MA", + "PK", + "PK-JK", + "PK-BA", + "PK-TA", + "PK-GB", + "PK-IS", + "PK-KP", + "PK-PB", + "PK-SD", + "PW", + "PW-002", + "PW-004", + "PW-010", + "PW-050", + "PW-100", + "PW-150", + "PW-212", + "PW-214", + "PW-218", + "PW-222", + "PW-227", + "PW-224", + "PW-226", + "PW-228", + "PW-350", + "PW-370", + "PS", + "PA", + "PA-1", + "PA-4", + "PA-2", + "PA-3", + "PA-5", + "PA-EM", + "PA-KY", + "PA-6", + "PA-7", + "PA-NB", + "PA-8", + "PA-9", + "PG", + "PG-NSB", + "PG-CPM", + "PG-CPK", + "PG-EBR", + "PG-ESW", + "PG-EHG", + "PG-EPW", + "PG-GPK", + "PG-JWK", + "PG-MPM", + "PG-MRL", + "PG-MBA", + "PG-MPL", + "PG-NCD", + "PG-NIK", + "PG-NPP", + "PG-SHM", + "PG-WBK", + "PG-SAN", + "PG-WHM", + "PG-WPD", + "PY", + "PY-16", + "PY-10", + "PY-13", + "PY-ASU", + "PY-19", + "PY-5", + "PY-6", + "PY-14", + "PY-11", + "PY-1", + "PY-3", + "PY-4", + "PY-7", + "PY-8", + "PY-12", + "PY-9", + "PY-15", + "PY-2", + "PE", + "PE-AMA", + "PE-ANC", + "PE-APU", + "PE-ARE", + "PE-AYA", + "PE-CAJ", + "PE-CAL", + "PE-CUS", + "PE-HUV", + "PE-HUC", + "PE-ICA", + "PE-JUN", + "PE-LAL", + "PE-LAM", + "PE-LIM", + "PE-LOR", + "PE-MDD", + "PE-MOQ", + "PE-PAS", + "PE-PIU", + "PE-PUN", + "PE-SAM", + "PE-TAC", + "PE-TUM", + "PE-UCA", + "PH", + "PH-14", + "PH-05", + "PH-02", + "PH-40", + "PH-13", + "PH-03", + "PH-07", + "PH-15", + "PH-11", + "PH-08", + "PH-01", + "PH-00", + "PH-41", + "PH-10", + "PH-12", + "PH-06", + "PH-09", + "PN", + "PL", + "PL-WP", + "PL-KP", + "PL-MA", + "PL-LD", + "PL-DS", + "PL-LU", + "PL-LB", + "PL-MZ", + "PL-OP", + "PL-PK", + "PL-PD", + "PL-PM", + "PL-SL", + "PL-SK", + "PL-WN", + "PL-ZP", + "PT", + "PT-01", + "PT-20", + "PT-02", + "PT-03", + "PT-04", + "PT-05", + "PT-06", + "PT-07", + "PT-08", + "PT-09", + "PT-10", + "PT-11", + "PT-30", + "PT-12", + "PT-13", + "PT-14", + "PT-15", + "PT-16", + "PT-17", + "PT-18", + "PR", + "QA", + "QA-ZA", + "QA-KH", + "QA-RA", + "QA-WA", + "QA-DA", + "QA-MS", + "QA-US", + "RE", + "RO", + "RO-AB", + "RO-AR", + "RO-AG", + "RO-BC", + "RO-BH", + "RO-BN", + "RO-BT", + "RO-BR", + "RO-BV", + "RO-B", + "RO-BZ", + "RO-CL", + "RO-CS", + "RO-CJ", + "RO-CT", + "RO-CV", + "RO-DB", + "RO-DJ", + "RO-GL", + "RO-GR", + "RO-GJ", + "RO-HR", + "RO-HD", + "RO-IL", + "RO-IS", + "RO-IF", + "RO-MM", + "RO-MH", + "RO-MS", + "RO-NT", + "RO-OT", + "RO-PH", + "RO-SJ", + "RO-SM", + "RO-SB", + "RO-SV", + "RO-TR", + "RO-TM", + "RO-TL", + "RO-VL", + "RO-VS", + "RO-VN", + "RU", + "RU-AD", + "RU-ALT", + "RU-AL", + "RU-AMU", + "RU-ARK", + "RU-AST", + "RU-BEL", + "RU-BRY", + "RU-BU", + "RU-CE", + "RU-CHE", + "RU-CHU", + "RU-CU", + "RU-DA", + "RU-IN", + "RU-IRK", + "RU-IVA", + "RU-YEV", + "RU-KB", + "RU-KGD", + "RU-KL", + "RU-KLU", + "RU-KAM", + "RU-KC", + "RU-KEM", + "RU-KHA", + "RU-KHM", + "RU-KIR", + "RU-KO", + "RU-KOS", + "RU-KDA", + "RU-KYA", + "RU-KGN", + "RU-KRS", + "RU-LEN", + "RU-LIP", + "RU-MAG", + "RU-ME", + "RU-MO", + "RU-MOW", + "RU-MOS", + "RU-MUR", + "RU-NEN", + "RU-NIZ", + "RU-SE", + "RU-NGR", + "RU-NVS", + "RU-OMS", + "RU-ORE", + "RU-ORL", + "RU-PNZ", + "RU-PER", + "RU-PRI", + "RU-PSK", + "RU-BA", + "RU-KR", + "RU-KK", + "RU-ROS", + "RU-RYA", + "RU-SPE", + "RU-SA", + "RU-SAK", + "RU-SAM", + "RU-SAR", + "RU-SMO", + "RU-STA", + "RU-SVE", + "RU-TAM", + "RU-TA", + "RU-TOM", + "RU-TUL", + "RU-TY", + "RU-TVE", + "RU-TYU", + "RU-UD", + "RU-ULY", + "RU-VLA", + "RU-VGG", + "RU-VLG", + "RU-VOR", + "RU-YAN", + "RU-YAR", + "RU-ZAB", + "RW", + "RW-02", + "RW-01", + "RW-03", + "RW-05", + "RW-04", + "WS", + "WS-AA", + "WS-AL", + "WS-AT", + "WS-FA", + "WS-GE", + "WS-GI", + "WS-PA", + "WS-SA", + "WS-TU", + "WS-VF", + "WS-VS", + "SM", + "SM-01", + "SM-06", + "SM-02", + "SM-03", + "SM-04", + "SM-05", + "SM-08", + "SM-07", + "SM-09", + "ST", + "ST-P", + "ST-S", + "SA", + "SA-11", + "SA-12", + "SA-03", + "SA-05", + "SA-14", + "SA-04", + "SA-06", + "SA-09", + "SA-02", + "SA-10", + "SA-08", + "SA-01", + "SA-07", + "SN", + "SN-DK", + "SN-DB", + "SN-FK", + "SN-KA", + "SN-KL", + "SN-KE", + "SN-KD", + "SN-LG", + "SN-MT", + "SN-SL", + "SN-SE", + "SN-TC", + "SN-TH", + "SN-ZG", + "RS", + "RS-VO", + "SC", + "SC-01", + "SC-02", + "SC-03", + "SC-05", + "SC-04", + "SC-06", + "SC-07", + "SC-08", + "SC-09", + "SC-10", + "SC-11", + "SC-12", + "SC-13", + "SC-14", + "SC-15", + "SC-16", + "SC-24", + "SC-17", + "SC-18", + "SC-19", + "SC-20", + "SC-21", + "SC-25", + "SC-22", + "SC-23", + "SL", + "SL-E", + "SL-N", + "SL-S", + "SL-W", + "SG", + "SX", + "SK", + "SK-BC", + "SK-BL", + "SK-KI", + "SK-NI", + "SK-PV", + "SK-TC", + "SK-TA", + "SK-ZI", + "SI", + "SB", + "SB-CT", + "SB-CE", + "SB-CH", + "SB-GU", + "SB-IS", + "SB-MK", + "SB-ML", + "SB-RB", + "SB-TE", + "SB-WE", + "SO", + "SO-AW", + "SO-BK", + "SO-BN", + "SO-BR", + "SO-BY", + "SO-GA", + "SO-GE", + "SO-HI", + "SO-JD", + "SO-JH", + "SO-MU", + "SO-NU", + "SO-SA", + "SO-SD", + "SO-SH", + "SO-SO", + "SO-TO", + "SO-WO", + "ZA", + "ZA-EC", + "ZA-FS", + "ZA-GT", + "ZA-NL", + "ZA-LP", + "ZA-MP", + "ZA-NW", + "ZA-NC", + "ZA-WC", + "GS", + "KR", + "KR-26", + "KR-43", + "KR-44", + "KR-27", + "KR-30", + "KR-42", + "KR-29", + "KR-41", + "KR-47", + "KR-48", + "KR-28", + "KR-49", + "KR-45", + "KR-46", + "KR-11", + "KR-31", + "SS", + "SS-UY", + "SS-LK", + "SS-EC", + "SS-EE", + "SS-JG", + "SS-BN", + "SS-NU", + "SS-WR", + "SS-BW", + "SS-EW", + "ES", + "ES-AN", + "ES-AR", + "ES-AS", + "ES-IB", + "ES-PV", + "ES-CN", + "ES-CB", + "ES-CL", + "ES-CM", + "ES-CT", + "ES-CE", + "ES-MD", + "ES-EX", + "ES-GA", + "ES-RI", + "ES-ML", + "ES-NC", + "ES-MC", + "ES-VC", + "LK", + "LK-2", + "LK-5", + "LK-7", + "LK-6", + "LK-4", + "LK-9", + "LK-3", + "LK-8", + "LK-1", + "BL", + "SH", + "SH-AC", + "SH-HL", + "SH-TA", + "KN", + "KN-01", + "KN-02", + "KN-03", + "KN-04", + "KN-05", + "KN-06", + "KN-07", + "KN-08", + "KN-09", + "KN-10", + "KN-11", + "KN-12", + "KN-13", + "KN-15", + "LC", + "LC-01", + "LC-02", + "LC-03", + "LC-04", + "LC-05", + "LC-06", + "LC-07", + "LC-08", + "LC-09", + "LC-10", + "LC-11", + "MF", + "PM", + "VC", + "VC-01", + "VC-06", + "VC-02", + "VC-03", + "VC-04", + "VC-05", + "SD", + "SD-GZ", + "SD-GD", + "SD-NB", + "SD-DW", + "SD-DS", + "SD-KA", + "SD-KH", + "SD-KN", + "SD-NO", + "SD-RS", + "SD-NR", + "SD-SI", + "SD-DN", + "SD-KS", + "SD-NW", + "SR", + "SR-BR", + "SR-CM", + "SR-CR", + "SR-MA", + "SR-NI", + "SR-PR", + "SR-PM", + "SR-SA", + "SR-SI", + "SR-WA", + "SJ", + "SE", + "SE-K", + "SE-W", + "SE-X", + "SE-I", + "SE-N", + "SE-Z", + "SE-F", + "SE-H", + "SE-G", + "SE-BD", + "SE-T", + "SE-E", + "SE-M", + "SE-D", + "SE-AB", + "SE-C", + "SE-S", + "SE-AC", + "SE-Y", + "SE-U", + "SE-O", + "CH", + "CH-AG", + "CH-AI", + "CH-AR", + "CH-BL", + "CH-BS", + "CH-BE", + "CH-FR", + "CH-GL", + "CH-JU", + "CH-NE", + "CH-OW", + "CH-SH", + "CH-SZ", + "CH-SO", + "CH-UR", + "CH-ZG", + "CH-GE", + "CH-GR", + "CH-LU", + "CH-NW", + "CH-SG", + "CH-TG", + "CH-TI", + "CH-VS", + "CH-VD", + "CH-ZH", + "SY", + "SY-HA", + "SY-HL", + "SY-RA", + "SY-SU", + "SY-DI", + "SY-DR", + "SY-DY", + "SY-HM", + "SY-HI", + "SY-ID", + "SY-LA", + "SY-QU", + "SY-RD", + "SY-TA", + "TW", + "TW-KHH", + "TW-TPQ", + "TW-TXG", + "TW-TNN", + "TW-TPE", + "TW-TAO", + "TJ", + "TJ-RR", + "TJ-GB", + "TJ-KT", + "TJ-SU", + "TZ", + "TZ-01", + "TZ-03", + "TZ-04", + "TZ-05", + "TZ-08", + "TZ-09", + "TZ-12", + "TZ-26", + "TZ-13", + "TZ-14", + "TZ-16", + "TZ-17", + "TZ-18", + "TZ-06", + "TZ-10", + "TZ-19", + "TZ-20", + "TZ-21", + "TZ-22", + "TZ-23", + "TZ-24", + "TZ-25", + "TZ-11", + "TZ-07", + "TZ-15", + "TH", + "TH-37", + "TH-15", + "TH-10", + "TH-38", + "TH-31", + "TH-24", + "TH-18", + "TH-36", + "TH-22", + "TH-50", + "TH-57", + "TH-20", + "TH-86", + "TH-46", + "TH-62", + "TH-71", + "TH-40", + "TH-81", + "TH-52", + "TH-51", + "TH-42", + "TH-16", + "TH-58", + "TH-44", + "TH-49", + "TH-26", + "TH-73", + "TH-48", + "TH-30", + "TH-60", + "TH-80", + "TH-55", + "TH-96", + "TH-39", + "TH-43", + "TH-12", + "TH-13", + "TH-94", + "TH-82", + "TH-93", + "TH-56", + "TH-67", + "TH-76", + "TH-66", + "TH-65", + "TH-14", + "TH-54", + "TH-83", + "TH-25", + "TH-77", + "TH-85", + "TH-70", + "TH-21", + "TH-45", + "TH-27", + "TH-47", + "TH-11", + "TH-74", + "TH-75", + "TH-19", + "TH-91", + "TH-33", + "TH-17", + "TH-90", + "TH-64", + "TH-72", + "TH-84", + "TH-32", + "TH-63", + "TH-92", + "TH-23", + "TH-34", + "TH-41", + "TH-61", + "TH-53", + "TH-95", + "TH-35", + "TL", + "TL-AL", + "TL-AN", + "TL-BA", + "TL-BO", + "TL-CO", + "TL-DI", + "TL-ER", + "TL-LA", + "TL-LI", + "TL-MT", + "TL-MF", + "TL-OE", + "TL-VI", + "TG", + "TG-C", + "TG-K", + "TG-M", + "TG-P", + "TG-S", + "TK", + "TO", + "TO-01", + "TO-02", + "TO-03", + "TO-04", + "TO-05", + "TT", + "TT-ARI", + "TT-CHA", + "TT-CTT", + "TT-DMN", + "TT-ETO", + "TT-PED", + "TT-PTF", + "TT-POS", + "TT-PRT", + "TT-RCM", + "TT-SFO", + "TT-SJL", + "TT-SGE", + "TT-SIP", + "TT-TUP", + "TT-WTO", + "TN", + "TN-12", + "TN-31", + "TN-13", + "TN-23", + "TN-81", + "TN-71", + "TN-32", + "TN-41", + "TN-42", + "TN-73", + "TN-33", + "TN-14", + "TN-53", + "TN-82", + "TN-52", + "TN-21", + "TN-61", + "TN-43", + "TN-34", + "TN-51", + "TN-83", + "TN-72", + "TN-11", + "TN-22", + "TR", + "TR-01", + "TR-02", + "TR-03", + "TR-04", + "TR-68", + "TR-05", + "TR-06", + "TR-07", + "TR-75", + "TR-08", + "TR-09", + "TR-10", + "TR-74", + "TR-72", + "TR-69", + "TR-11", + "TR-12", + "TR-13", + "TR-14", + "TR-15", + "TR-16", + "TR-17", + "TR-18", + "TR-19", + "TR-20", + "TR-21", + "TR-81", + "TR-22", + "TR-23", + "TR-24", + "TR-25", + "TR-26", + "TR-27", + "TR-28", + "TR-29", + "TR-30", + "TR-31", + "TR-76", + "TR-32", + "TR-34", + "TR-35", + "TR-46", + "TR-78", + "TR-70", + "TR-36", + "TR-37", + "TR-38", + "TR-79", + "TR-71", + "TR-39", + "TR-40", + "TR-41", + "TR-42", + "TR-43", + "TR-44", + "TR-45", + "TR-47", + "TR-33", + "TR-48", + "TR-49", + "TR-50", + "TR-51", + "TR-52", + "TR-80", + "TR-53", + "TR-54", + "TR-55", + "TR-63", + "TR-56", + "TR-57", + "TR-58", + "TR-73", + "TR-59", + "TR-60", + "TR-61", + "TR-62", + "TR-64", + "TR-65", + "TR-77", + "TR-66", + "TR-67", + "TM", + "TM-A", + "TM-S", + "TM-B", + "TM-D", + "TM-L", + "TM-M", + "TC", + "TV", + "TV-FUN", + "TV-NMG", + "TV-NMA", + "TV-NIT", + "TV-NIU", + "TV-NKF", + "TV-NKL", + "TV-VAI", + "UM", + "VI", + "UG", + "UG-C", + "UG-E", + "UG-N", + "UG-W", + "UA", + "UA-71", + "UA-74", + "UA-77", + "UA-43", + "UA-12", + "UA-14", + "UA-26", + "UA-63", + "UA-65", + "UA-68", + "UA-35", + "UA-30", + "UA-32", + "UA-09", + "UA-46", + "UA-48", + "UA-51", + "UA-53", + "UA-56", + "UA-40", + "UA-59", + "UA-61", + "UA-05", + "UA-07", + "UA-21", + "UA-23", + "UA-18", + "AE", + "AE-AZ", + "AE-AJ", + "AE-DU", + "AE-FU", + "AE-RK", + "AE-SH", + "AE-UQ", + "GB", + "GB-ENG", + "GB-NIR", + "GB-SCT", + "GB-WLS", + "US", + "US-AL", + [ + "630", + "Birmingham AL" + ], + [ + "522", + "Columbus GA" + ], + [ + "606", + "Dothan AL" + ], + [ + "691", + "Huntsville-Decatur (Florence) AL" + ], + [ + "711", + "Meridian MS" + ], + [ + "686", + "Mobile AL-Pensacola (Ft. Walton Beach) FL" + ], + [ + "698", + "Montgomery (Selma) AL" + ], + "US-AK", + [ + "743", + "Anchorage AK" + ], + [ + "745", + "Fairbanks AK" + ], + [ + "747", + "Juneau AK" + ], + "US-AZ", + [ + "753", + "Phoenix AZ" + ], + [ + "789", + "Tucson (Sierra Vista) AZ" + ], + [ + "771", + "Yuma AZ-El Centro CA" + ], + "US-AR", + [ + "670", + "Ft. Smith-Fayetteville-Springdale-Rogers AR" + ], + [ + "734", + "Jonesboro AR" + ], + [ + "693", + "Little Rock-Pine Bluff AR" + ], + [ + "640", + "Memphis TN" + ], + [ + "628", + "Monroe LA-El Dorado AR" + ], + [ + "612", + "Shreveport LA" + ], + [ + "619", + "Springfield MO" + ], + "US-CA", + [ + "800", + "Bakersfield CA" + ], + [ + "868", + "Chico-Redding CA" + ], + [ + "802", + "Eureka CA" + ], + [ + "866", + "Fresno-Visalia CA" + ], + [ + "803", + "Los Angeles CA" + ], + [ + "813", + "Medford-Klamath Falls OR" + ], + [ + "828", + "Monterey-Salinas CA" + ], + [ + "804", + "Palm Springs CA" + ], + [ + "811", + "Reno NV" + ], + [ + "862", + "Sacramento-Stockton-Modesto CA" + ], + [ + "825", + "San Diego CA" + ], + [ + "807", + "San Francisco-Oakland-San Jose CA" + ], + [ + "855", + "Santa Barbara-Santa Maria-San Luis Obispo CA" + ], + "US-CO", + [ + "752", + "Colorado Springs-Pueblo CO" + ], + [ + "751", + "Denver CO" + ], + [ + "773", + "Grand Junction-Montrose CO" + ], + "US-CT", + [ + "533", + "Hartford & New Haven CT" + ], + "US-DE", + [ + "504", + "Philadelphia PA" + ], + [ + "576", + "Salisbury MD" + ], + "US-DC", + "US-FL", + [ + "571", + "Ft. Myers-Naples FL" + ], + [ + "592", + "Gainesville FL" + ], + [ + "561", + "Jacksonville FL" + ], + [ + "528", + "Miami-Ft. Lauderdale FL" + ], + [ + "534", + "Orlando-Daytona Beach-Melbourne FL" + ], + [ + "656", + "Panama City FL" + ], + [ + "530", + "Tallahassee FL-Thomasville GA" + ], + [ + "539", + "Tampa-St. Petersburg (Sarasota) FL" + ], + [ + "548", + "West Palm Beach-Ft. Pierce FL" + ], + "US-GA", + [ + "525", + "Albany GA" + ], + [ + "524", + "Atlanta GA" + ], + [ + "520", + "Augusta GA" + ], + [ + "575", + "Chattanooga TN" + ], + [ + "503", + "Macon GA" + ], + [ + "507", + "Savannah GA" + ], + "US-HI", + [ + "744", + "Honolulu HI" + ], + "US-ID", + [ + "757", + "Boise ID" + ], + [ + "758", + "Idaho Falls-Pocatello ID" + ], + [ + "881", + "Spokane WA" + ], + [ + "760", + "Twin Falls ID" + ], + "US-IL", + [ + "648", + "Champaign & Springfield-Decatur IL" + ], + [ + "602", + "Chicago IL" + ], + [ + "682", + "Davenport IA-Rock Island-Moline IL" + ], + [ + "649", + "Evansville IN" + ], + [ + "632", + "Paducah KY-Cape Girardeau MO-Harrisburg-Mount Vernon IL" + ], + [ + "675", + "Peoria-Bloomington IL" + ], + [ + "717", + "Quincy IL-Hannibal MO-Keokuk IA" + ], + [ + "610", + "Rockford IL" + ], + [ + "609", + "St. Louis MO" + ], + [ + "581", + "Terre Haute IN" + ], + "US-IN", + [ + "515", + "Cincinnati OH" + ], + [ + "509", + "Ft. Wayne IN" + ], + [ + "527", + "Indianapolis IN" + ], + [ + "582", + "Lafayette IN" + ], + [ + "529", + "Louisville KY" + ], + [ + "588", + "South Bend-Elkhart IN" + ], + "US-IA", + [ + "637", + "Cedar Rapids-Waterloo-Iowa City & Dubuque IA" + ], + [ + "679", + "Des Moines-Ames IA" + ], + [ + "652", + "Omaha NE" + ], + [ + "631", + "Ottumwa IA-Kirksville MO" + ], + [ + "611", + "Rochester MN-Mason City IA-Austin MN" + ], + [ + "624", + "Sioux City IA" + ], + "US-KS", + [ + "603", + "Joplin MO-Pittsburg KS" + ], + [ + "616", + "Kansas City MO" + ], + [ + "638", + "St. Joseph MO" + ], + [ + "605", + "Topeka KS" + ], + [ + "678", + "Wichita-Hutchinson KS" + ], + "US-KY", + [ + "736", + "Bowling Green KY" + ], + [ + "564", + "Charleston-Huntington WV" + ], + [ + "557", + "Knoxville TN" + ], + [ + "541", + "Lexington KY" + ], + [ + "659", + "Nashville TN" + ], + [ + "531", + "Tri-Cities TN-VA" + ], + "US-LA", + [ + "644", + "Alexandria LA" + ], + [ + "716", + "Baton Rouge LA" + ], + [ + "642", + "Lafayette LA" + ], + [ + "643", + "Lake Charles LA" + ], + [ + "622", + "New Orleans LA" + ], + "US-ME", + [ + "537", + "Bangor ME" + ], + [ + "500", + "Portland-Auburn ME" + ], + [ + "552", + "Presque Isle ME" + ], + "US-MD", + [ + "512", + "Baltimore MD" + ], + [ + "511", + "Washington DC (Hagerstown MD)" + ], + "US-MA", + [ + "506", + "Boston MA-Manchester NH" + ], + [ + "521", + "Providence RI-New Bedford MA" + ], + [ + "543", + "Springfield-Holyoke MA" + ], + "US-MI", + [ + "583", + "Alpena MI" + ], + [ + "505", + "Detroit MI" + ], + [ + "513", + "Flint-Saginaw-Bay City MI" + ], + [ + "563", + "Grand Rapids-Kalamazoo-Battle Creek MI" + ], + [ + "551", + "Lansing MI" + ], + [ + "553", + "Marquette MI" + ], + [ + "547", + "Toledo OH" + ], + [ + "540", + "Traverse City-Cadillac MI" + ], + "US-MN", + [ + "676", + "Duluth MN-Superior WI" + ], + [ + "724", + "Fargo-Valley City ND" + ], + [ + "702", + "La Crosse-Eau Claire WI" + ], + [ + "737", + "Mankato MN" + ], + [ + "613", + "Minneapolis-St. Paul MN" + ], + "US-MS", + [ + "746", + "Biloxi-Gulfport MS" + ], + [ + "673", + "Columbus-Tupelo-West Point MS" + ], + [ + "647", + "Greenwood-Greenville MS" + ], + [ + "710", + "Hattiesburg-Laurel MS" + ], + [ + "718", + "Jackson MS" + ], + "US-MO", + [ + "604", + "Columbia-Jefferson City MO" + ], + "US-MT", + [ + "756", + "Billings, MT" + ], + [ + "754", + "Butte-Bozeman MT" + ], + [ + "798", + "Glendive MT" + ], + [ + "755", + "Great Falls MT" + ], + [ + "766", + "Helena MT" + ], + [ + "687", + "Minot-Bismarck-Dickinson(Williston) ND" + ], + [ + "762", + "Missoula MT" + ], + "US-NE", + [ + "759", + "Cheyenne WY-Scottsbluff NE" + ], + [ + "722", + "Lincoln & Hastings-Kearney NE" + ], + [ + "740", + "North Platte NE" + ], + [ + "725", + "Sioux Falls(Mitchell) SD" + ], + "US-NV", + [ + "839", + "Las Vegas NV" + ], + [ + "770", + "Salt Lake City UT" + ], + "US-NH", + [ + "523", + "Burlington VT-Plattsburgh NY" + ], + "US-NJ", + [ + "501", + "New York NY" + ], + "US-NM", + [ + "790", + "Albuquerque-Santa Fe NM" + ], + [ + "634", + "Amarillo TX" + ], + [ + "765", + "El Paso TX" + ], + "US-NY", + [ + "532", + "Albany-Schenectady-Troy NY" + ], + [ + "502", + "Binghamton NY" + ], + [ + "514", + "Buffalo NY" + ], + [ + "565", + "Elmira NY" + ], + [ + "538", + "Rochester NY" + ], + [ + "555", + "Syracuse NY" + ], + [ + "526", + "Utica NY" + ], + [ + "549", + "Watertown NY" + ], + "US-NC", + [ + "517", + "Charlotte NC" + ], + [ + "570", + "Florence-Myrtle Beach SC" + ], + [ + "518", + "Greensboro-High Point-Winston Salem NC" + ], + [ + "545", + "Greenville-New Bern-Washington NC" + ], + [ + "567", + "Greenville-Spartanburg SC-Asheville NC-Anderson SC" + ], + [ + "544", + "Norfolk-Portsmouth-Newport News VA" + ], + [ + "560", + "Raleigh-Durham (Fayetteville) NC" + ], + [ + "550", + "Wilmington NC" + ], + "US-ND", + "US-OH", + [ + "510", + "Cleveland-Akron (Canton) OH" + ], + [ + "535", + "Columbus OH" + ], + [ + "542", + "Dayton OH" + ], + [ + "558", + "Lima OH" + ], + [ + "597", + "Parkersburg WV" + ], + [ + "554", + "Wheeling WV-Steubenville OH" + ], + [ + "536", + "Youngstown OH" + ], + [ + "596", + "Zanesville OH" + ], + "US-OK", + [ + "650", + "Oklahoma City OK" + ], + [ + "657", + "Sherman TX-Ada OK" + ], + [ + "671", + "Tulsa OK" + ], + [ + "627", + "Wichita Falls TX & Lawton OK" + ], + "US-OR", + [ + "821", + "Bend OR" + ], + [ + "801", + "Eugene OR" + ], + [ + "820", + "Portland OR" + ], + [ + "810", + "Yakima-Pasco-Richland-Kennewick WA" + ], + "US-PA", + [ + "516", + "Erie PA" + ], + [ + "566", + "Harrisburg-Lancaster-Lebanon-York PA" + ], + [ + "574", + "Johnstown-Altoona PA" + ], + [ + "508", + "Pittsburgh PA" + ], + [ + "577", + "Wilkes Barre-Scranton PA" + ], + "US-RI", + "US-SC", + [ + "519", + "Charleston SC" + ], + [ + "546", + "Columbia SC" + ], + "US-SD", + [ + "764", + "Rapid City SD" + ], + "US-TN", + [ + "639", + "Jackson TN" + ], + "US-TX", + [ + "662", + "Abilene-Sweetwater TX" + ], + [ + "635", + "Austin TX" + ], + [ + "692", + "Beaumont-Port Arthur TX" + ], + [ + "600", + "Corpus Christi TX" + ], + [ + "623", + "Dallas-Ft. Worth TX" + ], + [ + "636", + "Harlingen-Weslaco-Brownsville-McAllen TX" + ], + [ + "618", + "Houston TX" + ], + [ + "749", + "Laredo TX" + ], + [ + "651", + "Lubbock TX" + ], + [ + "633", + "Odessa-Midland TX" + ], + [ + "661", + "San Angelo TX" + ], + [ + "641", + "San Antonio TX" + ], + [ + "709", + "Tyler-Longview(Lufkin & Nacogdoches) TX" + ], + [ + "626", + "Victoria TX" + ], + [ + "625", + "Waco-Temple-Bryan TX" + ], + "US-UT", + "US-VT", + "US-VA", + [ + "559", + "Bluefield-Beckley-Oak Hill WV" + ], + [ + "584", + "Charlottesville VA" + ], + [ + "569", + "Harrisonburg VA" + ], + [ + "556", + "Richmond-Petersburg VA" + ], + [ + "573", + "Roanoke-Lynchburg VA" + ], + "US-WA", + [ + "819", + "Seattle-Tacoma WA" + ], + "US-WV", + [ + "598", + "Clarksburg-Weston WV" + ], + "US-WI", + [ + "658", + "Green Bay-Appleton WI" + ], + [ + "669", + "Madison WI" + ], + [ + "617", + "Milwaukee WI" + ], + [ + "705", + "Wausau-Rhinelander WI" + ], + "US-WY", + [ + "767", + "Casper-Riverton WY" + ], + "UY", + "UY-AR", + "UY-CA", + "UY-CL", + "UY-CO", + "UY-DU", + "UY-FS", + "UY-FD", + "UY-LA", + "UY-MA", + "UY-MO", + "UY-PA", + "UY-RN", + "UY-RV", + "UY-RO", + "UY-SA", + "UY-SJ", + "UY-SO", + "UY-TA", + "UY-TT", + "UZ", + "UZ-AN", + "UZ-BU", + "UZ-FA", + "UZ-JI", + "UZ-QA", + "UZ-XO", + "UZ-NG", + "UZ-NW", + "UZ-QR", + "UZ-SA", + "UZ-SI", + "UZ-SU", + "UZ-TO", + "VU", + "VU-MAP", + "VU-PAM", + "VU-SAM", + "VU-SEE", + "VU-TAE", + "VU-TOB", + "VA", + "VE", + "VE-Z", + "VE-B", + "VE-C", + "VE-D", + "VE-E", + "VE-F", + "VE-A", + "VE-G", + "VE-H", + "VE-Y", + "VE-I", + "VE-W", + "VE-J", + "VE-K", + "VE-L", + "VE-M", + "VE-N", + "VE-O", + "VE-P", + "VE-R", + "VE-S", + "VE-T", + "VE-X", + "VE-U", + "VE-V", + "VN", + "VN-44", + "VN-43", + "VN-54", + "VN-53", + "VN-55", + "VN-56", + "VN-50", + "VN-31", + "VN-57", + "VN-58", + "VN-40", + "VN-59", + "VN-CT", + "VN-04", + "VN-DN", + "VN-33", + "VN-72", + "VN-71", + "VN-39", + "VN-45", + "VN-30", + "VN-03", + "VN-63", + "VN-23", + "VN-61", + "VN-HP", + "VN-HN", + "VN-73", + "VN-SG", + "VN-14", + "VN-66", + "VN-34", + "VN-47", + "VN-28", + "VN-01", + "VN-35", + "VN-09", + "VN-02", + "VN-41", + "VN-67", + "VN-22", + "VN-18", + "VN-36", + "VN-68", + "VN-32", + "VN-24", + "VN-27", + "VN-29", + "VN-13", + "VN-25", + "VN-52", + "VN-05", + "VN-37", + "VN-20", + "VN-69", + "VN-21", + "VN-26", + "VN-46", + "VN-51", + "VN-07", + "VN-49", + "VN-70", + "VN-06", + "WF", + "WF-ALO", + "EH", + "YE", + "YE-AM", + "YE-AB", + "YE-DA", + "YE-AD", + "YE-BA", + "YE-HU", + "YE-JA", + "YE-MR", + "YE-MW", + "YE-SA", + "YE-DH", + "YE-HD", + "YE-HJ", + "YE-IB", + "YE-LA", + "YE-MA", + "YE-RA", + "YE-SD", + "YE-SN", + "YE-SH", + "YE-TA", + "ZM", + "ZM-02", + "ZM-08", + "ZM-03", + "ZM-04", + "ZM-09", + "ZM-06", + "ZM-05", + "ZM-07", + "ZM-01", + "ZW", + "ZW-BU", + "ZW-HA", + "ZW-MA", + "ZW-MC", + "ZW-ME", + "ZW-MW", + "ZW-MV", + "ZW-MN", + "ZW-MS", + "ZW-MI" + ], + "description": "Parameter defines the location from where you want the search to originate. It defaults to `Worldwide` (activated when the value of geo parameter is not set or empty). Head to the Google Trends Locations for a full list of supported Google Trends locations.", + "group": "geographic_location" + }, + "region": { + "type": "select", + "options": [ + "COUNTRY", + "REGION", + "DMA", + "CITY" + ], + "description": "Parameter is used for getting more specific results when using \"Compared breakdown by region\" and \"Interest by region\" data_type charts. Other data_type charts do not accept region parameter. The default value depends on the geo location that is set. Available options: `COUNTRY` - Country `REGION` - Subregion `DMA` - Metro `CITY` - City Not all region options will return results for every geo location.", + "group": "geographic_location" + }, + "data_type": { + "type": "select", + "options": [ + "TIMESERIES", + "GEO_MAP", + "GEO_MAP_0", + "RELATED_TOPICS", + "RELATED_QUERIES" + ], + "description": "Parameter defines the type of search you want to do. Available options: `TIMESERIES` - Interest over time (default) - Accepts both single and multiple queries per search. `GEO_MAP` - Compared breakdown by region - Accepts only multiple queries per search. `GEO_MAP_0` - Interest by region - Accepts only single query per search. `RELATED_TOPICS` - Related topics - Accepts only single query per search. `RELATED_QUERIES` - Related queries - Accepts only single query per search.", + "group": "search_type" + }, + "tz": { + "type": "number", + "description": "Parameter is used to define a time zone offset. The default value is set to `420` (Pacific Day Time(PDT): -07:00). Value is shown in minutes and can span from `-1439` to `1439`. tz can be calculated using the time difference between UTC +0 and desired timezone. Examples: `420` - PDT `600` - Pacific/Tahiti `-540` - Asia/Tokyo `-480` - Canada/Pacific. To make sure the value is correct, please refer to the time zone database and your programming language UTC offset calculation. You may visit the documentation to get more information.", + "group": "advanced_google_trends_parameters" + }, + "cat": { + "type": "select", + "options": [ + [ + "0", + "All categories" + ], + [ + "3", + "Arts & Entertainment" + ], + [ + "5", + "Computers & Electronics" + ], + [ + "7", + "Finance" + ], + [ + "8", + "Games" + ], + [ + "11", + "Home & Garden" + ], + [ + "12", + "Business & Industrial" + ], + [ + "13", + "Internet & Telecom" + ], + [ + "14", + "People & Society" + ], + [ + "16", + "News" + ], + [ + "18", + "Shopping" + ], + [ + "19", + "Law & Government" + ], + [ + "20", + "Sports" + ], + [ + "22", + "Books & Literature" + ], + [ + "23", + "Performing Arts" + ], + [ + "24", + "Visual Art & Design" + ], + [ + "25", + "Advertising & Marketing" + ], + [ + "28", + "Office Services" + ], + [ + "29", + "Real Estate" + ], + [ + "30", + "Computer Hardware" + ], + [ + "31", + "Programming" + ], + [ + "32", + "Software" + ], + [ + "33", + "Offbeat" + ], + [ + "34", + "Movies" + ], + [ + "35", + "Music & Audio" + ], + [ + "36", + "TV & Video" + ], + [ + "37", + "Banking" + ], + [ + "38", + "Insurance" + ], + [ + "39", + "Card Games" + ], + [ + "41", + "Computer & Video Games" + ], + [ + "42", + "Jazz" + ], + [ + "43", + "Online Goodies" + ], + [ + "44", + "Beauty & Fitness" + ], + [ + "45", + "Health" + ], + [ + "46", + "Agriculture & Forestry" + ], + [ + "47", + "Autos & Vehicles" + ], + [ + "48", + "Construction & Maintenance" + ], + [ + "49", + "Manufacturing" + ], + [ + "50", + "Transportation & Logistics" + ], + [ + "53", + "Web Hosting & Domain Registration" + ], + [ + "54", + "Social Issues & Advocacy" + ], + [ + "55", + "Dating & Personals" + ], + [ + "56", + "Ethnic & Identity Groups" + ], + [ + "57", + "Charity & Philanthropy" + ], + [ + "58", + "Parenting" + ], + [ + "59", + "Religion & Belief" + ], + [ + "60", + "Jobs" + ], + [ + "61", + "Classifieds" + ], + [ + "63", + "Weather" + ], + [ + "64", + "Antiques & Collectibles" + ], + [ + "65", + "Hobbies & Leisure" + ], + [ + "66", + "Pets & Animals" + ], + [ + "67", + "Travel" + ], + [ + "68", + "Apparel" + ], + [ + "69", + "Consumer Resources" + ], + [ + "70", + "Gifts & Special Event Items" + ], + [ + "71", + "Food & Drink" + ], + [ + "73", + "Mass Merchants & Department Stores" + ], + [ + "74", + "Education" + ], + [ + "75", + "Legal" + ], + [ + "76", + "Government" + ], + [ + "77", + "Enterprise Technology" + ], + [ + "78", + "Consumer Electronics" + ], + [ + "82", + "Environmental Issues" + ], + [ + "83", + "Marketing Services" + ], + [ + "84", + "Search Engine Optimization & Marketing" + ], + [ + "89", + "Vehicle Parts & Accessories" + ], + [ + "91", + "Stereo Systems & Components" + ], + [ + "93", + "Skin & Nail Care" + ], + [ + "94", + "Fitness" + ], + [ + "95", + "Office Supplies" + ], + [ + "96", + "Real Estate Agencies" + ], + [ + "97", + "Consumer Advocacy & Protection" + ], + [ + "98", + "Fashion Designers & Collections" + ], + [ + "99", + "Gifts" + ], + [ + "100", + "Cards & Greetings" + ], + [ + "101", + "Spirituality" + ], + [ + "102", + "Personals" + ], + [ + "104", + "ISPs" + ], + [ + "105", + "Online Games" + ], + [ + "107", + "Investing" + ], + [ + "108", + "Language Resources" + ], + [ + "112", + "Broadcast & Network News" + ], + [ + "113", + "Gay-Lesbian-Bisexual-Transgender" + ], + [ + "115", + "Baby Care & Hygiene" + ], + [ + "118", + "Water Sports" + ], + [ + "119", + "Wildlife" + ], + [ + "120", + "Cookware & Diningware" + ], + [ + "121", + "Grocery & Food Retailers" + ], + [ + "122", + "Cooking & Recipes" + ], + [ + "123", + "Tobacco Products" + ], + [ + "124", + "Clothing Accessories" + ], + [ + "137", + "Homemaking & Interior Decor" + ], + [ + "138", + "Vehicle Maintenance" + ], + [ + "143", + "Face & Body Care" + ], + [ + "144", + "Unwanted Body & Facial Hair Removal" + ], + [ + "145", + "Spas & Beauty Services" + ], + [ + "146", + "Hair Care" + ], + [ + "147", + "Cosmetology & Beauty Professionals" + ], + [ + "148", + "Off-Road Vehicles" + ], + [ + "154", + "Kids & Teens" + ], + [ + "157", + "Human Resources" + ], + [ + "158", + "Home Improvement" + ], + [ + "166", + "Public Safety" + ], + [ + "168", + "Emergency Services" + ], + [ + "170", + "Vehicle Licensing & Registration" + ], + [ + "171", + "Native Americans" + ], + [ + "174", + "Science" + ], + [ + "179", + "Hotels & Accommodations" + ], + [ + "180", + "Motor Sports" + ], + [ + "182", + "Humor" + ], + [ + "184", + "Celebrities & Entertainment News" + ], + [ + "185", + "Fashion & Style" + ], + [ + "188", + "Clubs & Nightlife" + ], + [ + "189", + "Clubs & Organizations" + ], + [ + "191", + "Forum & Chat Providers" + ], + [ + "195", + "Reproductive Health" + ], + [ + "198", + "Birth Control" + ], + [ + "202", + "Erectile Dysfunction" + ], + [ + "203", + "Air Travel" + ], + [ + "205", + "Car Rental & Taxi Services" + ], + [ + "206", + "Cruises & Charters" + ], + [ + "208", + "Tourist Destinations" + ], + [ + "210", + "DVD & Video Shopping" + ], + [ + "211", + "Online Video" + ], + [ + "213", + "Movie Memorabilia" + ], + [ + "215", + "Radio" + ], + [ + "216", + "Musical Instruments" + ], + [ + "217", + "CD & Audio Shopping" + ], + [ + "218", + "Music Art & Memorabilia" + ], + [ + "220", + "Music Streams & Downloads" + ], + [ + "224", + "Software Utilities" + ], + [ + "225", + "Device Drivers" + ], + [ + "226", + "Computer Memory" + ], + [ + "227", + "MP3 & Portable Media Players" + ], + [ + "228", + "PDAs & Handhelds" + ], + [ + "229", + "TV & Video Equipment" + ], + [ + "230", + "Car Audio" + ], + [ + "231", + "Engineering & Technology" + ], + [ + "233", + "Energy & Utilities" + ], + [ + "234", + "Make-Up & Cosmetics" + ], + [ + "235", + "Hair Loss" + ], + [ + "236", + "Weight Loss" + ], + [ + "237", + "Vitamins & Supplements" + ], + [ + "238", + "Cosmetic Surgery" + ], + [ + "239", + "Body Art" + ], + [ + "241", + "Bodybuilding" + ], + [ + "242", + "Perfumes & Fragrances" + ], + [ + "244", + "Hygiene & Toiletries" + ], + [ + "245", + "Oral & Dental Care" + ], + [ + "246", + "Vision Care" + ], + [ + "248", + "Pharmacy" + ], + [ + "249", + "Health Insurance" + ], + [ + "250", + "Hospitals & Treatment Centers" + ], + [ + "251", + "Medical Devices & Equipment" + ], + [ + "252", + "Health Foundations & Medical Research" + ], + [ + "253", + "Medical Literature & Resources" + ], + [ + "254", + "Health Education & Medical Training" + ], + [ + "255", + "Pharmaceuticals & Biotech" + ], + [ + "256", + "Medical Facilities & Services" + ], + [ + "257", + "Substance Abuse" + ], + [ + "258", + "American Football" + ], + [ + "259", + "Baseball" + ], + [ + "260", + "Hockey" + ], + [ + "261", + "Golf" + ], + [ + "262", + "Racquet Sports" + ], + [ + "263", + "Sporting Goods" + ], + [ + "264", + "Basketball" + ], + [ + "265", + "Winter Sports" + ], + [ + "268", + "Maps" + ], + [ + "269", + "Gardening & Landscaping" + ], + [ + "270", + "Home Furnishings" + ], + [ + "271", + "Home Appliances" + ], + [ + "272", + "Lamps & Lighting" + ], + [ + "273", + "Motorcycles" + ], + [ + "275", + "Photo & Video Sharing" + ], + [ + "276", + "Restaurants" + ], + [ + "277", + "Alcoholic Beverages" + ], + [ + "278", + "Accounting & Auditing" + ], + [ + "279", + "Credit & Lending" + ], + [ + "280", + "Merchant Services & Payment Systems" + ], + [ + "284", + "Crafts" + ], + [ + "287", + "Industrial Materials & Equipment" + ], + [ + "288", + "Chemicals Industry" + ], + [ + "289", + "Freight & Trucking" + ], + [ + "290", + "Packaging" + ], + [ + "291", + "Moving & Relocation" + ], + [ + "292", + "Auctions" + ], + [ + "293", + "Weddings" + ], + [ + "294", + "Soccer" + ], + [ + "296", + "Cricket" + ], + [ + "297", + "Culinary Training" + ], + [ + "298", + "Seniors & Retirement" + ], + [ + "299", + "Online Communities" + ], + [ + "301", + "Web Portals" + ], + [ + "302", + "Web Services" + ], + [ + "303", + "Operating Systems" + ], + [ + "304", + "Internet Clients & Browsers" + ], + [ + "305", + "Televisions" + ], + [ + "306", + "Cameras & Camcorders" + ], + [ + "307", + "Cameras" + ], + [ + "308", + "Camcorders" + ], + [ + "309", + "Desktop Computers" + ], + [ + "310", + "Laptops & Notebooks" + ], + [ + "311", + "Networking" + ], + [ + "312", + "Computer Peripherals" + ], + [ + "313", + "Open Source" + ], + [ + "314", + "Computer Security" + ], + [ + "315", + "Antivirus & Malware" + ], + [ + "316", + "Comics & Animation" + ], + [ + "317", + "Anime & Manga" + ], + [ + "318", + "Comics" + ], + [ + "319", + "Cartoons" + ], + [ + "320", + "Photo Rating Sites" + ], + [ + "321", + "File Sharing & Hosting" + ], + [ + "323", + "Flowers" + ], + [ + "324", + "Party & Holiday Supplies" + ], + [ + "326", + "Affiliate Programs" + ], + [ + "327", + "Public Relations" + ], + [ + "328", + "Telemarketing" + ], + [ + "329", + "Business Services" + ], + [ + "330", + "Recruitment & Staffing" + ], + [ + "331", + "Corporate Training" + ], + [ + "332", + "Document & Printing Services" + ], + [ + "333", + "Office Furniture" + ], + [ + "334", + "Corporate Events" + ], + [ + "335", + "Trade Shows & Conventions" + ], + [ + "336", + "Business Plans & Presentations" + ], + [ + "337", + "Office & Facilities Management" + ], + [ + "338", + "Management" + ], + [ + "340", + "E-Commerce Services" + ], + [ + "341", + "Customer Relationship Management (CRM)" + ], + [ + "342", + "Enterprise Resource Planning (ERP)" + ], + [ + "343", + "Data Management" + ], + [ + "344", + "Network Security" + ], + [ + "346", + "Networking Equipment" + ], + [ + "347", + "Network Monitoring & Management" + ], + [ + "350", + "Gems & Jewelry" + ], + [ + "352", + "Price Comparisons" + ], + [ + "353", + "Product Reviews & Price Comparisons" + ], + [ + "354", + "Import & Export" + ], + [ + "355", + "Book Retailers" + ], + [ + "356", + "Aerospace & Defense" + ], + [ + "357", + "TV Soap Operas" + ], + [ + "358", + "TV Shows & Programs" + ], + [ + "359", + "TV Networks & Stations" + ], + [ + "360", + "Bollywood & South Asian Film" + ], + [ + "361", + "Audio Equipment" + ], + [ + "362", + "Gadgets & Portable Electronics" + ], + [ + "364", + "Lottery & Sweepstakes" + ], + [ + "365", + "Coupons & Discount Offers" + ], + [ + "366", + "Military" + ], + [ + "367", + "Distance Learning" + ], + [ + "369", + "Vocational & Continuing Education" + ], + [ + "371", + "Primary & Secondary Schooling (K-12)" + ], + [ + "372", + "Colleges & Universities" + ], + [ + "373", + "Standardized & Admissions Tests" + ], + [ + "374", + "Educational Resources" + ], + [ + "375", + "Libraries & Museums" + ], + [ + "377", + "Business & Personal Listings" + ], + [ + "378", + "Apartments & Residential Rentals" + ], + [ + "379", + "Pet Food & Supplies" + ], + [ + "380", + "Veterinarians" + ], + [ + "381", + "Game Cheats & Hints" + ], + [ + "382", + "Mobile & Wireless" + ], + [ + "383", + "Service Providers" + ], + [ + "384", + "Phone Service Providers" + ], + [ + "385", + "Communications Equipment" + ], + [ + "386", + "Voice & Video Chat" + ], + [ + "389", + "Calling Cards" + ], + [ + "390", + "Mobile Phones" + ], + [ + "392", + "Teleconferencing" + ], + [ + "394", + "Email & Messaging" + ], + [ + "396", + "Politics" + ], + [ + "398", + "Campaigns & Elections" + ], + [ + "400", + "Ancestry & Genealogy" + ], + [ + "401", + "Pregnancy & Maternity" + ], + [ + "402", + "Youth Camps" + ], + [ + "403", + "Child Care" + ], + [ + "404", + "Beer" + ], + [ + "405", + "Wine" + ], + [ + "406", + "Liquor" + ], + [ + "408", + "Newspapers" + ], + [ + "409", + "Right-Wing Politics" + ], + [ + "410", + "Left-Wing Politics" + ], + [ + "412", + "Magazines" + ], + [ + "418", + "Nursing" + ], + [ + "419", + "Health Conditions" + ], + [ + "420", + "Skin Conditions" + ], + [ + "421", + "Sexually Transmitted Diseases" + ], + [ + "422", + "Web Design & Development" + ], + [ + "423", + "Bankruptcy" + ], + [ + "424", + "Criminal Law" + ], + [ + "425", + "Property Management" + ], + [ + "426", + "Intellectual Property" + ], + [ + "427", + "Accident & Personal Injury Law" + ], + [ + "428", + "T-Shirts" + ], + [ + "429", + "Cancer" + ], + [ + "432", + "Toys" + ], + [ + "433", + "History" + ], + [ + "434", + "Electronics & Electrical" + ], + [ + "435", + "Astronomy" + ], + [ + "436", + "Mathematics" + ], + [ + "437", + "Mental Health" + ], + [ + "438", + "Vehicle Wheels & Tires" + ], + [ + "439", + "Photographic & Digital Arts" + ], + [ + "440", + "Biological Sciences" + ], + [ + "441", + "Water & Marine Sciences" + ], + [ + "442", + "Ecology & Environment" + ], + [ + "443", + "Geology" + ], + [ + "444", + "Physics" + ], + [ + "445", + "Scientific Equipment" + ], + [ + "446", + "Scientific Institutions" + ], + [ + "447", + "Flash-Based Entertainment" + ], + [ + "448", + "Astrology & Divination" + ], + [ + "449", + "Occult & Paranormal" + ], + [ + "450", + "Customer Services" + ], + [ + "451", + "Warranties & Service Contracts" + ], + [ + "456", + "Nutrition" + ], + [ + "457", + "Special & Restricted Diets" + ], + [ + "458", + "Cycling" + ], + [ + "459", + "Boating" + ], + [ + "461", + "Hunting & Shooting" + ], + [ + "462", + "Fishing" + ], + [ + "463", + "Property Inspections & Appraisals" + ], + [ + "465", + "Home Insurance" + ], + [ + "466", + "Home Financing" + ], + [ + "467", + "Auto Insurance" + ], + [ + "468", + "Auto Financing" + ], + [ + "471", + "Pest Control" + ], + [ + "472", + "Domestic Services" + ], + [ + "473", + "Vehicle Shopping" + ], + [ + "474", + "Humanities" + ], + [ + "477", + "Architecture" + ], + [ + "485", + "Search Engines" + ], + [ + "486", + "Graphics & Animation Software" + ], + [ + "487", + "Computer Monitors & Displays" + ], + [ + "488", + "Data Formats & Protocols" + ], + [ + "492", + "Video Players & Recorders" + ], + [ + "493", + "Input Devices" + ], + [ + "494", + "Printers" + ], + [ + "495", + "Scanners" + ], + [ + "496", + "Computer Drives & Storage" + ], + [ + "497", + "Multimedia Software" + ], + [ + "498", + "Business & Productivity Software" + ], + [ + "499", + "Alternative & Natural Medicine" + ], + [ + "500", + "Physical Therapy" + ], + [ + "501", + "Cable & Satellite Providers" + ], + [ + "502", + "Subcultures & Niche Interests" + ], + [ + "503", + "Goth Subculture" + ], + [ + "504", + "Blogging Resources & Services" + ], + [ + "505", + "Chemistry" + ], + [ + "507", + "Gossip & Tabloid News" + ], + [ + "508", + "Social Services" + ], + [ + "509", + "Social Sciences" + ], + [ + "510", + "Demographics" + ], + [ + "511", + "Counseling Services" + ], + [ + "512", + "Wrestling" + ], + [ + "513", + "Olympics" + ], + [ + "514", + "Combat Sports" + ], + [ + "515", + "Boxing" + ], + [ + "516", + "Martial Arts" + ], + [ + "517", + "Rugby" + ], + [ + "518", + "Track & Field" + ], + [ + "519", + "Gymnastics" + ], + [ + "520", + "Economics" + ], + [ + "521", + "International Relations" + ], + [ + "522", + "Family Law" + ], + [ + "527", + "Directories & Listings" + ], + [ + "528", + "South Asians & Diaspora" + ], + [ + "529", + "Social Networks" + ], + [ + "530", + "Undergarments" + ], + [ + "531", + "Shopping Portals & Search Engines" + ], + [ + "532", + "Ringtones & Mobile Goodies" + ], + [ + "533", + "Reference" + ], + [ + "534", + "Cheerleading" + ], + [ + "535", + "Law Enforcement" + ], + [ + "536", + "Sex Education & Counseling" + ], + [ + "538", + "Edgy & Bizarre" + ], + [ + "539", + "Fun & Trivia" + ], + [ + "540", + "Fan Fiction" + ], + [ + "541", + "Running & Walking" + ], + [ + "542", + "Hiking & Camping" + ], + [ + "543", + "Psychology" + ], + [ + "546", + "Matrimonial Services" + ], + [ + "547", + "African-Americans" + ], + [ + "548", + "Latinos & Latin-Americans" + ], + [ + "549", + "East Asians & Diaspora" + ], + [ + "550", + "Jewish Culture" + ], + [ + "551", + "Small Business" + ], + [ + "552", + "MLM & Business Opportunities" + ], + [ + "554", + "Extreme Sports" + ], + [ + "555", + "Visa & Immigration" + ], + [ + "556", + "Arabs & Middle Easterners" + ], + [ + "557", + "Massage Therapy" + ], + [ + "558", + "OBGYN" + ], + [ + "559", + "Heart & Hypertension" + ], + [ + "560", + "Non-Alcoholic Beverages" + ], + [ + "563", + "Pets" + ], + [ + "565", + "Poetry" + ], + [ + "566", + "Textiles & Nonwovens" + ], + [ + "567", + "Technical Support" + ], + [ + "568", + "Equestrian" + ], + [ + "569", + "Events & Listings" + ], + [ + "571", + "Eating Disorders" + ], + [ + "572", + "Local News" + ], + [ + "573", + "Camera & Photo Equipment" + ], + [ + "574", + "Stock Photography" + ], + [ + "575", + "Webcams & Virtual Tours" + ], + [ + "576", + "Photo & Video Services" + ], + [ + "577", + "Photo & Video Software" + ], + [ + "578", + "Skins Themes & Wallpapers" + ], + [ + "579", + "Africans & Diaspora" + ], + [ + "580", + "Southeast Asians & Pacific Islanders" + ], + [ + "581", + "Dance" + ], + [ + "582", + "Online Journals & Personal Sites" + ], + [ + "585", + "Christian & Gospel Music" + ], + [ + "586", + "Classical Music" + ], + [ + "587", + "Country Music" + ], + [ + "588", + "Dance & Electronic Music" + ], + [ + "589", + "Jazz & Blues" + ], + [ + "590", + "Rock Music" + ], + [ + "591", + "Latin American Music" + ], + [ + "592", + "Urban & Hip-Hop" + ], + [ + "593", + "World Music" + ], + [ + "606", + "Metals & Mining" + ], + [ + "607", + "Exotic Pets" + ], + [ + "608", + "E-Books" + ], + [ + "609", + "Myth & Folklore" + ], + [ + "610", + "Trucks & SUVs" + ], + [ + "611", + "Yoga & Pilates" + ], + [ + "612", + "Entertainment Industry" + ], + [ + "613", + "Online Media" + ], + [ + "614", + "Ticket Sales" + ], + [ + "615", + "Horror Films" + ], + [ + "616", + "Science Fiction & Fantasy Films" + ], + [ + "617", + "Song Lyrics & Tabs" + ], + [ + "618", + "Vocals & Show Tunes" + ], + [ + "619", + "Retirement & Pension" + ], + [ + "620", + "Risk Management" + ], + [ + "621", + "Food Production" + ], + [ + "622", + "Roleplaying Games" + ], + [ + "623", + "Aging & Geriatrics" + ], + [ + "624", + "Alzheimer's Disease" + ], + [ + "625", + "AIDS & HIV" + ], + [ + "626", + "Allergies" + ], + [ + "627", + "Asthma" + ], + [ + "628", + "Arthritis" + ], + [ + "629", + "Cold & Flu" + ], + [ + "630", + "Diabetes" + ], + [ + "631", + "Headaches & Migraines" + ], + [ + "632", + "Infectious Diseases" + ], + [ + "633", + "Sleep Disorders" + ], + [ + "634", + "Doctors' Offices" + ], + [ + "635", + "Medical Procedures" + ], + [ + "636", + "Men's Health" + ], + [ + "638", + "GERD & Digestive Disorders" + ], + [ + "639", + "Anxiety & Stress" + ], + [ + "640", + "Depression" + ], + [ + "641", + "Learning & Developmental Disabilities" + ], + [ + "642", + "ADD & ADHD" + ], + [ + "643", + "Cholesterol Issues" + ], + [ + "644", + "Occupational Health & Safety" + ], + [ + "645", + "Pediatrics" + ], + [ + "646", + "Drugs & Medications" + ], + [ + "647", + "Infertility" + ], + [ + "648", + "Women's Health" + ], + [ + "649", + "Assisted Living & Long Term Care" + ], + [ + "650", + "Building Materials & Supplies" + ], + [ + "651", + "Civil Engineering" + ], + [ + "652", + "Construction Consulting & Contracting" + ], + [ + "653", + "Design" + ], + [ + "654", + "Graphic Design" + ], + [ + "655", + "Industrial & Product Design" + ], + [ + "656", + "Interior Design" + ], + [ + "657", + "Renewable & Alternative Energy" + ], + [ + "658", + "Electricity" + ], + [ + "659", + "Oil & Gas" + ], + [ + "660", + "Waste Management" + ], + [ + "661", + "Factory Automation" + ], + [ + "662", + "Aviation" + ], + [ + "663", + "Couriers & Messengers" + ], + [ + "664", + "Distribution & Logistics" + ], + [ + "665", + "Maritime Transport" + ], + [ + "666", + "Rail Transport" + ], + [ + "667", + "Urban Transport" + ], + [ + "668", + "Space Technology" + ], + [ + "669", + "Defense Industry" + ], + [ + "670", + "Agrochemicals" + ], + [ + "671", + "Cleaning Agents" + ], + [ + "672", + "Coatings & Adhesives" + ], + [ + "673", + "Dyes & Pigments" + ], + [ + "674", + "Plastics & Polymers" + ], + [ + "675", + "Web Stats & Analytics" + ], + [ + "676", + "Science Fiction & Fantasy" + ], + [ + "677", + "Disabled & Special Needs" + ], + [ + "678", + "Holidays & Seasonal Events" + ], + [ + "679", + "Children's Interests" + ], + [ + "680", + "Teen Interests" + ], + [ + "681", + "Indigenous Peoples" + ], + [ + "682", + "Eastern Europeans" + ], + [ + "683", + "Western Europeans" + ], + [ + "685", + "Traffic & Public Transit" + ], + [ + "686", + "Urban & Regional Planning" + ], + [ + "687", + "Property Development" + ], + [ + "688", + "Outdoors" + ], + [ + "689", + "Surf & Swim" + ], + [ + "690", + "Biographies & Quotations" + ], + [ + "691", + "Calculators & Reference Tools" + ], + [ + "692", + "Dictionaries & Encyclopedias" + ], + [ + "693", + "Forms Guides & Templates" + ], + [ + "694", + "How-To, DIY & Expert Content" + ], + [ + "695", + "Time & Calendars" + ], + [ + "696", + "Luxury Goods" + ], + [ + "697", + "Footwear" + ], + [ + "699", + "Volleyball" + ], + [ + "700", + "Teaching & Classroom Resources" + ], + [ + "701", + "Labor & Employment Law" + ], + [ + "702", + "Royalty" + ], + [ + "703", + "Work & Labor Issues" + ], + [ + "704", + "Crime & Justice" + ], + [ + "705", + "Security Products & Services" + ], + [ + "706", + "Welfare & Unemployment" + ], + [ + "707", + "Adventure Travel" + ], + [ + "708", + "Bus & Rail" + ], + [ + "717", + "Computer Components" + ], + [ + "718", + "Outsourcing" + ], + [ + "719", + "Physical Asset Management" + ], + [ + "720", + "Quality Control & Tracking" + ], + [ + "721", + "Business Process" + ], + [ + "722", + "Strategic Planning" + ], + [ + "723", + "Compensation & Benefits" + ], + [ + "724", + "Payroll Services" + ], + [ + "725", + "Writing & Editing Services" + ], + [ + "726", + "Fire & Security Services" + ], + [ + "727", + "Home Office" + ], + [ + "728", + "Computer Servers" + ], + [ + "729", + "Network Storage" + ], + [ + "730", + "Development Tools" + ], + [ + "731", + "C & C++" + ], + [ + "732", + "Java" + ], + [ + "733", + "Scripting Languages" + ], + [ + "734", + "Windows & .NET" + ], + [ + "735", + "Mac OS" + ], + [ + "736", + "Linux & Unix" + ], + [ + "737", + "Windows OS" + ], + [ + "739", + "Hardware Modding & Tuning" + ], + [ + "740", + "Sound & Video Cards" + ], + [ + "741", + "Chips & Processors" + ], + [ + "742", + "Electronic Components" + ], + [ + "743", + "Electromechanical Devices" + ], + [ + "744", + "Optoelectronics & Fiber" + ], + [ + "745", + "Power Supplies" + ], + [ + "746", + "Test & Measurement" + ], + [ + "747", + "Aquaculture" + ], + [ + "748", + "Agricultural Equipment" + ], + [ + "749", + "Crops & Seed" + ], + [ + "750", + "Forestry" + ], + [ + "751", + "Horticulture" + ], + [ + "752", + "Livestock" + ], + [ + "784", + "Business News" + ], + [ + "785", + "Technology News" + ], + [ + "786", + "Paintball" + ], + [ + "787", + "Radio Control & Modeling" + ], + [ + "788", + "Anatomy" + ], + [ + "791", + "Homeschooling" + ], + [ + "792", + "Legal Education" + ], + [ + "793", + "Veterans" + ], + [ + "794", + "GPS & Navigation" + ], + [ + "799", + "Business Education" + ], + [ + "800", + "Knowledge Management" + ], + [ + "801", + "Supply Chain Management" + ], + [ + "802", + "Developer Jobs" + ], + [ + "803", + "Vehicle Shows" + ], + [ + "804", + "Educational Software" + ], + [ + "805", + "Fonts" + ], + [ + "806", + "Custom & Performance Vehicles" + ], + [ + "807", + "Internet Software" + ], + [ + "808", + "Content Management" + ], + [ + "809", + "Podcasting" + ], + [ + "810", + "Hybrid & Alternative Vehicles" + ], + [ + "811", + "Credit Cards" + ], + [ + "812", + "Debt Management" + ], + [ + "813", + "College Financing" + ], + [ + "814", + "Currencies & Foreign Exchange" + ], + [ + "815", + "Vehicle Brands" + ], + [ + "816", + "Restaurant Supply" + ], + [ + "817", + "Injury" + ], + [ + "818", + "Obesity" + ], + [ + "819", + "Pain Management" + ], + [ + "820", + "Acura" + ], + [ + "821", + "Audi" + ], + [ + "822", + "BMW" + ], + [ + "823", + "Cadillac" + ], + [ + "824", + "Respiratory Conditions" + ], + [ + "825", + "Vegetarian Cuisine" + ], + [ + "826", + "Chevrolet" + ], + [ + "827", + "Doors & Windows" + ], + [ + "828", + "HVAC & Climate Control" + ], + [ + "829", + "Nails Screws & Fasteners" + ], + [ + "830", + "Plumbing Fixtures & Equipment" + ], + [ + "831", + "Wood & Plastics" + ], + [ + "832", + "Flooring" + ], + [ + "833", + "Chrysler" + ], + [ + "834", + "Citro\u00ebn" + ], + [ + "835", + "Generators" + ], + [ + "836", + "Dodge" + ], + [ + "837", + "Heavy Machinery" + ], + [ + "838", + "Fiat" + ], + [ + "839", + "Valves Hoses & Fittings" + ], + [ + "840", + "Ford" + ], + [ + "841", + "Retail Trade" + ], + [ + "842", + "GMC" + ], + [ + "843", + "Honda" + ], + [ + "844", + "Retail Equipment & Technology" + ], + [ + "845", + "Hyundai" + ], + [ + "846", + "Jeep" + ], + [ + "847", + "Social Network Apps & Add-Ons" + ], + [ + "848", + "Kia" + ], + [ + "849", + "Lexus" + ], + [ + "850", + "Lincoln" + ], + [ + "851", + "Mazda" + ], + [ + "852", + "Mercedes-Benz" + ], + [ + "853", + "Mercury" + ], + [ + "854", + "Mitsubishi" + ], + [ + "855", + "Nissan" + ], + [ + "856", + "Peugeot" + ], + [ + "857", + "Pontiac" + ], + [ + "858", + "Porsche" + ], + [ + "859", + "Renault-Samsung" + ], + [ + "860", + "Saturn" + ], + [ + "861", + "Subaru" + ], + [ + "862", + "Buddhism" + ], + [ + "863", + "Toyota" + ], + [ + "864", + "Christianity" + ], + [ + "865", + "Volkswagen" + ], + [ + "866", + "Hinduism" + ], + [ + "867", + "Volvo" + ], + [ + "868", + "Islam" + ], + [ + "869", + "Judaism" + ], + [ + "870", + "Self-Help & Motivational" + ], + [ + "882", + "Animal Products & Services" + ], + [ + "883", + "Animal Welfare" + ], + [ + "884", + "Birds" + ], + [ + "885", + "Cats" + ], + [ + "886", + "Dogs" + ], + [ + "887", + "Fish & Aquaria" + ], + [ + "888", + "Horses" + ], + [ + "889", + "Rabbits & Rodents" + ], + [ + "890", + "Reptiles & Amphibians" + ], + [ + "891", + "Concerts & Music Festivals" + ], + [ + "892", + "Sheet Music" + ], + [ + "893", + "Soundtracks" + ], + [ + "894", + "Acting & Theater" + ], + [ + "895", + "Live Comedy" + ], + [ + "896", + "GM-Daewoo" + ], + [ + "897", + "Saab" + ], + [ + "898", + "Vauxhall-Opel" + ], + [ + "899", + "Game Systems & Consoles" + ], + [ + "900", + "Data Sheets & Electronics Reference" + ], + [ + "901", + "Freeware & Shareware" + ], + [ + "902", + "Proxying & Filtering" + ], + [ + "903", + "Financial Planning" + ], + [ + "904", + "Commodities & Futures Trading" + ], + [ + "905", + "Venture Capital" + ], + [ + "906", + "Candy & Sweets" + ], + [ + "907", + "Baked Goods" + ], + [ + "908", + "Fruits & Vegetables" + ], + [ + "909", + "Meat & Seafood" + ], + [ + "910", + "Soups & Stews" + ], + [ + "911", + "World Cuisines" + ], + [ + "912", + "Asian Cuisine" + ], + [ + "913", + "Latin American Cuisine" + ], + [ + "914", + "Mediterranean Cuisine" + ], + [ + "915", + "North American Cuisine" + ], + [ + "916", + "Coffee & Tea" + ], + [ + "917", + "Dining Guides" + ], + [ + "918", + "Fast Food" + ], + [ + "919", + "Arcade & Coin-Op Games" + ], + [ + "920", + "Board Games" + ], + [ + "921", + "Chess & Abstract Strategy Games" + ], + [ + "922", + "Miniatures & Wargaming" + ], + [ + "923", + "Collectible Card Games" + ], + [ + "924", + "Poker & Casino Games" + ], + [ + "925", + "Adventure Games" + ], + [ + "926", + "Casual Games" + ], + [ + "927", + "Driving & Racing Games" + ], + [ + "928", + "Fighting Games" + ], + [ + "929", + "Music & Dance Games" + ], + [ + "930", + "Shooter Games" + ], + [ + "931", + "Simulation Games" + ], + [ + "932", + "Sports Games" + ], + [ + "933", + "Strategy Games" + ], + [ + "935", + "Massive Multiplayer" + ], + [ + "936", + "Party Games" + ], + [ + "937", + "Puzzles & Brainteasers" + ], + [ + "938", + "Table Games" + ], + [ + "939", + "Billiards" + ], + [ + "940", + "Table Tennis" + ], + [ + "941", + "Genetic Disorders" + ], + [ + "942", + "Neurological Disorders" + ], + [ + "943", + "Medical Tests & Exams" + ], + [ + "944", + "Surgery" + ], + [ + "945", + "Medical Photos & Illustration" + ], + [ + "946", + "Poisons & Overdoses" + ], + [ + "947", + "Public Health" + ], + [ + "948", + "Bed & Bath" + ], + [ + "949", + "Cleaning Supplies & Services" + ], + [ + "950", + "Construction & Power Tools" + ], + [ + "951", + "Kitchen & Dining" + ], + [ + "952", + "Swimming Pools & Spas" + ], + [ + "953", + "Yard & Patio" + ], + [ + "954", + "Nuclear Energy" + ], + [ + "955", + "Hospitality Industry" + ], + [ + "956", + "Event Planning" + ], + [ + "957", + "Food Service" + ], + [ + "958", + "Jobs & Education" + ], + [ + "959", + "Career Resources & Planning" + ], + [ + "960", + "Job Listings" + ], + [ + "961", + "Resumes & Portfolios" + ], + [ + "962", + "Embassies & Consulates" + ], + [ + "963", + "Executive Branch" + ], + [ + "964", + "Legislative Branch" + ], + [ + "965", + "Multilateral Organizations" + ], + [ + "966", + "State & Local Government" + ], + [ + "967", + "Constitutional Law & Civil Rights" + ], + [ + "968", + "Drunk Driving Law" + ], + [ + "969", + "Legal Services" + ], + [ + "970", + "Product Liability" + ], + [ + "972", + "Virtual Worlds" + ], + [ + "973", + "Expatriate Communities" + ], + [ + "974", + "Adoption" + ], + [ + "975", + "Skeptics & Non-Believers" + ], + [ + "976", + "Reproductive Rights" + ], + [ + "977", + "Special Occasions" + ], + [ + "978", + "Photo & Image Sharing" + ], + [ + "979", + "Video Sharing" + ], + [ + "980", + "General Reference" + ], + [ + "981", + "Flora & Fauna" + ], + [ + "982", + "Genetics" + ], + [ + "983", + "Athletic Apparel" + ], + [ + "984", + "Casual Apparel" + ], + [ + "985", + "Children's Clothing" + ], + [ + "986", + "Handbags & Purses" + ], + [ + "987", + "Watches" + ], + [ + "988", + "Costumes" + ], + [ + "989", + "Eyewear" + ], + [ + "990", + "Formal Wear" + ], + [ + "991", + "Headwear" + ], + [ + "992", + "Men's Clothing" + ], + [ + "993", + "Outerwear" + ], + [ + "994", + "Sleepwear" + ], + [ + "995", + "Swimwear" + ], + [ + "996", + "Uniforms & Workwear" + ], + [ + "997", + "Women's Clothing" + ], + [ + "998", + "Fantasy Sports" + ], + [ + "999", + "Recreational Aviation" + ], + [ + "1000", + "Individual Sports" + ], + [ + "1001", + "Team Sports" + ], + [ + "1002", + "Water Activities" + ], + [ + "1003", + "Luggage & Travel Accessories" + ], + [ + "1004", + "Specialty Travel" + ], + [ + "1005", + "Ecotourism" + ], + [ + "1006", + "Historical Sites & Buildings" + ], + [ + "1007", + "Regional Parks & Gardens" + ], + [ + "1008", + "Theme Parks" + ], + [ + "1009", + "Zoos-Aquariums-Preserves" + ], + [ + "1010", + "Travel Agencies & Services" + ], + [ + "1011", + "Travel Guides & Travelogues" + ], + [ + "1012", + "Early Childhood Education" + ], + [ + "1013", + "Classic Vehicles" + ], + [ + "1014", + "City & Local Guides" + ], + [ + "1015", + "Alumni & Reunions" + ], + [ + "1016", + "Bowling" + ], + [ + "1017", + "Handball" + ], + [ + "1019", + "Vacation Offers" + ], + [ + "1020", + "Religious Music" + ], + [ + "1021", + "Pop Music" + ], + [ + "1022", + "Experimental & Industrial Music" + ], + [ + "1023", + "Folk & Traditional Music" + ], + [ + "1024", + "Music Equipment & Technology" + ], + [ + "1025", + "DJ Resources & Equipment" + ], + [ + "1026", + "Music Recording Technology" + ], + [ + "1027", + "Music Reference" + ], + [ + "1028", + "Music Composition & Theory" + ], + [ + "1030", + "Rap & Hip-Hop" + ], + [ + "1031", + "Reggae & Caribbean Music" + ], + [ + "1032", + "South Asian Music" + ], + [ + "1033", + "East Asian Music" + ], + [ + "1034", + "Arab & Middle Eastern Music" + ], + [ + "1035", + "Hard Rock & Progressive" + ], + [ + "1036", + "Metal (Music)" + ], + [ + "1037", + "Classic Rock & Oldies" + ], + [ + "1038", + "Indie & Alternative Music" + ], + [ + "1039", + "Soul & R&B" + ], + [ + "1040", + "Blues" + ], + [ + "1041", + "Punk (Music)" + ], + [ + "1043", + "Nintendo" + ], + [ + "1044", + "Sony PlayStation" + ], + [ + "1045", + "Xbox" + ], + [ + "1046", + "Handheld Game Consoles" + ], + [ + "1047", + "TV Comedies" + ], + [ + "1048", + "TV Talk Shows" + ], + [ + "1049", + "TV Reality Shows" + ], + [ + "1050", + "TV Game Shows" + ], + [ + "1055", + "TV Commercials" + ], + [ + "1056", + "Trucks" + ], + [ + "1057", + "SUVs" + ], + [ + "1058", + "Vans & Minivans" + ], + [ + "1059", + "Bentley" + ], + [ + "1060", + "Buick" + ], + [ + "1061", + "Ferrari" + ], + [ + "1062", + "Hummer" + ], + [ + "1063", + "Jaguar" + ], + [ + "1064", + "Lamborghini" + ], + [ + "1065", + "Land Rover" + ], + [ + "1066", + "Maserati" + ], + [ + "1067", + "Mini" + ], + [ + "1068", + "Rolls-Royce" + ], + [ + "1069", + "Scion" + ], + [ + "1070", + "Suzuki" + ], + [ + "1071", + "Smart Phones" + ], + [ + "1072", + "Documentary Films" + ], + [ + "1073", + "College Sports" + ], + [ + "1074", + "Beaches & Islands" + ], + [ + "1075", + "Courts & Judiciary" + ], + [ + "1076", + "Signage" + ], + [ + "1077", + "Sports News" + ], + [ + "1078", + "Christmas" + ], + [ + "1079", + "Halloween & October 31st" + ], + [ + "1080", + "Real Estate Listings" + ], + [ + "1081", + "Timeshares & Vacation Properties" + ], + [ + "1082", + "Sports Coaching & Training" + ], + [ + "1083", + "Sports Memorabilia" + ], + [ + "1084", + "Geographic Reference" + ], + [ + "1085", + "Movie Listings & Theater Showtimes" + ], + [ + "1086", + "Film Festivals" + ], + [ + "1087", + "Music Education & Instruction" + ], + [ + "1088", + "Desktop Publishing" + ], + [ + "1089", + "Audio & Music Software" + ], + [ + "1090", + "Media Players" + ], + [ + "1091", + "Samples & Sound Libraries" + ], + [ + "1092", + "Audio Files Formats & Codecs" + ], + [ + "1093", + "Philosophy" + ], + [ + "1094", + "Drama Films" + ], + [ + "1095", + "Comedy Films" + ], + [ + "1096", + "Thriller, Crime & Mystery Films" + ], + [ + "1097", + "Action & Adventure Films" + ], + [ + "1098", + "Silent Films" + ], + [ + "1099", + "Western Films" + ], + [ + "1100", + "Superhero Films" + ], + [ + "1101", + "Martial Arts Films" + ], + [ + "1102", + "Classic Films" + ], + [ + "1103", + "Cult & Indie Films" + ], + [ + "1104", + "Animated Films" + ], + [ + "1105", + "Musical Films" + ], + [ + "1106", + "Movie Reference" + ], + [ + "1107", + "Movie Reviews & Previews" + ], + [ + "1108", + "Film & TV Awards" + ], + [ + "1109", + "Mobile Apps & Add-Ons" + ], + [ + "1110", + "TV Family-Oriented Shows" + ], + [ + "1111", + "TV Crime & Legal Shows" + ], + [ + "1112", + "TV Sci-Fi & Fantasy Shows" + ], + [ + "1113", + "Music Awards" + ], + [ + "1114", + "Record Labels" + ], + [ + "1115", + "Recording Industry" + ], + [ + "1116", + "Film & TV Industry" + ], + [ + "1117", + "Film & TV Production" + ], + [ + "1118", + "Special Education" + ], + [ + "1119", + "Mountain & Ski Resorts" + ], + [ + "1120", + "Lakes & Rivers" + ], + [ + "1121", + "Unions & Labor Movement" + ], + [ + "1122", + "Valentine's Day" + ], + [ + "1123", + "Easter" + ], + [ + "1124", + "Jewish Holidays" + ], + [ + "1125", + "Thanksgiving" + ], + [ + "1126", + "Skate Sports" + ], + [ + "1127", + "Poverty & Hunger" + ], + [ + "1131", + "Family & Relationships" + ], + [ + "1132", + "Family" + ], + [ + "1133", + "Marriage" + ], + [ + "1134", + "Friendship" + ], + [ + "1135", + "Romance" + ], + [ + "1136", + "Public Records" + ], + [ + "1137", + "Legal Forms" + ], + [ + "1138", + "Business Finance" + ], + [ + "1139", + "Investment Banking" + ], + [ + "1140", + "Boats & Watercraft" + ], + [ + "1141", + "Robotics" + ], + [ + "1142", + "Web Apps & Online Tools" + ], + [ + "1143", + "Entertainment Media" + ], + [ + "1144", + "Entertainment Media Rentals" + ], + [ + "1145", + "DVD & Video Rentals" + ], + [ + "1146", + "Video Game Retailers" + ], + [ + "1147", + "Personal Aircraft" + ], + [ + "1148", + "Skiing & Snowboarding" + ], + [ + "1149", + "Ice Skating" + ], + [ + "1150", + "Mail & Package Delivery" + ], + [ + "1152", + "Fluid Handling" + ], + [ + "1153", + "Plumbing" + ], + [ + "1155", + "Fashion Modeling" + ], + [ + "1157", + "Home Theater Systems" + ], + [ + "1158", + "Speakers" + ], + [ + "1159", + "Business Operations" + ], + [ + "1160", + "Commercial Lending" + ], + [ + "1161", + "Public Finance" + ], + [ + "1162", + "Consulting" + ], + [ + "1163", + "Financial Markets" + ], + [ + "1164", + "Economy News" + ], + [ + "1165", + "Fiscal Policy News" + ], + [ + "1166", + "Housing & Development" + ], + [ + "1167", + "Painting" + ], + [ + "1168", + "Earth Sciences" + ], + [ + "1169", + "Paleontology" + ], + [ + "1170", + "Bluetooth Accessories" + ], + [ + "1171", + "Mobile & Wireless Accessories" + ], + [ + "1173", + "Dress-Up & Fashion Games" + ], + [ + "1174", + "Fun Tests & Silly Surveys" + ], + [ + "1175", + "Roofing" + ], + [ + "1176", + "Printing & Publishing" + ], + [ + "1177", + "Writers Resources" + ], + [ + "1178", + "Commercial & Investment Real Estate" + ], + [ + "1179", + "Company News" + ], + [ + "1180", + "Political Humor" + ], + [ + "1181", + "Corporate & Financial Crime" + ], + [ + "1182", + "Radio Equipment" + ], + [ + "1183", + "Children's Literature" + ], + [ + "1184", + "Literary Classics" + ], + [ + "1185", + "Opera" + ], + [ + "1186", + "Talk Radio" + ], + [ + "1187", + "TV Guides & Reference" + ], + [ + "1188", + "Car Electronics" + ], + [ + "1189", + "Car Video" + ], + [ + "1190", + "Automotive Industry" + ], + [ + "1191", + "Bicycles & Accessories" + ], + [ + "1192", + "Electronic Accessories" + ], + [ + "1193", + "TV Dramas" + ], + [ + "1194", + "TV Medical Shows" + ], + [ + "1195", + "Arts Education" + ], + [ + "1198", + "World Sports Competitions" + ], + [ + "1199", + "Professional & Trade Associations" + ], + [ + "1200", + "Business Formation" + ], + [ + "1201", + "Opinion & Commentary" + ], + [ + "1202", + "Political Polls & Surveys" + ], + [ + "1203", + "Media Critics & Watchdogs" + ], + [ + "1204", + "Journalism & News Industry" + ], + [ + "1205", + "Discrimination & Identity Relations" + ], + [ + "1206", + "Drag & Street Racing" + ], + [ + "1207", + "Stunts & Dangerous Feats" + ], + [ + "1208", + "African Music" + ], + [ + "1209", + "World News" + ], + [ + "1210", + "Swap Meets & Outdoor Markets" + ], + [ + "1211", + "Ear Nose & Throat" + ], + [ + "1212", + "Scooters & Mopeds" + ], + [ + "1213", + "Campers & RVs" + ], + [ + "1214", + "Commercial Vehicles" + ], + [ + "1215", + "Cargo Trucks & Trailers" + ], + [ + "1216", + "Engine & Transmission" + ], + [ + "1217", + "Auto Exterior" + ], + [ + "1218", + "Auto Interior" + ], + [ + "1219", + "Beauty Pageants" + ], + [ + "1220", + "Cosmetic Procedures" + ], + [ + "1221", + "Intelligence & Counterterrorism" + ], + [ + "1222", + "Online Image Galleries" + ], + [ + "1223", + "Clip Art & Animated GIFs" + ], + [ + "1224", + "Eyeglasses & Contacts" + ], + [ + "1225", + "Wholesalers & Liquidators" + ], + [ + "1226", + "Neuroscience" + ], + [ + "1227", + "Computer Science" + ], + [ + "1228", + "Apparel Services" + ], + [ + "1229", + "Computer Education" + ], + [ + "1230", + "Fiber & Textile Arts" + ], + [ + "1231", + "Baby & Pet Names" + ], + [ + "1232", + "House Painting & Finishing" + ], + [ + "1233", + "Technical Reference" + ], + [ + "1234", + "People Search" + ], + [ + "1235", + "Steroids & Performance-Enhancing Drugs" + ], + [ + "1236", + "Sexual Enhancement" + ], + [ + "1237", + "Smoking & Smoking Cessation" + ], + [ + "1238", + "Cleansing & Detoxification" + ], + [ + "1239", + "Acupuncture & Chinese Medicine" + ], + [ + "1240", + "Company Earnings" + ], + [ + "1241", + "Mergers & Acquisitions" + ], + [ + "1242", + "Reggaeton" + ], + [ + "1243", + "Broadway & Musical Theater" + ], + [ + "1244", + "Spoofs & Satire" + ], + [ + "1245", + "Airport Parking & Transportation" + ], + [ + "1246", + "Carnival & Mardi Gras" + ], + [ + "1247", + "Air Force" + ], + [ + "1248", + "Army" + ], + [ + "1249", + "Navy" + ], + [ + "1250", + "Marines" + ], + [ + "1251", + "Scientology" + ], + [ + "1252", + "Statistics" + ], + [ + "1253", + "Health News" + ], + [ + "1254", + "Atmospheric Science" + ], + [ + "1255", + "Climate Change & Global Warming" + ], + [ + "1256", + "Health Policy" + ], + [ + "1257", + "Asians & Diaspora" + ], + [ + "1258", + "Pagan & Esoteric Traditions" + ], + [ + "1259", + "Scandals & Investigations" + ], + [ + "1260", + "Troubled Relationships" + ], + [ + "1261", + "Divorce & Separation" + ], + [ + "1262", + "Parasites & Parasitic Diseases" + ], + [ + "1263", + "Vaccines & Immunizations" + ], + [ + "1264", + "Foreign Language Resources" + ], + [ + "1265", + "Translation Tools & Resources" + ], + [ + "1266", + "Foreign Language Study" + ], + [ + "1267", + "Vehicle Specs, Reviews & Comparisons" + ], + [ + "1268", + "Fuel Economy & Gas Prices" + ], + [ + "1269", + "Vehicle Fuels & Lubricants" + ], + [ + "1270", + "Birthdays & Name Days" + ], + [ + "1271", + "New Year" + ], + [ + "1272", + "Business & Corporate Law" + ], + [ + "1273", + "Live Sporting Events" + ], + [ + "1274", + "Christian Holidays" + ], + [ + "1275", + "Islamic Holidays" + ], + [ + "1276", + "Contests, Awards & Prizes" + ], + [ + "1277", + "Tablet PCs" + ], + [ + "1278", + "Insects & Entomology" + ], + [ + "1279", + "VPN & Remote Access" + ], + [ + "1280", + "Human Rights & Liberties" + ], + [ + "1281", + "Privacy Issues" + ], + [ + "1282", + "Grants & Financial Assistance" + ], + [ + "1283", + "Tax Preparation & Planning" + ], + [ + "1284", + "Prisons & Corrections" + ], + [ + "1285", + "Latin Pop" + ], + [ + "1286", + "Salsa & Tropical Music" + ], + [ + "1287", + "Brazilian Music" + ], + [ + "1288", + "Military History" + ], + [ + "1289", + "Academic Conferences & Publications" + ], + [ + "1290", + "Family-Oriented Games & Activities" + ], + [ + "1291", + "Family Films" + ], + [ + "1292", + "Small Kitchen Appliances" + ], + [ + "1293", + "Major Kitchen Appliances" + ], + [ + "1294", + "Vehicle Codes & Driving Laws" + ], + [ + "1296", + "Places of Worship" + ], + [ + "1298", + "Distributed & Parallel Computing" + ], + [ + "1299", + "Machine Learning & Artificial Intelligence" + ], + [ + "1300", + "CAD & CAM" + ], + [ + "1301", + "Same-Sex Marriage" + ], + [ + "1302", + "Communications & Media Studies" + ], + [ + "1303", + "Public Speaking" + ], + [ + "1304", + "Etiquette" + ], + [ + "1305", + "Diving & Underwater Activities" + ], + [ + "1306", + "Parking" + ], + [ + "1307", + "Recycling" + ], + [ + "1308", + "Study Abroad" + ], + [ + "1309", + "Loyalty Cards & Programs" + ], + [ + "1310", + "Romance Films" + ], + [ + "1311", + "Action & Platform Games" + ], + [ + "1312", + "Gangs & Organized Crime" + ], + [ + "1313", + "Immigration Policy & Border Issues" + ], + [ + "1314", + "Drug Laws & Policy" + ], + [ + "1315", + "Video File Formats & Codecs" + ], + [ + "1316", + "Public Policy" + ], + [ + "1317", + "Microcars & City Cars" + ], + [ + "1318", + "Flash Drives & Memory Cards" + ], + [ + "1319", + "Memory Card Readers" + ], + [ + "1320", + "Hard Drives" + ], + [ + "1321", + "CD & DVD Drives & Burners" + ], + [ + "1322", + "CD & DVD Storage Media" + ], + [ + "1323", + "Data Backup & Recovery" + ], + [ + "1324", + "E-Book Readers" + ], + [ + "1325", + "Guitars" + ], + [ + "1326", + "Pianos & Keyboards" + ], + [ + "1327", + "Drums & Percussion" + ], + [ + "1328", + "Endocrine Conditions" + ], + [ + "1329", + "Thyroid Conditions" + ], + [ + "1330", + "Printers, Copiers & Fax" + ], + [ + "1331", + "Copiers" + ], + [ + "1332", + "Fax Machines" + ], + [ + "1333", + "Ink & Toner" + ], + [ + "1334", + "Projectors & Screens" + ], + [ + "1339", + "Carpooling & Ridesharing" + ], + [ + "1340", + "Theology & Religious Study" + ], + [ + "1341", + "Accounting & Financial Software" + ], + [ + "1342", + "Video Game Emulation" + ], + [ + "1343", + "Gaming Media & Reference" + ], + [ + "1344", + "Spreadsheet Software" + ], + [ + "1345", + "Word Processing Software" + ], + [ + "1346", + "Presentation Software" + ], + [ + "1347", + "Public Storage" + ], + [ + "1348", + "Home Storage & Shelving" + ], + [ + "1349", + "Water Supply & Treatment" + ], + [ + "1350", + "Drug & Alcohol Treatment" + ], + [ + "1351", + "Drug & Alcohol Testing" + ], + [ + "1352", + "Assistive Technology" + ], + [ + "1353", + "Mobility Equipment & Accessories" + ], + [ + "1354", + "HDTVs" + ], + [ + "1355", + "Plasma TVs" + ], + [ + "1356", + "LCD TVs" + ], + [ + "1357", + "Projection TVs" + ], + [ + "1358", + "Calendar & Scheduling Software" + ], + [ + "1359", + "Project Management Software" + ], + [ + "1360", + "Project Management" + ], + [ + "1361", + "Art & Craft Supplies" + ], + [ + "1362", + "Rugs & Carpets" + ], + [ + "1363", + "Clocks" + ], + [ + "1364", + "Laundry" + ], + [ + "1365", + "Bathroom" + ], + [ + "1366", + "Bedroom" + ], + [ + "1367", + "Beds & Headboards" + ], + [ + "1368", + "Mattresses" + ], + [ + "1369", + "Bedding & Bed Linens" + ], + [ + "1370", + "Sofas & Chairs" + ], + [ + "1371", + "Water Filters & Purifiers" + ], + [ + "1372", + "Nursery & Playroom" + ], + [ + "1373", + "Cutlery & Cutting Accessories" + ], + [ + "1374", + "Babies & Toddlers" + ], + [ + "1375", + "Business Cards & Stationary" + ], + [ + "1376", + "Tennis" + ], + [ + "1377", + "Infiniti" + ], + [ + "1378", + "Isuzu" + ], + [ + "1379", + "Text & Instant Messaging" + ], + [ + "1380", + "Electric & Plug-In Vehicles" + ], + [ + "1381", + "Microblogging" + ], + [ + "1382", + "Mobile OS" + ], + [ + "1383", + "Camera Lenses" + ], + [ + "1384", + "Binoculars, Telescopes & Optical Devices" + ], + [ + "1385", + "Government Contracting & Procurement" + ], + [ + "1386", + "Lobbying" + ], + [ + "1387", + "Government Agencies" + ], + [ + "1388", + "Training & Certification" + ], + [ + "1389", + "Agritourism" + ], + [ + "1390", + "Sightseeing Tours" + ], + [ + "1391", + "Vineyards & Wine Tourism" + ], + [ + "1392", + "Tourist Boards & Visitor Centers" + ], + [ + "1393", + "DVRs & Set-Top Boxes" + ], + [ + "1394", + "Blu-Ray Players & Recorders" + ], + [ + "1395", + "DVD Players & Recorders" + ], + [ + "1396", + "Headphones" + ], + [ + "1397", + "Drawing & Coloring" + ] + ], + "description": "Parameter is used to define a search category. The default value is 0 (All categories). You can find or download all supported values in the Google Trends Categories list. Note that these are different from the categories supported for Google Trends Trending Now", + "group": "advanced_google_trends_parameters" + }, + "gprop": { + "type": "select", + "options": [ + "", + "images", + "news", + "froogle", + "youtube" + ], + "description": "Parameter is used for sorting results by property. The default property is set to `Web Search` (activated when the value of gprop parameter is not set or empty). Other available options: `images` - Image Search `news` - News Search `froogle` - Google Shopping `youtube` - YouTube Search", + "group": "advanced_google_trends_parameters" + }, + "date": { + "description": "Parameter is used to define a date. Available options: `now 1-H` - Past hour `now 4-H` - Past 4 hours `now 1-d` - Past day `now 7-d` - Past 7 days `today 1-m` - Past 30 days `today 3-m` - Past 90 days `today 12-m` - Past 12 months `today 5-y` - Past 5 years `all` - 2004 - present You can also pass custom values: Dates from 2004 to present: `yyyy-mm-dd yyyy-mm-dd` (e.g. `2021-10-15 2022-05-25`) Dates with hours within a week range: `yyyy-mm-ddThh yyyy-mm-ddThh` (e.g. `2022-05-19T10 2022-05-24T22`). Hours will be calculated depending on the tz (time zone) parameter.", + "group": "advanced_google_trends_parameters" + }, + "csv": { + "type": "checkbox", + "description": "Parameter is used for retrieving the CSV results. Set the parameter to `true` to retrieve CSV results as an array.", + "group": "advanced_google_trends_parameters" + }, + "include_low_search_volume": { + "type": "checkbox", + "description": "Parameter is used for including low search volume regions in the results. Set the parameter to `true` to include low search volume regions in the results. This parameter is ignored if data_type is not set to `GEO_MAP` or `GEO_MAP_0`.", + "group": "advanced_google_trends_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_trends` to use the Google Trends API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Trends results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_trends_autocomplete.json b/engines/google_trends_autocomplete.json new file mode 100644 index 0000000..8d8ccb8 --- /dev/null +++ b/engines/google_trends_autocomplete.json @@ -0,0 +1,207 @@ +{ + "engine": "google_trends_autocomplete", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Trends search. The query is used to retrieve suggested searches.", + "group": "search_query" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Trends Autocomplete search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_trends_autocomplete` to use the Google Trends Autocomplete API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Trends Autocomplete results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_trends_news.json b/engines/google_trends_news.json new file mode 100644 index 0000000..43ef301 --- /dev/null +++ b/engines/google_trends_news.json @@ -0,0 +1,43 @@ +{ + "engine": "google_trends_news", + "params": { + "page_token": { + "required": true, + "description": "Parameter defines the token to fetch the news of trending searches. Use `news_page_token` from our Google Trends Trending Now API \u2014 see the example.", + "group": "search_query" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_trends_news` to use the Google Trends News API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Trends News results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_trends_trending_now.json b/engines/google_trends_trending_now.json new file mode 100644 index 0000000..f966982 --- /dev/null +++ b/engines/google_trends_trending_now.json @@ -0,0 +1,2411 @@ +{ + "engine": "google_trends_trending_now", + "params": { + "geo": { + "type": "select", + "options": [ + "AL", + "DZ", + "AO", + "AR", + "AR-C", + "AR-B", + "AR-K", + "AR-H", + "AR-U", + "AR-X", + "AR-W", + "AR-E", + "AR-P", + "AR-Y", + "AR-L", + "AR-F", + "AR-M", + "AR-N", + "AR-Q", + "AR-R", + "AR-A", + "AR-J", + "AR-D", + "AR-Z", + "AR-S", + "AR-G", + "AR-V", + "AR-T", + "AM", + "AU", + "AU-ACT", + "AU-NSW", + "AU-NT", + "AU-QLD", + "AU-SA", + "AU-TAS", + "AU-VIC", + "AU-WA", + "AT", + "AT-1", + "AT-2", + "AT-3", + "AT-5", + "AT-6", + "AT-7", + "AT-4", + "AT-9", + "AT-8", + "AZ", + "BH", + "BD", + "BY", + "BE", + "BE-BRU", + "BE-VLG", + "BE-WAL", + "BJ", + "BO", + "BA", + "BR", + "BR-DF", + "BR-AC", + "BR-AL", + "BR-AP", + "BR-AM", + "BR-BA", + "BR-CE", + "BR-ES", + "BR-GO", + "BR-MA", + "BR-MT", + "BR-MS", + "BR-MG", + "BR-PA", + "BR-PB", + "BR-PR", + "BR-PE", + "BR-PI", + "BR-RJ", + "BR-RN", + "BR-RS", + "BR-RO", + "BR-RR", + "BR-SC", + "BR-SP", + "BR-SE", + "BR-TO", + "BG", + "BF", + "KH", + "CM", + "CA", + "CA-AB", + "CA-BC", + "CA-MB", + "CA-NB", + "CA-NL", + "CA-NT", + "CA-NS", + "CA-NU", + "CA-ON", + "CA-PE", + "CA-QC", + "CA-SK", + "CA-YT", + "CL", + "CL-AN", + "CL-AR", + "CL-AP", + "CL-AT", + "CL-BI", + "CL-CO", + "CL-LL", + "CL-LR", + "CL-MA", + "CL-ML", + "CL-LI", + "CL-RM", + "CL-TA", + "CL-VS", + "CL-AI", + "CO", + "CO-AMA", + "CO-ANT", + "CO-ARA", + "CO-ATL", + "CO-DC", + "CO-BOL", + "CO-BOY", + "CO-CAL", + "CO-CAQ", + "CO-CAS", + "CO-CAU", + "CO-CES", + "CO-CHO", + "CO-COR", + "CO-CUN", + "CO-GUA", + "CO-GUV", + "CO-HUI", + "CO-LAG", + "CO-MAG", + "CO-MET", + "CO-NAR", + "CO-NSA", + "CO-PUT", + "CO-QUI", + "CO-RIS", + "CO-SAP", + "CO-SAN", + "CO-SUC", + "CO-TOL", + "CO-VAC", + "CO-VAU", + "CO-VID", + "CD", + "CR", + "CI", + "HR", + "CU", + "CY", + "CZ", + "DK", + "DK-84", + "DK-82", + "DK-81", + "DK-83", + "DK-85", + "DO", + "EC", + "EC-A", + "EC-B", + "EC-F", + "EC-C", + "EC-H", + "EC-X", + "EC-O", + "EC-E", + "EC-W", + "EC-G", + "EC-I", + "EC-L", + "EC-R", + "EC-M", + "EC-S", + "EC-D", + "EC-Y", + "EC-P", + "EC-N", + "EC-SE", + "EC-SD", + "EC-U", + "EC-T", + "EC-Z", + "EG", + "EG-KB", + "EG-ALX", + "EG-SHR", + "EG-AST", + "EG-ASN", + "EG-BNS", + "EG-C", + "EG-DK", + "EG-DT", + "EG-BH", + "EG-FYM", + "EG-GH", + "EG-GZ", + "EG-IS", + "EG-KFS", + "EG-LX", + "EG-MT", + "EG-MN", + "EG-MNF", + "EG-WAD", + "EG-SIN", + "EG-PTS", + "EG-KN", + "EG-BA", + "EG-SHG", + "EG-JS", + "EG-SUZ", + "SV", + "EE", + "ET", + "FI", + "FR", + "FR-A", + "FR-B", + "FR-C", + "FR-E", + "FR-D", + "FR-F", + "FR-G", + "FR-H", + "FR-I", + "FR-J", + "FR-K", + "FR-L", + "FR-M", + "FR-P", + "FR-N", + "FR-O", + "FR-R", + "FR-S", + "FR-T", + "FR-U", + "FR-V", + "FR-Q", + "FR-01", + "FR-02", + "FR-03", + "FR-06", + "FR-04", + "FR-07", + "FR-08", + "FR-09", + "FR-10", + "FR-11", + "FR-12", + "FR-67", + "FR-13", + "FR-14", + "FR-15", + "FR-16", + "FR-17", + "FR-18", + "FR-19", + "FR-2A", + "FR-22", + "FR-23", + "FR-21", + "FR-79", + "FR-24", + "FR-25", + "FR-26", + "FR-91", + "FR-27", + "FR-28", + "FR-29", + "FR-30", + "FR-32", + "FR-33", + "FR-68", + "FR-2B", + "FR-31", + "FR-43", + "FR-52", + "FR-74", + "FR-70", + "FR-87", + "FR-05", + "FR-65", + "FR-92", + "FR-34", + "FR-35", + "FR-36", + "FR-37", + "FR-38", + "FR-39", + "FR-40", + "FR-41", + "FR-42", + "FR-44", + "FR-45", + "FR-46", + "FR-47", + "FR-48", + "FR-49", + "FR-50", + "FR-51", + "FR-53", + "FR-54", + "FR-55", + "FR-56", + "FR-57", + "FR-58", + "FR-59", + "FR-60", + "FR-61", + "FR-75", + "FR-62", + "FR-63", + "FR-64", + "FR-66", + "FR-69", + "FR-72", + "FR-73", + "FR-71", + "FR-76", + "FR-93", + "FR-77", + "FR-80", + "FR-81", + "FR-82", + "FR-90", + "FR-95", + "FR-94", + "FR-83", + "FR-84", + "FR-85", + "FR-86", + "FR-88", + "FR-89", + "FR-78", + "GE", + "DE", + "DE-BW", + "DE-BY", + "DE-BE", + "DE-BB", + "DE-HB", + "DE-HH", + "DE-HE", + "DE-NI", + "DE-MV", + "DE-NW", + "DE-RP", + "DE-SL", + "DE-SN", + "DE-ST", + "DE-SH", + "DE-TH", + "GH", + "GR", + "GT", + "HT", + "HN", + "HK", + "HU", + "IN", + "IN-AN", + "IN-AP", + "IN-AR", + "IN-AS", + "IN-BR", + "IN-CH", + "IN-CT", + "IN-DN", + "IN-DD", + "IN-DL", + "IN-GA", + "IN-GJ", + "IN-HR", + "IN-HP", + "IN-JK", + "IN-JH", + "IN-KA", + "IN-KL", + "IN-LD", + "IN-MP", + "IN-MH", + "IN-MN", + "IN-ML", + "IN-MZ", + "IN-NL", + "IN-OR", + "IN-PY", + "IN-PB", + "IN-RJ", + "IN-SK", + "IN-TN", + "IN-TG", + "IN-TR", + "IN-UP", + "IN-UT", + "IN-WB", + "ID", + "ID-AC", + "ID-BA", + "ID-BB", + "ID-BT", + "ID-BE", + "ID-JT", + "ID-KT", + "ID-ST", + "ID-JI", + "ID-KI", + "ID-NT", + "ID-GO", + "ID-JA", + "ID-LA", + "ID-MA", + "ID-KU", + "ID-MU", + "ID-SA", + "ID-SU", + "ID-PA", + "ID-RI", + "ID-KR", + "ID-SG", + "ID-KS", + "ID-SN", + "ID-SS", + "ID-JK", + "ID-YO", + "ID-JB", + "ID-KB", + "ID-NB", + "ID-PB", + "ID-SR", + "ID-SB", + "IR", + "IQ", + "IE", + "IL", + "IL-M", + "IL-HA", + "IL-JM", + "IL-Z", + "IL-D", + "IL-TA", + "IT", + "IT-65", + "IT-23", + "IT-75", + "IT-77", + "IT-78", + "IT-72", + "IT-45", + "IT-36", + "IT-62", + "IT-42", + "IT-25", + "IT-57", + "IT-67", + "IT-21", + "IT-88", + "IT-82", + "IT-32", + "IT-52", + "IT-55", + "IT-34", + "JM", + "JP", + "JP-23", + "JP-05", + "JP-02", + "JP-12", + "JP-38", + "JP-18", + "JP-40", + "JP-07", + "JP-21", + "JP-10", + "JP-34", + "JP-01", + "JP-28", + "JP-08", + "JP-17", + "JP-03", + "JP-37", + "JP-46", + "JP-14", + "JP-39", + "JP-43", + "JP-26", + "JP-24", + "JP-04", + "JP-45", + "JP-20", + "JP-42", + "JP-29", + "JP-15", + "JP-44", + "JP-33", + "JP-47", + "JP-27", + "JP-41", + "JP-11", + "JP-25", + "JP-32", + "JP-22", + "JP-09", + "JP-36", + "JP-13", + "JP-31", + "JP-16", + "JP-30", + "JP-06", + "JP-35", + "JP-19", + "JO", + "KZ", + "KE", + "KW", + "KG", + "LV", + "LB", + "LY", + "LT", + "MY", + "MY-14", + "MY-01", + "MY-02", + "MY-03", + "MY-15", + "MY-04", + "MY-05", + "MY-06", + "MY-07", + "MY-08", + "MY-09", + "MY-16", + "MY-12", + "MY-13", + "MY-10", + "MY-11", + "ML", + "MX", + "MX-AGU", + "MX-BCN", + "MX-BCS", + "MX-CAM", + "MX-CHP", + "MX-CHH", + "MX-COA", + "MX-COL", + "MX-DUR", + "MX-GUA", + "MX-GRO", + "MX-HID", + "MX-JAL", + "MX-DIF", + "MX-MIC", + "MX-MOR", + "MX-NAY", + "MX-NLE", + "MX-OAX", + "MX-PUE", + "MX-QUE", + "MX-ROO", + "MX-SLP", + "MX-SIN", + "MX-SON", + "MX-MEX", + "MX-TAB", + "MX-TAM", + "MX-TLA", + "MX-VER", + "MX-YUC", + "MX-ZAC", + "MD", + "MA", + "MZ", + "MM", + "NP", + "NL", + "NL-DR", + "NL-FL", + "NL-FR", + "NL-GE", + "NL-GR", + "NL-LI", + "NL-NB", + "NL-NH", + "NL-OV", + "NL-ZH", + "NL-UT", + "NL-ZE", + "NZ", + "NZ-AUK", + "NZ-BOP", + "NZ-CAN", + "NZ-GIS", + "NZ-HKB", + "NZ-MWT", + "NZ-MBH", + "NZ-NSN", + "NZ-NTL", + "NZ-OTA", + "NZ-STL", + "NZ-TKI", + "NZ-TAS", + "NZ-WKO", + "NZ-WGN", + "NZ-WTC", + "NI", + "NG", + "NG-AB", + "NG-AD", + "NG-AK", + "NG-AN", + "NG-BA", + "NG-BY", + "NG-BE", + "NG-BO", + "NG-CR", + "NG-DE", + "NG-EB", + "NG-ED", + "NG-EK", + "NG-EN", + "NG-FC", + "NG-GO", + "NG-IM", + "NG-JI", + "NG-KD", + "NG-KN", + "NG-KT", + "NG-KE", + "NG-KO", + "NG-KW", + "NG-LA", + "NG-NA", + "NG-NI", + "NG-OG", + "NG-ON", + "NG-OS", + "NG-OY", + "NG-PL", + "NG-RI", + "NG-SO", + "NG-TA", + "NG-YO", + "NG-ZA", + "MK", + "NO", + "OM", + "PK", + "PK-JK", + "PK-BA", + "PK-TA", + "PK-GB", + "PK-IS", + "PK-KP", + "PK-PB", + "PK-SD", + "PS", + "PA", + "PY", + "PE", + "PE-AMA", + "PE-ANC", + "PE-APU", + "PE-ARE", + "PE-AYA", + "PE-CAJ", + "PE-CAL", + "PE-CUS", + "PE-HUV", + "PE-HUC", + "PE-ICA", + "PE-JUN", + "PE-LAL", + "PE-LAM", + "PE-LIM", + "PE-LOR", + "PE-MDD", + "PE-MOQ", + "PE-PAS", + "PE-PIU", + "PE-PUN", + "PE-SAM", + "PE-TAC", + "PE-TUM", + "PE-UCA", + "PH", + "PH-14", + "PH-05", + "PH-02", + "PH-40", + "PH-13", + "PH-03", + "PH-07", + "PH-15", + "PH-11", + "PH-08", + "PH-01", + "PH-00", + "PH-41", + "PH-10", + "PH-12", + "PH-06", + "PH-09", + "PL", + "PL-WP", + "PL-KP", + "PL-MA", + "PL-LD", + "PL-DS", + "PL-LU", + "PL-LB", + "PL-MZ", + "PL-OP", + "PL-PK", + "PL-PD", + "PL-PM", + "PL-SL", + "PL-SK", + "PL-WN", + "PL-ZP", + "PT", + "PT-01", + "PT-20", + "PT-02", + "PT-03", + "PT-04", + "PT-05", + "PT-06", + "PT-07", + "PT-08", + "PT-09", + "PT-10", + "PT-11", + "PT-30", + "PT-12", + "PT-13", + "PT-14", + "PT-15", + "PT-16", + "PT-17", + "PT-18", + "PR", + "QA", + "RO", + "RU", + "RU-AD", + "RU-ALT", + "RU-AL", + "RU-AMU", + "RU-ARK", + "RU-AST", + "RU-BEL", + "RU-BRY", + "RU-BU", + "RU-CE", + "RU-CHE", + "RU-CHU", + "RU-CU", + "RU-DA", + "RU-IN", + "RU-IRK", + "RU-IVA", + "RU-YEV", + "RU-KB", + "RU-KGD", + "RU-KL", + "RU-KLU", + "RU-KAM", + "RU-KC", + "RU-KEM", + "RU-KHA", + "RU-KHM", + "RU-KIR", + "RU-KO", + "RU-KOS", + "RU-KDA", + "RU-KYA", + "RU-KGN", + "RU-KRS", + "RU-LEN", + "RU-LIP", + "RU-MAG", + "RU-ME", + "RU-MO", + "RU-MOW", + "RU-MOS", + "RU-MUR", + "RU-NEN", + "RU-NIZ", + "RU-SE", + "RU-NGR", + "RU-NVS", + "RU-OMS", + "RU-ORE", + "RU-ORL", + "RU-PNZ", + "RU-PER", + "RU-PRI", + "RU-PSK", + "RU-BA", + "RU-KR", + "RU-KK", + "RU-ROS", + "RU-RYA", + "RU-SPE", + "RU-SA", + "RU-SAK", + "RU-SAM", + "RU-SAR", + "RU-SMO", + "RU-STA", + "RU-SVE", + "RU-TAM", + "RU-TA", + "RU-TOM", + "RU-TUL", + "RU-TY", + "RU-TVE", + "RU-TYU", + "RU-UD", + "RU-ULY", + "RU-VLA", + "RU-VGG", + "RU-VLG", + "RU-VOR", + "RU-YAN", + "RU-YAR", + "RU-ZAB", + "SA", + "SA-11", + "SA-12", + "SA-03", + "SA-05", + "SA-14", + "SA-04", + "SA-06", + "SA-09", + "SA-02", + "SA-10", + "SA-08", + "SA-01", + "SA-07", + "SN", + "RS", + "SG", + "SK", + "SI", + "ZA", + "ZA-EC", + "ZA-FS", + "ZA-GT", + "ZA-NL", + "ZA-LP", + "ZA-MP", + "ZA-NW", + "ZA-NC", + "ZA-WC", + "KR", + "KR-26", + "KR-43", + "KR-44", + "KR-27", + "KR-30", + "KR-42", + "KR-29", + "KR-41", + "KR-47", + "KR-48", + "KR-28", + "KR-49", + "KR-45", + "KR-46", + "KR-11", + "KR-31", + "ES", + "ES-AN", + "ES-AR", + "ES-AS", + "ES-IB", + "ES-PV", + "ES-CN", + "ES-CB", + "ES-CL", + "ES-CM", + "ES-CT", + "ES-CE", + "ES-MD", + "ES-EX", + "ES-GA", + "ES-RI", + "ES-ML", + "ES-NC", + "ES-MC", + "ES-VC", + "LK", + "SE", + "SE-K", + "SE-W", + "SE-X", + "SE-I", + "SE-N", + "SE-Z", + "SE-F", + "SE-H", + "SE-G", + "SE-BD", + "SE-T", + "SE-E", + "SE-M", + "SE-D", + "SE-AB", + "SE-C", + "SE-S", + "SE-AC", + "SE-Y", + "SE-U", + "SE-O", + "CH", + "CH-AG", + "CH-AI", + "CH-AR", + "CH-BL", + "CH-BS", + "CH-BE", + "CH-FR", + "CH-GL", + "CH-JU", + "CH-NE", + "CH-OW", + "CH-SH", + "CH-SZ", + "CH-SO", + "CH-UR", + "CH-ZG", + "CH-GE", + "CH-GR", + "CH-LU", + "CH-NW", + "CH-SG", + "CH-TG", + "CH-TI", + "CH-VS", + "CH-VD", + "CH-ZH", + "SY", + "TW", + "TW-KHH", + "TW-TPQ", + "TW-TXG", + "TW-TNN", + "TW-TPE", + "TW-TAO", + "TZ", + "TH", + "TT", + "TN", + "TR", + "TR-01", + "TR-02", + "TR-03", + "TR-04", + "TR-68", + "TR-05", + "TR-06", + "TR-07", + "TR-75", + "TR-08", + "TR-09", + "TR-10", + "TR-74", + "TR-72", + "TR-69", + "TR-11", + "TR-12", + "TR-13", + "TR-14", + "TR-15", + "TR-16", + "TR-17", + "TR-18", + "TR-19", + "TR-20", + "TR-21", + "TR-81", + "TR-22", + "TR-23", + "TR-24", + "TR-25", + "TR-26", + "TR-27", + "TR-28", + "TR-29", + "TR-30", + "TR-31", + "TR-76", + "TR-32", + "TR-34", + "TR-35", + "TR-46", + "TR-78", + "TR-70", + "TR-36", + "TR-37", + "TR-38", + "TR-79", + "TR-71", + "TR-39", + "TR-40", + "TR-41", + "TR-42", + "TR-43", + "TR-44", + "TR-45", + "TR-47", + "TR-33", + "TR-48", + "TR-49", + "TR-50", + "TR-51", + "TR-52", + "TR-80", + "TR-53", + "TR-54", + "TR-55", + "TR-63", + "TR-56", + "TR-57", + "TR-58", + "TR-73", + "TR-59", + "TR-60", + "TR-61", + "TR-62", + "TR-64", + "TR-65", + "TR-77", + "TR-66", + "TR-67", + "TM", + "UG", + "UA", + "UA-71", + "UA-74", + "UA-77", + "UA-43", + "UA-12", + "UA-14", + "UA-26", + "UA-63", + "UA-65", + "UA-68", + "UA-35", + "UA-30", + "UA-32", + "UA-09", + "UA-46", + "UA-48", + "UA-51", + "UA-53", + "UA-56", + "UA-40", + "UA-59", + "UA-61", + "UA-05", + "UA-07", + "UA-21", + "UA-23", + "UA-18", + "AE", + "AE-AZ", + "AE-AJ", + "AE-DU", + "AE-FU", + "AE-RK", + "AE-SH", + "AE-UQ", + "GB", + "GB-ENG", + "GB-NIR", + "GB-SCT", + "GB-WLS", + "US", + "US-AL", + "US-AK", + "US-AZ", + "US-AR", + "US-CA", + "US-CO", + "US-CT", + "US-DE", + "US-DC", + "US-FL", + "US-GA", + "US-HI", + "US-ID", + "US-IL", + "US-IN", + "US-IA", + "US-KS", + "US-KY", + "US-LA", + "US-ME", + "US-MD", + "US-MA", + "US-MI", + "US-MN", + "US-MS", + "US-MO", + "US-MT", + "US-NE", + "US-NV", + "US-NH", + "US-NJ", + "US-NM", + "US-NY", + "US-NC", + "US-ND", + "US-OH", + "US-OK", + "US-OR", + "US-PA", + "US-RI", + "US-SC", + "US-SD", + "US-TN", + "US-TX", + "US-UT", + "US-VT", + "US-VA", + "US-WA", + "US-WV", + "US-WI", + "US-WY", + [ + "662", + "Abilene-Sweetwater TX" + ], + [ + "525", + "Albany GA" + ], + [ + "532", + "Albany-Schenectady-Troy NY" + ], + [ + "790", + "Albuquerque-Santa Fe NM" + ], + [ + "644", + "Alexandria LA" + ], + [ + "583", + "Alpena MI" + ], + [ + "634", + "Amarillo TX" + ], + [ + "743", + "Anchorage AK" + ], + [ + "524", + "Atlanta GA" + ], + [ + "520", + "Augusta GA" + ], + [ + "635", + "Austin TX" + ], + [ + "800", + "Bakersfield CA" + ], + [ + "512", + "Baltimore MD" + ], + [ + "537", + "Bangor ME" + ], + [ + "716", + "Baton Rouge LA" + ], + [ + "692", + "Beaumont-Port Arthur TX" + ], + [ + "821", + "Bend OR" + ], + [ + "756", + "Billings, MT" + ], + [ + "746", + "Biloxi-Gulfport MS" + ], + [ + "502", + "Binghamton NY" + ], + [ + "630", + "Birmingham AL" + ], + [ + "559", + "Bluefield-Beckley-Oak Hill WV" + ], + [ + "757", + "Boise ID" + ], + [ + "506", + "Boston MA-Manchester NH" + ], + [ + "736", + "Bowling Green KY" + ], + [ + "514", + "Buffalo NY" + ], + [ + "523", + "Burlington VT-Plattsburgh NY" + ], + [ + "754", + "Butte-Bozeman MT" + ], + [ + "767", + "Casper-Riverton WY" + ], + [ + "637", + "Cedar Rapids-Waterloo-Iowa City & Dubuque IA" + ], + [ + "648", + "Champaign & Springfield-Decatur IL" + ], + [ + "519", + "Charleston SC" + ], + [ + "564", + "Charleston-Huntington WV" + ], + [ + "517", + "Charlotte NC" + ], + [ + "584", + "Charlottesville VA" + ], + [ + "575", + "Chattanooga TN" + ], + [ + "759", + "Cheyenne WY-Scottsbluff NE" + ], + [ + "602", + "Chicago IL" + ], + [ + "868", + "Chico-Redding CA" + ], + [ + "515", + "Cincinnati OH" + ], + [ + "598", + "Clarksburg-Weston WV" + ], + [ + "510", + "Cleveland-Akron (Canton) OH" + ], + [ + "752", + "Colorado Springs-Pueblo CO" + ], + [ + "546", + "Columbia SC" + ], + [ + "604", + "Columbia-Jefferson City MO" + ], + [ + "522", + "Columbus GA" + ], + [ + "535", + "Columbus OH" + ], + [ + "673", + "Columbus-Tupelo-West Point MS" + ], + [ + "600", + "Corpus Christi TX" + ], + [ + "623", + "Dallas-Ft. Worth TX" + ], + [ + "682", + "Davenport IA-Rock Island-Moline IL" + ], + [ + "542", + "Dayton OH" + ], + [ + "751", + "Denver CO" + ], + [ + "679", + "Des Moines-Ames IA" + ], + [ + "505", + "Detroit MI" + ], + [ + "606", + "Dothan AL" + ], + [ + "676", + "Duluth MN-Superior WI" + ], + [ + "765", + "El Paso TX" + ], + [ + "565", + "Elmira NY" + ], + [ + "516", + "Erie PA" + ], + [ + "801", + "Eugene OR" + ], + [ + "802", + "Eureka CA" + ], + [ + "649", + "Evansville IN" + ], + [ + "745", + "Fairbanks AK" + ], + [ + "724", + "Fargo-Valley City ND" + ], + [ + "513", + "Flint-Saginaw-Bay City MI" + ], + [ + "570", + "Florence-Myrtle Beach SC" + ], + [ + "866", + "Fresno-Visalia CA" + ], + [ + "571", + "Ft. Myers-Naples FL" + ], + [ + "670", + "Ft. Smith-Fayetteville-Springdale-Rogers AR" + ], + [ + "509", + "Ft. Wayne IN" + ], + [ + "592", + "Gainesville FL" + ], + [ + "798", + "Glendive MT" + ], + [ + "773", + "Grand Junction-Montrose CO" + ], + [ + "563", + "Grand Rapids-Kalamazoo-Battle Creek MI" + ], + [ + "755", + "Great Falls MT" + ], + [ + "658", + "Green Bay-Appleton WI" + ], + [ + "518", + "Greensboro-High Point-Winston Salem NC" + ], + [ + "545", + "Greenville-New Bern-Washington NC" + ], + [ + "567", + "Greenville-Spartanburg SC-Asheville NC-Anderson SC" + ], + [ + "647", + "Greenwood-Greenville MS" + ], + [ + "636", + "Harlingen-Weslaco-Brownsville-McAllen TX" + ], + [ + "566", + "Harrisburg-Lancaster-Lebanon-York PA" + ], + [ + "569", + "Harrisonburg VA" + ], + [ + "533", + "Hartford & New Haven CT" + ], + [ + "710", + "Hattiesburg-Laurel MS" + ], + [ + "766", + "Helena MT" + ], + [ + "744", + "Honolulu HI" + ], + [ + "618", + "Houston TX" + ], + [ + "691", + "Huntsville-Decatur (Florence) AL" + ], + [ + "758", + "Idaho Falls-Pocatello ID" + ], + [ + "527", + "Indianapolis IN" + ], + [ + "718", + "Jackson MS" + ], + [ + "639", + "Jackson TN" + ], + [ + "561", + "Jacksonville FL" + ], + [ + "574", + "Johnstown-Altoona PA" + ], + [ + "734", + "Jonesboro AR" + ], + [ + "603", + "Joplin MO-Pittsburg KS" + ], + [ + "747", + "Juneau AK" + ], + [ + "616", + "Kansas City MO" + ], + [ + "557", + "Knoxville TN" + ], + [ + "702", + "La Crosse-Eau Claire WI" + ], + [ + "582", + "Lafayette IN" + ], + [ + "642", + "Lafayette LA" + ], + [ + "643", + "Lake Charles LA" + ], + [ + "551", + "Lansing MI" + ], + [ + "749", + "Laredo TX" + ], + [ + "839", + "Las Vegas NV" + ], + [ + "541", + "Lexington KY" + ], + [ + "558", + "Lima OH" + ], + [ + "722", + "Lincoln & Hastings-Kearney NE" + ], + [ + "693", + "Little Rock-Pine Bluff AR" + ], + [ + "803", + "Los Angeles CA" + ], + [ + "529", + "Louisville KY" + ], + [ + "651", + "Lubbock TX" + ], + [ + "503", + "Macon GA" + ], + [ + "669", + "Madison WI" + ], + [ + "737", + "Mankato MN" + ], + [ + "553", + "Marquette MI" + ], + [ + "813", + "Medford-Klamath Falls OR" + ], + [ + "640", + "Memphis TN" + ], + [ + "711", + "Meridian MS" + ], + [ + "528", + "Miami-Ft. Lauderdale FL" + ], + [ + "617", + "Milwaukee WI" + ], + [ + "613", + "Minneapolis-St. Paul MN" + ], + [ + "687", + "Minot-Bismarck-Dickinson(Williston) ND" + ], + [ + "762", + "Missoula MT" + ], + [ + "686", + "Mobile AL-Pensacola (Ft. Walton Beach) FL" + ], + [ + "628", + "Monroe LA-El Dorado AR" + ], + [ + "828", + "Monterey-Salinas CA" + ], + [ + "698", + "Montgomery (Selma) AL" + ], + [ + "659", + "Nashville TN" + ], + [ + "622", + "New Orleans LA" + ], + [ + "501", + "New York NY" + ], + [ + "544", + "Norfolk-Portsmouth-Newport News VA" + ], + [ + "740", + "North Platte NE" + ], + [ + "633", + "Odessa-Midland TX" + ], + [ + "650", + "Oklahoma City OK" + ], + [ + "652", + "Omaha NE" + ], + [ + "534", + "Orlando-Daytona Beach-Melbourne FL" + ], + [ + "631", + "Ottumwa IA-Kirksville MO" + ], + [ + "632", + "Paducah KY-Cape Girardeau MO-Harrisburg-Mount Vernon IL" + ], + [ + "804", + "Palm Springs CA" + ], + [ + "656", + "Panama City FL" + ], + [ + "597", + "Parkersburg WV" + ], + [ + "675", + "Peoria-Bloomington IL" + ], + [ + "504", + "Philadelphia PA" + ], + [ + "753", + "Phoenix AZ" + ], + [ + "508", + "Pittsburgh PA" + ], + [ + "820", + "Portland OR" + ], + [ + "500", + "Portland-Auburn ME" + ], + [ + "552", + "Presque Isle ME" + ], + [ + "521", + "Providence RI-New Bedford MA" + ], + [ + "717", + "Quincy IL-Hannibal MO-Keokuk IA" + ], + [ + "560", + "Raleigh-Durham (Fayetteville) NC" + ], + [ + "764", + "Rapid City SD" + ], + [ + "811", + "Reno NV" + ], + [ + "556", + "Richmond-Petersburg VA" + ], + [ + "573", + "Roanoke-Lynchburg VA" + ], + [ + "611", + "Rochester MN-Mason City IA-Austin MN" + ], + [ + "538", + "Rochester NY" + ], + [ + "610", + "Rockford IL" + ], + [ + "862", + "Sacramento-Stockton-Modesto CA" + ], + [ + "576", + "Salisbury MD" + ], + [ + "770", + "Salt Lake City UT" + ], + [ + "661", + "San Angelo TX" + ], + [ + "641", + "San Antonio TX" + ], + [ + "825", + "San Diego CA" + ], + [ + "807", + "San Francisco-Oakland-San Jose CA" + ], + [ + "855", + "Santa Barbara-Santa Maria-San Luis Obispo CA" + ], + [ + "507", + "Savannah GA" + ], + [ + "819", + "Seattle-Tacoma WA" + ], + [ + "657", + "Sherman TX-Ada OK" + ], + [ + "612", + "Shreveport LA" + ], + [ + "624", + "Sioux City IA" + ], + [ + "725", + "Sioux Falls(Mitchell) SD" + ], + [ + "588", + "South Bend-Elkhart IN" + ], + [ + "881", + "Spokane WA" + ], + [ + "619", + "Springfield MO" + ], + [ + "543", + "Springfield-Holyoke MA" + ], + [ + "638", + "St. Joseph MO" + ], + [ + "609", + "St. Louis MO" + ], + [ + "555", + "Syracuse NY" + ], + [ + "530", + "Tallahassee FL-Thomasville GA" + ], + [ + "539", + "Tampa-St. Petersburg (Sarasota) FL" + ], + [ + "581", + "Terre Haute IN" + ], + [ + "547", + "Toledo OH" + ], + [ + "605", + "Topeka KS" + ], + [ + "540", + "Traverse City-Cadillac MI" + ], + [ + "531", + "Tri-Cities TN-VA" + ], + [ + "789", + "Tucson (Sierra Vista) AZ" + ], + [ + "671", + "Tulsa OK" + ], + [ + "760", + "Twin Falls ID" + ], + [ + "709", + "Tyler-Longview(Lufkin & Nacogdoches) TX" + ], + [ + "526", + "Utica NY" + ], + [ + "626", + "Victoria TX" + ], + [ + "625", + "Waco-Temple-Bryan TX" + ], + [ + "511", + "Washington DC (Hagerstown MD)" + ], + [ + "549", + "Watertown NY" + ], + [ + "705", + "Wausau-Rhinelander WI" + ], + [ + "548", + "West Palm Beach-Ft. Pierce FL" + ], + [ + "554", + "Wheeling WV-Steubenville OH" + ], + [ + "627", + "Wichita Falls TX & Lawton OK" + ], + [ + "678", + "Wichita-Hutchinson KS" + ], + [ + "577", + "Wilkes Barre-Scranton PA" + ], + [ + "550", + "Wilmington NC" + ], + [ + "810", + "Yakima-Pasco-Richland-Kennewick WA" + ], + [ + "536", + "Youngstown OH" + ], + [ + "771", + "Yuma AZ-El Centro CA" + ], + [ + "596", + "Zanesville OH" + ], + "UY", + "UY-AR", + "UY-CA", + "UY-CL", + "UY-CO", + "UY-DU", + "UY-FS", + "UY-FD", + "UY-LA", + "UY-MA", + "UY-MO", + "UY-PA", + "UY-RN", + "UY-RV", + "UY-RO", + "UY-SA", + "UY-SJ", + "UY-SO", + "UY-TA", + "UY-TT", + "UZ", + "VE", + "VN", + "VN-44", + "VN-43", + "VN-54", + "VN-53", + "VN-55", + "VN-56", + "VN-50", + "VN-31", + "VN-57", + "VN-58", + "VN-40", + "VN-59", + "VN-CT", + "VN-04", + "VN-DN", + "VN-33", + "VN-72", + "VN-71", + "VN-39", + "VN-45", + "VN-30", + "VN-03", + "VN-63", + "VN-23", + "VN-61", + "VN-HP", + "VN-HN", + "VN-73", + "VN-SG", + "VN-14", + "VN-66", + "VN-34", + "VN-47", + "VN-28", + "VN-01", + "VN-35", + "VN-09", + "VN-02", + "VN-41", + "VN-67", + "VN-22", + "VN-18", + "VN-36", + "VN-68", + "VN-32", + "VN-24", + "VN-27", + "VN-29", + "VN-13", + "VN-25", + "VN-52", + "VN-05", + "VN-37", + "VN-20", + "VN-69", + "VN-21", + "VN-26", + "VN-46", + "VN-51", + "VN-07", + "VN-49", + "VN-70", + "VN-06", + "YE", + "ZM", + "ZW" + ], + "required": true, + "description": "Parameter defines the location from where you want the search to originate. It defaults to `US` (activated when the value of geo parameter is not set or empty). Head to the Google Trends Trending Now Locations for a full list of supported locations.", + "group": "search_query" + }, + "hours": { + "type": "number", + "description": "Parameter defines the number of past hours to retrieve the results for. It defaults to `24` (Past 24 hours). The predefined value from Google are the following: -`4` (Past 4 hours) -`24` (Past 24 hours) -`48` (Past 48 hours) -`168` (Past 7 days).", + "group": "advanced_parameters" + }, + "category_id": { + "required": false, + "type": "select", + "options": [ + [ + "1", + "Autos and Vehicles - 1" + ], + [ + "2", + "Beauty and Fashion - 2" + ], + [ + "3", + "Business and Finance - 3" + ], + [ + "20", + "Climate - 20" + ], + [ + "4", + "Entertainment - 4" + ], + [ + "5", + "Food and Drink - 5" + ], + [ + "6", + "Games - 6" + ], + [ + "7", + "Health - 7" + ], + [ + "8", + "Hobbies and Leisure - 8" + ], + [ + "9", + "Jobs and Education - 9" + ], + [ + "10", + "Law and Government - 10" + ], + [ + "11", + "Other - 11" + ], + [ + "13", + "Pets and Animals - 13" + ], + [ + "14", + "Politics - 14" + ], + [ + "15", + "Science - 15" + ], + [ + "16", + "Shopping - 16" + ], + [ + "17", + "Sports - 17" + ], + [ + "18", + "Technology - 18" + ], + [ + "19", + "Travel and Transportation - 19" + ] + ], + "description": "Parameter allows results to be filtered by a specific category. E.g. category_id:`18` will return only results from the \"Technology\" category. Head to the Google Trends Trending Now Categories for the full list of supported categories.", + "group": "advanced_parameters" + }, + "only_active": { + "required": false, + "type": "checkbox", + "description": "Parameter filters results to only include those that are currently active.", + "group": "advanced_parameters" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google Trends Trending Now search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "frequency": { + "type": "select", + "options": [ + "daily", + "realtime" + ], + "required": true, + "description": "Parameter is used for retrieving different trends frequency. It defaults to `daily`. Available options: `daily` - Daily `realtime` - Realtime", + "group": "old_version_parameters" + }, + "date": { + "description": "Parameter defines the date of the results you want to retrieve. It defaults to the current day. The date format is `yyyymmdd` (e.g., `20231015`).", + "group": "old_version_parameters" + }, + "cat": { + "type": "select", + "options": [ + "all", + "b", + "e", + "m", + "t", + "s", + "h" + ], + "description": "Parameter defines the category of the results you want to retrieve. Available options: `all` - All categories (default). `b` - Business. `e` - Entertainment. `m` - Health. `t` - Sci/Tech. `s` - Sports. `h` - Top stories. Parameter can only be used when frequency is set to `realtime`.", + "group": "old_version_parameters" + }, + "next_page_token": { + "description": "Parameter defines the next page token, which is used for retrieving the next page of results. When querying the API, the first response will provide access to all available pages. However, it's important to note that Google realtime search trends do not follow conventional pagination practices. Not to worry, though, as we have abstracted this complexity for you. Here's the caveat: only the first page will contain pagination information. Subsequent requests for the next page will not display pagination details. To ensure you retrieve all pages of data, your code should be designed to handle the following process: start by fetching the first response, and then use the provided pagination token to navigate through the subsequent pages. Parameter can only be used when frequency is set to `realtime`.", + "group": "old_version_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_trends_trending_now` to use the Google Trends Trending Now API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Trends Trending Now results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_videos.json b/engines/google_videos.json new file mode 100644 index 0000000..43505e7 --- /dev/null +++ b/engines/google_videos.json @@ -0,0 +1,745 @@ +{ + "engine": "google_videos", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Videos search. e.g. `inurl:`, `site:`, `intitle:`. We also support advanced search query parameters such as as_dt and as_eq. See the full list of supported advanced search query parameters.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "lr": { + "description": "Parameter defines one or multiple languages to limit the search to. It uses `lang_{two-letter language code}` to specify languages and `|` as a delimiter. (e.g., `lang_fr|lang_de` will only search French and German pages). Head to the Google lr languages page for a full list of supported languages.", + "group": "localization" + }, + "as_dt": { + "description": "Parameter controls whether to include or exclude results from the site named in the as_sitesearch parameter.", + "group": "advanced_search_query_parameters" + }, + "as_epq": { + "description": "Parameter identifies a phrase that all documents in the search results must contain. You can also use the phrase search query term to search for a phrase.", + "group": "advanced_search_query_parameters" + }, + "as_eq": { + "description": "Parameter identifies a word or phrase that should not appear in any documents in the search results. You can also use the exclude query term to ensure that a particular word or phrase will not appear in the documents in a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_lq": { + "description": "Parameter specifies that all search results should contain a link to a particular URL. You can also use the link: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_nlo": { + "description": "Parameter specifies the starting value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_nhi": { + "description": "Parameter specifies the ending value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_oq": { + "description": "Parameter provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_q": { + "description": "Parameter provides search terms to check for in a document. This parameter is also commonly used to allow users to specify additional terms to search for within a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_qdr": { + "description": "Parameter requests search results from a specified time period (quick date range). The following values are supported: `d[number]`: requests results from the specified number of past days. Example for the past 10 days: `as_qdr=d10` `w[number]`: requests results from the specified number of past weeks. `m[number]`: requests results from the specified number of past months. `y[number]`: requests results from the specified number of past years. Example for the past year: `as_qdr=y`", + "group": "advanced_search_query_parameters" + }, + "as_rq": { + "description": "Parameter specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. You can also use the related: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_sitesearch": { + "description": "Parameter allows you to specify that all search results should be pages from a given site. By setting the as_dt parameter, you can also use it to exclude pages from a given site from your search results.", + "group": "advanced_search_query_parameters" + }, + "tbs": { + "description": "(to be searched) parameter defines advanced search parameters that aren't possible in the regular query field. (e.g., advanced search for patents, dates, news, videos, images, apps, or text contents).", + "group": "advanced_filters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "nfpr": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude these results, or `0` to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_videos` to use the Google Videos API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Videos results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/google_videos_light.json b/engines/google_videos_light.json new file mode 100644 index 0000000..2eda34a --- /dev/null +++ b/engines/google_videos_light.json @@ -0,0 +1,745 @@ +{ + "engine": "google_videos_light", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Google Videos search. e.g. `inurl:`, `site:`, `intitle:`. We also support advanced search query parameters such as as_dt and as_eq. See the full list of supported advanced search query parameters.", + "group": "search_query" + }, + "location": { + "type": "location", + "description": "Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. The location and uule parameters can't be used together. It is recommended to specify location at the city level in order to simulate a real user\u2019s search. If location is omitted, the search may take on the location of the proxy.", + "group": "geographic_location" + }, + "uule": { + "description": "Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.", + "group": "geographic_location" + }, + "google_domain": { + "type": "select", + "options": [ + "google.com", + "google.ad", + "google.ae", + "google.com.af", + "google.com.ag", + "google.com.ai", + "google.al", + "google.am", + "google.co.ao", + "google.com.ar", + "google.as", + "google.at", + "google.com.au", + "google.az", + "google.ba", + "google.com.bd", + "google.be", + "google.bf", + "google.bg", + "google.com.bh", + "google.bi", + "google.bj", + "google.com.bn", + "google.com.bo", + "google.com.br", + "google.bs", + "google.bt", + "google.co.bw", + "google.by", + "google.com.bz", + "google.ca", + "google.com.kh", + "google.cd", + "google.cf", + "google.cg", + "google.ch", + "google.ci", + "google.co.ck", + "google.cl", + "google.cm", + "google.com.co", + "google.co.cr", + "google.com.cu", + "google.cv", + "google.com.cy", + "google.cz", + "google.de", + "google.dj", + "google.dk", + "google.dm", + "google.com.do", + "google.dz", + "google.com.ec", + "google.ee", + "google.com.eg", + "google.es", + "google.com.et", + "google.fi", + "google.fm", + "google.com.fj", + "google.fr", + "google.ga", + "google.ge", + "google.com.gh", + "google.com.gi", + "google.gl", + "google.gm", + "google.gp", + "google.gr", + "google.com.gt", + "google.gy", + "google.com.hk", + "google.hn", + "google.hr", + "google.ht", + "google.hu", + "google.co.id", + "google.iq", + "google.ie", + "google.co.il", + "google.co.in", + "google.is", + "google.it", + "google.je", + "google.com.jm", + "google.jo", + "google.co.jp", + "google.co.ke", + "google.ki", + "google.kg", + "google.co.kr", + "google.com.kw", + "google.kz", + "google.la", + "google.com.lb", + "google.li", + "google.lk", + "google.co.ls", + "google.lt", + "google.lu", + "google.lv", + "google.com.ly", + "google.co.ma", + "google.md", + "google.mg", + "google.mk", + "google.ml", + "google.com.mm", + "google.mn", + "google.ms", + "google.com.mt", + "google.mu", + "google.mv", + "google.mw", + "google.com.mx", + "google.com.my", + "google.co.mz", + "google.com.na", + "google.ne", + "google.com.ng", + "google.com.ni", + "google.nl", + "google.no", + "google.com.np", + "google.nr", + "google.nu", + "google.co.nz", + "google.com.om", + "google.com.pk", + "google.com.pa", + "google.com.pe", + "google.com.ph", + "google.pl", + "google.com.pg", + "google.com.pr", + "google.ps", + "google.pt", + "google.com.py", + "google.com.qa", + "google.ro", + "google.rs", + "google.ru", + "google.rw", + "google.com.sa", + "google.com.sb", + "google.sc", + "google.se", + "google.com.sg", + "google.sh", + "google.si", + "google.sk", + "google.com.sl", + "google.sn", + "google.sm", + "google.so", + "google.sr", + "google.com.sv", + "google.td", + "google.tg", + "google.co.th", + "google.com.tj", + "google.tk", + "google.tl", + "google.tm", + "google.to", + "google.tn", + "google.com.tr", + "google.tt", + "google.com.tw", + "google.co.tz", + "google.com.ua", + "google.co.ug", + "google.co.uk", + "google.com.uy", + "google.co.uz", + "google.com.vc", + "google.co.ve", + "google.vg", + "google.co.vi", + "google.com.vn", + "google.vu", + "google.ws", + "google.co.za", + "google.co.zm", + "google.co.zw" + ], + "description": "Parameter defines the Google domain to use. It defaults to `google.com`. Head to the Google domains page for a full list of supported Google domains.", + "group": "localization" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Google search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "lr": { + "description": "Parameter defines one or multiple languages to limit the search to. It uses `lang_{two-letter language code}` to specify languages and `|` as a delimiter. (e.g., `lang_fr|lang_de` will only search French and German pages). Head to the Google lr languages page for a full list of supported languages.", + "group": "localization" + }, + "as_dt": { + "description": "Parameter controls whether to include or exclude results from the site named in the as_sitesearch parameter.", + "group": "advanced_search_query_parameters" + }, + "as_epq": { + "description": "Parameter identifies a phrase that all documents in the search results must contain. You can also use the phrase search query term to search for a phrase.", + "group": "advanced_search_query_parameters" + }, + "as_eq": { + "description": "Parameter identifies a word or phrase that should not appear in any documents in the search results. You can also use the exclude query term to ensure that a particular word or phrase will not appear in the documents in a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_lq": { + "description": "Parameter specifies that all search results should contain a link to a particular URL. You can also use the link: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_nlo": { + "description": "Parameter specifies the starting value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_nhi": { + "description": "Parameter specifies the ending value for a search range. Use as_nlo and as_nhi to append an inclusive search range.", + "group": "advanced_search_query_parameters" + }, + "as_oq": { + "description": "Parameter provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_q": { + "description": "Parameter provides search terms to check for in a document. This parameter is also commonly used to allow users to specify additional terms to search for within a set of search results.", + "group": "advanced_search_query_parameters" + }, + "as_qdr": { + "description": "Parameter requests search results from a specified time period (quick date range). The following values are supported: `d[number]`: requests results from the specified number of past days. Example for the past 10 days: `as_qdr=d10` `w[number]`: requests results from the specified number of past weeks. `m[number]`: requests results from the specified number of past months. `y[number]`: requests results from the specified number of past years. Example for the past year: `as_qdr=y`", + "group": "advanced_search_query_parameters" + }, + "as_rq": { + "description": "Parameter specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. You can also use the related: query term for this type of query.", + "group": "advanced_search_query_parameters" + }, + "as_sitesearch": { + "description": "Parameter allows you to specify that all search results should be pages from a given site. By setting the as_dt parameter, you can also use it to exclude pages from a given site from your search results.", + "group": "advanced_search_query_parameters" + }, + "tbs": { + "description": "(to be searched) parameter defines advanced search parameters that aren't possible in the regular query field. (e.g., advanced search for video duration, upload date, video quality, video source, etc.).", + "group": "advanced_filters" + }, + "safe": { + "type": "select", + "options": [ + "active", + "off" + ], + "description": "Parameter defines the level of filtering for adult content. It can be set to `active` or `off`, by default Google will blur explicit content.", + "group": "advanced_filters" + }, + "nfpr": { + "type": "checkbox", + "description": "Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude these results, or `0` to include them (default). Note that this parameter may not prevent Google from returning results for an auto-corrected query if no other results are available.", + "group": "advanced_filters" + }, + "filter": { + "type": "checkbox", + "description": "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `1` (default) to enable these filters, or `0` to disable these filters.", + "group": "advanced_filters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `google_videos_light` to use the Google Videos Light API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Google Videos Light results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/home_depot.json b/engines/home_depot.json new file mode 100644 index 0000000..3007652 --- /dev/null +++ b/engines/home_depot.json @@ -0,0 +1,127 @@ +{ + "engine": "home_depot", + "params": { + "q": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular The Home Depot search.", + "group": "search_query" + }, + "country": { + "type": "select", + "options": [ + "us", + "ca" + ], + "description": "Parameter defines the country to use for the Home Depot search. Only United States(`us`), and Canada(`ca`) are supported.", + "group": "localization" + }, + "hd_sort": { + "type": "select", + "options": [ + "top_sellers", + "price_low_to_high", + "price_high_to_low", + "top_rated", + "best_match" + ], + "description": "Parameter defines results sorted by different options in Home Depot US. It can be set to: `top_sellers`: Top Sellers, `price_low_to_high`: Price Low to High, `price_high_to_low`: Price High to Low, `top_rated`: Top Rated, `best_match`: Best Match", + "group": "advanced_home_depot_parameters" + }, + "hd_filter_tokens": { + "description": "Used to pass filter tokens divided by comma. Filter tokens can be obtained from API response", + "group": "advanced_home_depot_parameters" + }, + "delivery_zip": { + "description": "ZIP Postal code. To filter the shipping products by a selected area.", + "group": "advanced_home_depot_parameters" + }, + "store_id": { + "description": "Store ID to filter the products by the specific store only. See all Home Depot stores", + "group": "advanced_home_depot_parameters" + }, + "store": { + "description": "Store ID to filter the products by the specific store only in Home Depot Canada. The default store is Gatineau (`7140`). See all Home Depot Canada stores", + "group": "advanced_home_depot_parameters" + }, + "sort": { + "type": "select", + "options": [ + "price-asc", + "price-desc", + "reviewAvgRating", + "relevance" + ], + "description": "Parameter defines results sorted by different options in Home Depot Canada. It can be set to: `price-asc`: Price Low to High, `price-desc`: Price High to Low, `reviewAvgRating`: Top Rated, `relevance`: Recommended (Default)", + "group": "advanced_home_depot_parameters" + }, + "filter": { + "description": "Used to pass filter tokens divided by dash (-) in Home Depot Canada. Filter tokens can be obtained from API response", + "group": "advanced_home_depot_parameters" + }, + "lowerbound": { + "type": "number", + "description": "Defines lower bound for price in USD.", + "group": "price_limit" + }, + "upperbound": { + "type": "number", + "description": "Defines upper bound for price in USD.", + "group": "price_limit" + }, + "minmax": { + "description": "Defines lower and upper bound for price in CAD. Parameter is only used in the Home Depot Canada. Example: `price:[100 TO 500]`(Between $100 to $500) Example: `price:[100 TO *]`(Minimum $100) Example: `price:[0 TO 500]`(Maximum $500) Example: `price:%5B100%20TO%20500%5D`(Encoded version, Between $100 to $500)", + "group": "price_limit" + }, + "nao": { + "description": "Defines offset for products result. A single page contains 24 products. First page offset is 0, second -> 24, third -> 48 and so on.", + "group": "pagination" + }, + "page": { + "type": "number", + "description": "Value is used to get the items on a specific page. (e.g., `1` (default) is the first page of results, `2` is the 2nd page of results, `3` is the 3rd page of results, etc.). This parameter is common for both US and CA searches.", + "group": "pagination" + }, + "ps": { + "type": "number", + "description": "Determines the number of items per page. There are scenarios where The Home Depot overrides the ps value. By default, The Home Depot returns `24` results. The maximum number of results it can return is `48`.", + "group": "pagination" + }, + "pagesize": { + "description": "Determines the number of items per page in the Home Depot Canada. By default, the Home Depot Canada returns `40` (maximum allowed value) results.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `home_depot` to use the Home Depot API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Home Depot results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/home_depot_product.json b/engines/home_depot_product.json new file mode 100644 index 0000000..31850d4 --- /dev/null +++ b/engines/home_depot_product.json @@ -0,0 +1,51 @@ +{ + "engine": "home_depot_product", + "params": { + "product_id": { + "required": true, + "description": "The Home Depot identifier of a product. Only Product IDs gathered from the Home Depot US are supported.", + "group": "search_query" + }, + "delivery_zip": { + "description": "ZIP Postal code. To filter the shipping products by a selected area.", + "group": "advanced_home_depot_product_parameters" + }, + "store_id": { + "description": "Store ID to filter the products by the specific store only.", + "group": "advanced_home_depot_product_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `home_depot_product` to use the Home Depot Product API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Home Depot Product results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/home_depot_product_reviews.json b/engines/home_depot_product_reviews.json new file mode 100644 index 0000000..256de6d --- /dev/null +++ b/engines/home_depot_product_reviews.json @@ -0,0 +1,77 @@ +{ + "engine": "home_depot_product_reviews", + "params": { + "product_id": { + "required": true, + "description": "The Home Depot identifier of a product. Only Product IDs gathered from the Home Depot US are supported.", + "group": "search_query" + }, + "term": { + "description": "Parameter defines the term you want to search, only reviews with matching term will be returned.", + "group": "advanced_filters" + }, + "rating": { + "description": "Parameter defines to include only results with specified ratings. Example for single rating only: `5` Example for multiple ratings (separated by comma `,`): `5,3,2`", + "group": "advanced_filters" + }, + "sort_by": { + "type": "select", + "options": [ + "photoreview", + "mosthelpfull", + "oldest", + "newest", + "highestrating", + "lowestrating" + ], + "description": "Parameter is used for sorting reviews. By default the reviews are sorted by `newest`. Available options: `photoreview` - Photo Reviews `mosthelpfull` - Most Helpful `oldest` - Oldest `newest` - Newest `highestrating` - Highest rating `lowestrating` - Lowest rating", + "group": "advanced_filters" + }, + "verified_purchases": { + "type": "checkbox", + "description": "Parameter defines whether to include reviews from verified purchases.", + "group": "advanced_filters" + }, + "start": { + "description": "Parameter controls the offset of the reviews. This parameter defaults to `1`. If the pagesize is `100`, you have to specify start as `101` to get the 2nd page results, and the 3rd page is `201`, and so on.", + "group": "pagination" + }, + "pagesize": { + "description": "Parameter determines the number of items per page. By default, `100` (maximum allowed value) results are returned.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `home_depot_product_reviews` to use the Home Depot Product Reviews API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Home Depot Product Reviews results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/naver.json b/engines/naver.json new file mode 100644 index 0000000..7ef3ae4 --- /dev/null +++ b/engines/naver.json @@ -0,0 +1,103 @@ +{ + "engine": "naver", + "params": { + "query": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Naver search. (e.g., `'query'`, `NOT`, `OR`, `site:`, `filetype:`, `near:`, `ip:`, `loc:`, `feed:` etc.).", + "group": "search_query" + }, + "start": { + "description": "Parameter controls the offset of the organic results. This parameter defaults to 1 (except for the `web`). (e.g. The formula for all searches except the web is `start = (page number * 10) - 9` e.g. Page number 3 ` (3 * 10) - 9 = 21`) The formula for the web will be `start = (page number * 15) - 29` e.g. Page number 3 ` (3 * 15) - 29 = 16`.", + "group": "pagination" + }, + "page": { + "description": "The page parameter does the `start` parameter math for you! Just define the page number you want. Pagination starts from 1.", + "group": "pagination" + }, + "num": { + "type": "number", + "description": "Parameter defines the maximum number of results to return. `50` (default) returns 50 results. Maximum number of results to return is `100`. Parameter can only be used with Naver Images API.", + "group": "pagination" + }, + "where": { + "type": "select", + "options": [ + "nexearch", + "web", + "news", + "video", + "image" + ], + "description": "Parameter defines the Search type. This parameter defaults to `nexearch`. Available options: `nexearch`: regular Naver Search, `web`: Naver Web Organic Results, `video`: Naver Video Results, `news`: Naver News Results, `image`: Naver Images API.", + "group": "where" + }, + "sort_by": { + "type": "select", + "options": [ + "r", + "dd", + [ + "0", + "Relevance (default)" + ], + [ + "1", + "Latest" + ], + [ + "2", + "Oldest" + ] + ], + "description": "Parameter defines how the search results are sorted. This parameter defaults to `0` for Naver News Results, and `r` for other search types. For Naver News Results: `0`: Relevance (default), `1`: Latest, `2`: Oldest (only supported for news). For other search types: `r`: Relevance (default), `dd`: Latest.", + "group": "advanced_filters" + }, + "period": { + "description": "Parameter defines the time period for search results. This parameter defaults to `all`. Available options: `all`: search without time restrictions (default), `1h`: 1 hour, `1d`: 1 day, `1w`: 1 week, `1m`: 1 month, `3m`: 3 months, `6m`: 6 months, `1y`: 1 year, Custom date range in the format `fromYYYYMMDDtoYYYYMMDD` (e.g., `from20250801to20250830`). Additional options for Naver News Results only: `2h`: 2 hours, `3h`: 3 hours, `4h`: 4 hours, `5h`: 5 hours, `6h`: 6 hours.", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `naver` to use the Naver API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Naver results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/open_table_reviews.json b/engines/open_table_reviews.json new file mode 100644 index 0000000..220e3f3 --- /dev/null +++ b/engines/open_table_reviews.json @@ -0,0 +1,72 @@ +{ + "engine": "open_table_reviews", + "params": { + "place_id": { + "required": true, + "description": "Parameter defines the OpenTable ID of a restaurant. This identifier can be found in the URL of the restaurant's page, immediately following `/r/`. For example, in the URL `https://www.opentable.com/r/central-park-boathouse-new-york-2`, the ID is `central-park-boathouse-new-york-2`.", + "group": "search_query" + }, + "open_table_domain": { + "type": "select", + "options": [ + "opentable.com", + "opentable.jp", + "opentable.de", + "opentable.es", + "opentable.ca", + "opentable.hk", + "opentable.ie", + "opentable.sg", + "opentable.nl", + "opentable.com.mx", + "opentable.co.uk", + "opentable.com.au", + "opentable.ae", + "opentable.co.th", + "opentable.it", + "opentable.com.tw", + "opentable.fr" + ], + "description": "Parameter defines the OpenTable domain to use. It defaults to `www.opentable.com`. Head to the OpenTable domains page for a full list of supported OpenTable domains.", + "group": "localization" + }, + "page": { + "type": "number", + "description": "Parameter defines the page number. `1` (default) is the first page of 10 results, `2` is the 2nd page, etc.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `open_table_reviews` to use the OpenTable Reviews API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the OpenTable Reviews results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/tripadvisor.json b/engines/tripadvisor.json new file mode 100644 index 0000000..9742cf7 --- /dev/null +++ b/engines/tripadvisor.json @@ -0,0 +1,133 @@ +{ + "engine": "tripadvisor", + "params": { + "q": { + "required": true, + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Tripadvisor search.", + "group": "search_query" + }, + "lat": { + "type": "number", + "description": "Defines a GPS latitude for the search origin.", + "group": "geographic_location" + }, + "lon": { + "type": "number", + "description": "Defines a GPS longitude for the search origin.", + "group": "geographic_location" + }, + "tripadvisor_domain": { + "type": "select", + "options": [ + "www.tripadvisor.com", + "www.tripadvisor.ca", + "fr.tripadvisor.ca", + "www.tripadvisor.com.br", + "www.tripadvisor.com.mx", + "www.tripadvisor.com.ar", + "www.tripadvisor.cl", + "www.tripadvisor.co", + "www.tripadvisor.com.pe", + "www.tripadvisor.com.ve", + "www.tripadvisor.co.uk", + "www.tripadvisor.it", + "www.tripadvisor.es", + "www.tripadvisor.de", + "www.tripadvisor.fr", + "www.tripadvisor.se", + "www.tripadvisor.nl", + "www.tripadvisor.com.tr", + "www.tripadvisor.dk", + "www.tripadvisor.ie", + "www.tripadvisor.at", + "www.tripadvisor.com.gr", + "no.tripadvisor.com", + "www.tripadvisor.pt", + "www.tripadvisor.ru", + "www.tripadvisor.ch", + "fr.tripadvisor.ch", + "it.tripadvisor.ch", + "fr.tripadvisor.be", + "www.tripadvisor.be", + "www.tripadvisor.jp", + "cn.tripadvisor.com", + "www.tripadvisor.in", + "www.tripadvisor.com.au", + "www.tripadvisor.com.my", + "www.tripadvisor.co.nz", + "www.tripadvisor.com.ph", + "www.tripadvisor.com.sg", + "www.tripadvisor.co.id", + "www.tripadvisor.co.kr", + "th.tripadvisor.com", + "www.tripadvisor.com.vn", + "www.tripadvisor.com.tw", + "en.tripadvisor.com.hk", + "www.tripadvisor.com.hk", + "ar.tripadvisor.com", + "www.tripadvisor.com.eg", + "www.tripadvisor.co.za", + "www.tripadvisor.co.il" + ], + "description": "Parameter defines the Tripadvisor domain to use. It defaults to `tripadvisor.com`. Head to the Tripadvisor domains page for a full list of supported Tripadvisor domains.", + "group": "localization" + }, + "ssrc": { + "type": "select", + "options": [ + "a", + "r", + "A", + "h", + "g", + "v", + "f" + ], + "description": "This parameter specifies the search filter you want to use for the Tripadvisor search. Available options: `a` - All Results `r` - Restaurants `A` - Things to Do `h` - Hotels `g` - Destinations `v` - Vacation Rentals `f` - Forums", + "group": "advanced_filters" + }, + "offset": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `30` is the 2nd page of results, `60` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "limit": { + "type": "number", + "description": "Parameter defines the maximum number of results to return. (e.g., `30` (default) returns 30 results, `60` returns 60 results, and `100` returns 100 results).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `tripadvisor` to use the Tripadvisor API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Tripadvisor results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/tripadvisor_place.json b/engines/tripadvisor_place.json new file mode 100644 index 0000000..e5d134f --- /dev/null +++ b/engines/tripadvisor_place.json @@ -0,0 +1,99 @@ +{ + "engine": "tripadvisor_place", + "params": { + "place_id": { + "required": true, + "description": "Parameter defines the Tripadvisor place ID. To extract the ID of a place, you can use our Tripadvisor Search API.", + "group": "search_query" + }, + "tripadvisor_domain": { + "type": "select", + "options": [ + "www.tripadvisor.com", + "www.tripadvisor.ca", + "fr.tripadvisor.ca", + "www.tripadvisor.com.br", + "www.tripadvisor.com.mx", + "www.tripadvisor.com.ar", + "www.tripadvisor.cl", + "www.tripadvisor.co", + "www.tripadvisor.com.pe", + "www.tripadvisor.com.ve", + "www.tripadvisor.co.uk", + "www.tripadvisor.it", + "www.tripadvisor.es", + "www.tripadvisor.de", + "www.tripadvisor.fr", + "www.tripadvisor.se", + "www.tripadvisor.nl", + "www.tripadvisor.com.tr", + "www.tripadvisor.dk", + "www.tripadvisor.ie", + "www.tripadvisor.at", + "www.tripadvisor.com.gr", + "no.tripadvisor.com", + "www.tripadvisor.pt", + "www.tripadvisor.ru", + "www.tripadvisor.ch", + "fr.tripadvisor.ch", + "it.tripadvisor.ch", + "fr.tripadvisor.be", + "www.tripadvisor.be", + "www.tripadvisor.jp", + "cn.tripadvisor.com", + "www.tripadvisor.in", + "www.tripadvisor.com.au", + "www.tripadvisor.com.my", + "www.tripadvisor.co.nz", + "www.tripadvisor.com.ph", + "www.tripadvisor.com.sg", + "www.tripadvisor.co.id", + "www.tripadvisor.co.kr", + "th.tripadvisor.com", + "www.tripadvisor.com.vn", + "www.tripadvisor.com.tw", + "en.tripadvisor.com.hk", + "www.tripadvisor.com.hk", + "ar.tripadvisor.com", + "www.tripadvisor.com.eg", + "www.tripadvisor.co.za", + "www.tripadvisor.co.il" + ], + "description": "Parameter defines the Tripadvisor domain to use. It defaults to `tripadvisor.com`. Head to the Tripadvisor domains page for a full list of supported Tripadvisor domains.", + "group": "localization" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `tripadvisor_place` to use the Tripadvisor Place API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Tripadvisor Place results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/walmart.json b/engines/walmart.json new file mode 100644 index 0000000..1b792fd --- /dev/null +++ b/engines/walmart.json @@ -0,0 +1,112 @@ +{ + "engine": "walmart", + "params": { + "query": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Walmart search. Either a `query` or a `cat_id` parameter is required.", + "group": "search_query" + }, + "sort": { + "type": "select", + "options": [ + "price_low", + "price_high", + "best_seller", + "best_match", + "rating_high" + ], + "description": "Parameter defines sorting. (e.g. `price_low`, `price_high`, `best_seller`, `best_match`, `rating_high`, `new`)", + "group": "advanced_walmart_parameters" + }, + "soft_sort": { + "type": "checkbox", + "description": "Parameter enables sort by relevance. Walmart is by default showing results sorted by relevance and using the `sort` option. Set to `false` to disable sort by Relevance.", + "group": "advanced_walmart_parameters" + }, + "cat_id": { + "description": "Category on Walmart Search. (e.g. `0` (default) is all departments, `976759_976787` is 'Cookies', etc.). Either a `query` or a `cat_id` parameter is required.", + "group": "advanced_filters" + }, + "facet": { + "description": "Parameter defines items filtering based on their attributes. The structure is a list of `key:value` pairs separated by `||`. The key and value are separated by `:`", + "group": "advanced_filters" + }, + "store_id": { + "description": "Store ID to filter the products by the specific store only. Head to the Walmart Stores Locations for a full list of supported stores. It's possible for the product pricing to differ between stores.", + "group": "advanced_filters" + }, + "min_price": { + "type": "number", + "description": "Lower bound of price range query.", + "group": "advanced_filters" + }, + "max_price": { + "type": "number", + "description": "Upper bound of price range query.", + "group": "advanced_filters" + }, + "spelling": { + "type": "checkbox", + "description": "Activate spelling fix. `true` (default) includes spelling fix, `false` searches without spelling fix.", + "group": "advanced_filters" + }, + "nd_en": { + "type": "checkbox", + "description": "Show results with NextDay delivery only. Set to `true` to enable or `false` (default) to disable", + "group": "advanced_filters" + }, + "page": { + "type": "number", + "description": "Value is used to get the items on a specific page. (e.g., `1` (default) is the first page of results, `2` is the 2nd page of results, `3` is the 3rd page of results, etc.). Maximum page value is `100`.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `walmart` to use the Walmart API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Walmart results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + }, + "include_filters": { + "type": "checkbox", + "description": "Include `filters` to the JSON response. Set to `true` to enable or `false` to disable (default).", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/walmart_product.json b/engines/walmart_product.json new file mode 100644 index 0000000..16e9b42 --- /dev/null +++ b/engines/walmart_product.json @@ -0,0 +1,57 @@ +{ + "engine": "walmart_product", + "params": { + "product_id": { + "required": true, + "description": "Parameter defines the product to get results for. Normally found from shopping results for supported products (e.g., `https://www.walmart.com/ip/{product_id}`). You can pass `product_id` and `us_item_id`. Responses from Walmart.com are faster when `product_id` is used.", + "group": "search_query" + }, + "store_id": { + "description": "Store ID to filter the products by the specific store only. Head to the Walmart Stores Locations for a full list of supported stores. It's possible for the product pricing to differ between stores.", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `walmart_product` to use the Walmart Product API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Walmart Product results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/walmart_product_reviews.json b/engines/walmart_product_reviews.json new file mode 100644 index 0000000..911cb22 --- /dev/null +++ b/engines/walmart_product_reviews.json @@ -0,0 +1,88 @@ +{ + "engine": "walmart_product_reviews", + "params": { + "product_id": { + "required": true, + "description": "Parameter defines the unique product identifier to get reviews of a specific product. You need to pass the `us_item_id`. It can be found from either Organic Results API or Product API results.", + "group": "search_query" + }, + "rating": { + "type": "select", + "options": [ + [ + "1", + "1-star" + ], + [ + "2", + "2-star" + ], + [ + "3", + "3-star" + ], + [ + "4", + "4-star" + ], + [ + "5", + "5-star" + ] + ], + "description": "Parameter is used for filtering reviews by rating. It can be set to: `1`: 1-star, `2`: 2-star, `3`: 3-star, `4`: 4-star, `5`: 5-star.", + "group": "advanced_walmart_parameters" + }, + "sort": { + "type": "select", + "options": [ + "relevancy", + "helpful", + "submission-desc", + "submission-asc", + "rating-desc", + "rating-asc" + ], + "description": "Parameter is used for sorting reviews. It can be set to: `relevancy`, `helpful`, `submission-desc`, `submission-asc`, `rating-desc`, `rating-asc`", + "group": "advanced_walmart_parameters" + }, + "page": { + "type": "number", + "description": "Value is used to get the reviews on a specific page. (e.g., `1` (default) is the first page of results, `2` is the 2nd page of results, `3` is the 3rd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `walmart_product_reviews` to use the Walmart Product Reviews API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Walmart Product Reviews results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/walmart_product_sellers.json b/engines/walmart_product_sellers.json new file mode 100644 index 0000000..56acfe7 --- /dev/null +++ b/engines/walmart_product_sellers.json @@ -0,0 +1,47 @@ +{ + "engine": "walmart_product_sellers", + "params": { + "product_id": { + "required": true, + "description": "Parameter defines the unique product identifier to get more seller options of a specific product. You need to pass the `us_item_id`. It can be found from either Organic Results API or Product API results.", + "group": "search_query" + }, + "store_id": { + "description": "Store ID to filter the products by the specific store only. Head to the Walmart Stores Locations for a full list of supported stores. It's possible for the product pricing to differ between stores.", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `walmart_product_sellers` to use the Walmart Product Sellers API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Walmart Product Sellers results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yahoo.json b/engines/yahoo.json new file mode 100644 index 0000000..6e84f19 --- /dev/null +++ b/engines/yahoo.json @@ -0,0 +1,280 @@ +{ + "engine": "yahoo", + "params": { + "p": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Yahoo! search.", + "group": "search_query" + }, + "yahoo_domain": { + "type": "select", + "options": [ + "espanol", + "be", + "fr", + "br", + "ca", + "espanol", + "espanol", + "de", + "es", + "espanol", + "fr", + "in", + "id", + "ie", + "it", + "malaysia", + "espanol", + "nl", + "no", + "at", + "espanol", + "ph", + "pl", + "qc", + "ro", + "ch", + "sg", + "za", + "fi", + "se", + "tr", + "uk", + "espanol", + "vn", + "gr", + "ru", + "ua", + "il", + "hk", + "tw" + ], + "description": "Parameter defines the Yahoo! domain to use. It defaults to `search.yahoo.com`. If specified domain is allowed, it will be prepended to the domain (e.g., `fr.search.yahoo.com`). You can check a full list of supported Yahoo! domains.", + "group": "localization" + }, + "vc": { + "type": "select", + "options": [ + "al", + "dz", + "ar", + "am", + "au", + "at", + "az", + "bh", + "be", + "bo", + "ba", + "br", + "bg", + "ca", + "cl", + "cn", + "co", + "cr", + "hr", + "cz", + "dk", + "do", + "ec", + "eg", + "sv", + "ee", + "fi", + "mk", + "fr", + "ge", + "de", + "gr", + "gt", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "il", + "it", + "jp", + "jo", + "ke", + "kr", + "kw", + "lv", + "lb", + "ly", + "lt", + "lu", + "my", + "mt", + "mx", + "ma", + "nl", + "nz", + "ni", + "no", + "om", + "pk", + "pa", + "py", + "pe", + "ph", + "pl", + "pt", + "pr", + "qa", + "ro", + "ru", + "sa", + "sp", + "sg", + "sk", + "sl", + "za", + "es", + "se", + "ch", + "sy", + "tw", + "th", + "tn", + "tr", + "ae", + "ua", + "gb", + "us", + "vn", + "ye" + ], + "description": "Parameter defines the country to use for the Yahoo! search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Yahoo! countries for a full list of supported Yahoo! countries.", + "group": "localization" + }, + "vl": { + "type": "select", + "options": [ + "lang_ar", + "lang_bg", + "lang_zh_chs", + "lang_zh_cht", + "lang_hr", + "lang_cs", + "lang_da", + "lang_nl", + "lang_en", + "lang_et", + "lang_fi", + "lang_fr", + "lang_de", + "lang_el", + "lang_he", + "lang_hu", + "lang_it", + "lang_ja", + "lang_ko", + "lang_lv", + "lang_lt", + "lang_no", + "lang_pl", + "lang_pt", + "lang_ro", + "lang_ru", + "lang_sk", + "lang_sl", + "lang_es", + "lang_sv", + "lang_th", + "lang_tr" + ], + "description": "Parameter defines language to limit the search to. It uses `lang_{two-letter language code}` to specify languages. (e.g., `vl=lang_fr` will only search French). `fl` will be set to `1` if this parameter is used. You can check a full list of supported Yahoo! languages.", + "group": "localization" + }, + "b": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `1` (default) is the first page of results, `11` is the 2nd page of results, `21` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "vm": { + "type": "select", + "options": [ + "r", + "i", + "p" + ], + "description": "Parameter defines the level of filtering for adult content. Strict: `r`, Moderate: `i`, Off: `p`", + "group": "advanced_filters" + }, + "vs": { + "description": "Filter results by top-level domains separated by ','. (e.g., `.com,.org`)", + "group": "advanced_filters" + }, + "vf": { + "type": "select", + "options": [ + "html", + "pdf", + "xls", + "ppt", + "doc", + "txt" + ], + "description": "`all formats` or specific file format like `pdf` or `txt`. You can check a full list of supported Yahoo! file formats.", + "group": "advanced_filters" + }, + "fr2": { + "description": "Parameter is responsible for rendering positions and expansions for some elements (e.g., `p:s,v:w,m:trendingdomain_center` to expand Related Trending Searches).", + "group": "advanced_filters" + }, + "d": { + "description": "Parameter specifies the destination for related topics. By including a unique identifier for the destination page, this parameter directs users to specific content related to their search query, providing them with more targeted results. (e.g. `{\"dn\":\"topic\",\"ykid\":\"71698d3e-6ef0-4fcd-8551-1ffe56058857\",\"pos\":\"0\",\"oq\":\"Coffee\",\"rq\":\"Drinking\"}`)", + "group": "advanced_filters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yahoo` to use the Yahoo API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yahoo results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yahoo_images.json b/engines/yahoo_images.json new file mode 100644 index 0000000..34f7c1d --- /dev/null +++ b/engines/yahoo_images.json @@ -0,0 +1,193 @@ +{ + "engine": "yahoo_images", + "params": { + "p": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Yahoo! Images search.", + "group": "search_query" + }, + "yahoo_domain": { + "type": "select", + "options": [ + "espanol", + "be", + "fr", + "br", + "ca", + "espanol", + "espanol", + "de", + "es", + "espanol", + "fr", + "in", + "id", + "ie", + "it", + "malaysia", + "espanol", + "nl", + "no", + "at", + "espanol", + "ph", + "pl", + "qc", + "ro", + "ch", + "sg", + "za", + "fi", + "se", + "tr", + "uk", + "espanol", + "vn", + "gr", + "ru", + "ua", + "il", + "hk", + "tw" + ], + "description": "Parameter defines the Yahoo! domain to use. It defaults to `search.yahoo.com`. If specified domain is allowed, it will be prepended to the domain (e.g., `fr.search.yahoo.com`). You can check a full list of supported Yahoo! domains.", + "group": "localization" + }, + "imgsz": { + "type": "select", + "options": [ + "small", + "medium", + "large", + "wallpaper" + ], + "description": "Parameter is used for filtering images by size. It can be set to: `small` - Small `medium` - Medium `large` - Large `wallpaper` - Extra Large", + "group": "advanced_yahoo_images_parameters" + }, + "imgc": { + "type": "select", + "options": [ + "color", + "bw", + "red", + "orange", + "yellow", + "green", + "teal", + "blue", + "purple", + "pink", + "brown", + "black", + "gray", + "white" + ], + "description": "Parameter is used for filtering images by color. It can be set to: `color` - Color Only `bw` - Black & white `red` - Red color `orange` - Orange color `yellow` - Yellow color `green` - Green color `teal` - Teal color `blue` - Blue color `purple` - Purple color `pink` - Pink color `brown` - Brown color `black` - Black color `gray` - Gray color `white` - White color", + "group": "advanced_yahoo_images_parameters" + }, + "imgty": { + "type": "select", + "options": [ + "photo", + "clipart", + "linedrawing", + "gif", + "transparent" + ], + "description": "Parameter is used for filtering images by image type. It can be set to: `photo` - Photo `clipart` - Clipart `linedrawing` - Line Drawing `gif` - Animated GIF `transparent` - Transparent", + "group": "advanced_yahoo_images_parameters" + }, + "imga": { + "type": "select", + "options": [ + "square", + "wide", + "tall" + ], + "description": "Parameter is used for filtering images by layout. It can be set to: `square` - Square `wide` - Wide `tall` - Tall", + "group": "advanced_yahoo_images_parameters" + }, + "imgf": { + "type": "select", + "options": [ + "face", + "portrait", + "nonportrait" + ], + "description": "Parameter is used for filtering images by people. It can be set to: `face` - Faces Only `portrait` - Head & Shoulders `nonportrait` - No People", + "group": "advanced_yahoo_images_parameters" + }, + "imgt": { + "type": "select", + "options": [ + "day", + "week", + "month", + "year" + ], + "description": "Parameter is used for filtering images by time. It can be set to: `day` - Past 24 hours `week` - Past week `month` - Past month `year` - Past year", + "group": "advanced_yahoo_images_parameters" + }, + "imgl": { + "type": "select", + "options": [ + "cc", + "pd", + "fsu", + "fsuc", + "fmsu", + "fmsuc" + ], + "description": "Parameter is used for filtering images by usage rights. It can be set to: `cc` - All Creative Commons `pd` - Public Domain `fsu` - Free to share and use `fsuc` - Free to share and use commercially `fmsu` - Free to modify, share and use `fmsuc` - Free to modify, share, and use commercially", + "group": "advanced_yahoo_images_parameters" + }, + "b": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `1` (default) starts from the first result, `61` starts from the 61st result, `121` starts from the 121st result, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yahoo_images` to use the Yahoo Images API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yahoo Images results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yahoo_shopping.json b/engines/yahoo_shopping.json new file mode 100644 index 0000000..ed5a257 --- /dev/null +++ b/engines/yahoo_shopping.json @@ -0,0 +1,91 @@ +{ + "engine": "yahoo_shopping", + "params": { + "p": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Yahoo! shopping search.", + "group": "search_query" + }, + "min_price": { + "description": "Lower bound of price range query.", + "group": "advanced_yahoo_shopping_parameters" + }, + "max_price": { + "description": "Upper bound of price range query.", + "group": "advanced_yahoo_shopping_parameters" + }, + "sort_by": { + "type": "select", + "options": [ + "price", + "relevancy", + "popularity", + "discountPercentage" + ], + "description": "Parameter is used for sorting and refining results. Available options: `price` - the costliest items first. `relevancy` - the most relevant items first. `popularity` - the most popular items first. `discountPercentage` - the highest discounted items (by percentage) first.", + "group": "advanced_yahoo_shopping_parameters" + }, + "order_by": { + "type": "select", + "options": [ + "ASC", + "DESC" + ], + "description": "Parameter used to sort the query results in a top to bottom style or vice-versa. Available options: `ASC` and `DESC`.", + "group": "advanced_yahoo_shopping_parameters" + }, + "category_attr_values": { + "description": "Gender and Age Range filters on Yahoo! Shopping Search separated by comma (`,`). (e.g. `gender_female,age_adult` is 'female' and 'adult', etc.). Can be obtained from `filters.gender` and `filters.age-range` in API response.", + "group": "advanced_yahoo_shopping_parameters" + }, + "merchants": { + "description": "Merchants ID separated by comma (`,`). Merchant IDs can be obtained from `filters.stores` in API response. (e.g. `3719d8d4-5edd-4817-998a-91f3229e7323,` is 'Walmart', etc.)", + "group": "advanced_yahoo_shopping_parameters" + }, + "start": { + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `1` (default) is the first page of results, `60` is the 2nd page of results, `120` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "limit": { + "description": "Parameter defines the maximum number of results to return. (e.g., `10` (default) returns 10 results, `40` returns 40 results, and `100` returns 100 results).", + "group": "pagination" + }, + "page": { + "description": "The page parameter does the `start` parameter math for you! Just define the page number you want. Pagination starts from 1.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yahoo_shopping` to use the Yahoo Shopping API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yahoo Shopping results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yahoo_videos.json b/engines/yahoo_videos.json new file mode 100644 index 0000000..df752f0 --- /dev/null +++ b/engines/yahoo_videos.json @@ -0,0 +1,152 @@ +{ + "engine": "yahoo_videos", + "params": { + "p": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Yahoo! Videos search.", + "group": "search_query" + }, + "yahoo_domain": { + "type": "select", + "options": [ + "espanol", + "be", + "fr", + "br", + "ca", + "espanol", + "espanol", + "de", + "es", + "espanol", + "fr", + "in", + "id", + "ie", + "it", + "malaysia", + "espanol", + "nl", + "no", + "at", + "espanol", + "ph", + "pl", + "qc", + "ro", + "ch", + "sg", + "za", + "fi", + "se", + "tr", + "uk", + "espanol", + "vn", + "gr", + "ru", + "ua", + "il", + "hk", + "tw" + ], + "description": "Parameter defines the Yahoo! domain to use. It defaults to `search.yahoo.com`. If specified domain is allowed, it will be prepended to the domain (e.g., `fr.search.yahoo.com`). You can check a full list of supported Yahoo! domains.", + "group": "localization" + }, + "durs": { + "type": "select", + "options": [ + "short", + "medium", + "long" + ], + "description": "Parameter is used for filtering videos by length. It can be set to: `short` - Short (less than 5 minutes) `medium` - Medium (5-20 minutes) `long` - Long (more than 20 minutes)", + "group": "advanced_yahoo_videos_parameters" + }, + "vage": { + "type": "select", + "options": [ + "day", + "week", + "month", + "year" + ], + "description": "Parameter is used for filtering videos by date. It can be set to: `day` - Past 24 hours `week` - Past week `month` - Past month `year` - Past year", + "group": "advanced_yahoo_videos_parameters" + }, + "vres": { + "type": "select", + "options": [ + "360p", + "480p", + "720p", + "1080p" + ], + "description": "Parameter is used for filtering videos by resolution. It can be set to: `360p` - 360p or higher `480p` - 480p or higher `720p` - 720p or higher `1080p` - 1080p or higher", + "group": "advanced_yahoo_videos_parameters" + }, + "vsite": { + "type": "select", + "options": [ + "youtube", + "dailymotion", + "vimeo", + "mtv", + "cbsnews", + "foxnews", + "cnn", + "msn" + ], + "description": "Parameter is used for filtering videos by source. It can be set to: `youtube` - YouTube `dailymotion` - Dailymotion `vimeo` - Vimeo `mtv` - MTV `cbsnews` - CBS `foxnews` - Fox `cnn` - CNN `msn` - MSN", + "group": "advanced_yahoo_videos_parameters" + }, + "b": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `1` (default) starts from the first result, `61` starts from the 61st result, `121` starts from the 121st result, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yahoo_videos` to use the Yahoo Videos API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yahoo Videos results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yandex.json b/engines/yandex.json new file mode 100644 index 0000000..0298216 --- /dev/null +++ b/engines/yandex.json @@ -0,0 +1,4139 @@ +{ + "engine": "yandex", + "params": { + "text": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Yandex search.", + "group": "search_query" + }, + "yandex_domain": { + "type": "select", + "options": [ + "yandex.com", + "yandex.ru", + "ya.ru", + "yandex.by", + "yandex.kz", + "yandex.uz", + "yandex.com.tr", + "yandex.az", + "yandex.com.ge", + "yandex.com.am", + "yandex.co.il", + "yandex.md", + "yandex.tm", + "yandex.tj", + "yandex.eu" + ], + "description": "Parameter defines the Yandex domain to use. It defaults to `yandex.com`. Head to the Yandex domains for a full list of supported Yandex domains. A default lr is used for each yandex_domain. Example: `84`(US) for `yandex.com` A default lang parameter `en`(English) is used for `yandex.com`", + "group": "localization" + }, + "lang": { + "type": "select", + "options": [ + "null", + "ru", + "en", + "be", + "fr", + "de", + "id", + "kk", + "tt", + "tr", + "uk", + "uz", + "az", + "hy", + "lv", + "lt", + "et", + "ro", + "tk" + ], + "description": "Parameter defines the language to use for the Yandex search. Head to the Yandex languages for a full list of supported Yandex languages. It defaults to `en` when yandex_domain is `yandex.com`. If you want to disable this parameter, set its value to `null`(\"Unspecified\"). You can also pass 2-letter country codes separated by commas, for example: `ru,en` to get results in multiple languages.", + "group": "localization" + }, + "lr": { + "type": "select", + "options": [ + [ + 1, + "Moscow and Moscow Oblast" + ], + [ + 2, + "Saint Petersburg" + ], + [ + 3, + "Central Federal District" + ], + [ + 4, + "Belgorod" + ], + [ + 5, + "Ivanovo" + ], + [ + 6, + "Kaluga" + ], + [ + 7, + "Kostroma" + ], + [ + 8, + "Kursk" + ], + [ + 9, + "Lipetsk" + ], + [ + 10, + "Orel" + ], + [ + 11, + "Ryazan" + ], + [ + 12, + "Smolensk" + ], + [ + 13, + "Tambov" + ], + [ + 14, + "Tver" + ], + [ + 15, + "Tula" + ], + [ + 16, + "Yaroslavl" + ], + [ + 17, + "Northwestern Federal District" + ], + [ + 18, + "Petrozavodsk" + ], + [ + 19, + "Syktyvkar" + ], + [ + 20, + "Arkhangelsk" + ], + [ + 21, + "Vologda" + ], + [ + 22, + "Kaliningrad" + ], + [ + 23, + "Murmansk" + ], + [ + 24, + "Veliky Novgorod" + ], + [ + 25, + "Pskov" + ], + [ + 26, + "Southern Federal District" + ], + [ + 28, + "Makhachkala" + ], + [ + 30, + "Nalchik" + ], + [ + 33, + "Vladikavkaz" + ], + [ + 35, + "Krasnodar" + ], + [ + 36, + "Stavropol" + ], + [ + 37, + "Astrahan" + ], + [ + 38, + "Volgograd" + ], + [ + 39, + "Rostov-na-Donu" + ], + [ + 40, + "Volga Federal District" + ], + [ + 41, + "Yoshkar-Ola" + ], + [ + 42, + "Saransk" + ], + [ + 43, + "Kazan" + ], + [ + 44, + "Izhevsk" + ], + [ + 45, + "Cheboksary" + ], + [ + 46, + "Kirov" + ], + [ + 47, + "Nizhny Novgorod" + ], + [ + 48, + "Orenburg" + ], + [ + 49, + "Penza" + ], + [ + 50, + "Perm" + ], + [ + 51, + "Samara" + ], + [ + 52, + "Ural Federal District" + ], + [ + 53, + "Kurgan" + ], + [ + 54, + "Yekaterinburg" + ], + [ + 55, + "Tyumen" + ], + [ + 56, + "Chelyabinsk" + ], + [ + 57, + "Khanty-Mansiysk" + ], + [ + 58, + "Salekhard" + ], + [ + 59, + "Siberian Federal District" + ], + [ + 62, + "Krasnoyarsk" + ], + [ + 63, + "Irkutsk" + ], + [ + 64, + "Kemerovo" + ], + [ + 65, + "Novosibirsk" + ], + [ + 66, + "Omsk" + ], + [ + 67, + "Tomsk" + ], + [ + 68, + "Chita" + ], + [ + 73, + "Far Eastern Federal District" + ], + [ + 74, + "Yakutsk" + ], + [ + 75, + "Vladivostok" + ], + [ + 76, + "Khabarovsk" + ], + [ + 77, + "Blagoveshchensk" + ], + [ + 78, + "Petropavlovsk" + ], + [ + 79, + "Magadan" + ], + [ + 80, + "Yuzhno-Sakhalinsk" + ], + [ + 84, + "United States" + ], + [ + 86, + "Atlanta" + ], + [ + 87, + "Washington" + ], + [ + 89, + "Detroit" + ], + [ + 90, + "San Francisco" + ], + [ + 91, + "Seattle" + ], + [ + 93, + "Argentina" + ], + [ + 94, + "Brazil" + ], + [ + 95, + "Canada" + ], + [ + 96, + "Germany" + ], + [ + 97, + "Heidelberg" + ], + [ + 98, + "Cologne" + ], + [ + 99, + "Munich" + ], + [ + 100, + "Frankfurt am Main" + ], + [ + 101, + "Stuttgart" + ], + [ + 102, + "United Kingdom" + ], + [ + 111, + "Europe" + ], + [ + 113, + "Austria" + ], + [ + 114, + "Belgium" + ], + [ + 115, + "Bulgaria" + ], + [ + 116, + "Hungary" + ], + [ + 117, + "Lithuania" + ], + [ + 118, + "Netherlands" + ], + [ + 119, + "Norway" + ], + [ + 120, + "Poland" + ], + [ + 121, + "Slovakia" + ], + [ + 122, + "Slovenia" + ], + [ + 123, + "Finland" + ], + [ + 124, + "France" + ], + [ + 125, + "Czech Republic" + ], + [ + 126, + "Switzerland" + ], + [ + 127, + "Sweden" + ], + [ + 129, + "Beer-Sheva" + ], + [ + 130, + "Jerusalem" + ], + [ + 131, + "Tel Aviv" + ], + [ + 132, + "Haifa" + ], + [ + 134, + "China" + ], + [ + 135, + "South Korea" + ], + [ + 137, + "Japan" + ], + [ + 138, + "Australia and Oceania" + ], + [ + 139, + "New Zealand" + ], + [ + 141, + "Dnipro" + ], + [ + 142, + "Donetsk" + ], + [ + 143, + "Kyiv" + ], + [ + 144, + "Lviv" + ], + [ + 145, + "Odesa" + ], + [ + 146, + "Simferopol" + ], + [ + 147, + "Kharkiv" + ], + [ + 148, + "Mykolaiv" + ], + [ + 149, + "Belarus" + ], + [ + 153, + "Brest" + ], + [ + 154, + "Vitebsk" + ], + [ + 155, + "Gomel" + ], + [ + 157, + "Minsk" + ], + [ + 158, + "Mogilev" + ], + [ + 159, + "Kazakhstan" + ], + [ + 162, + "Almaty" + ], + [ + 163, + "Astana" + ], + [ + 164, + "Karaganda" + ], + [ + 165, + "Semey" + ], + [ + 166, + "CIS" + ], + [ + 167, + "Azerbaijan" + ], + [ + 168, + "Armenia" + ], + [ + 169, + "Georgia" + ], + [ + 170, + "Turkmenistan" + ], + [ + 171, + "Uzbekistan" + ], + [ + 172, + "Ufa" + ], + [ + 177, + "Berlin" + ], + [ + 178, + "Hamburg" + ], + [ + 179, + "Estonia" + ], + [ + 180, + "Serbia" + ], + [ + 181, + "Israel" + ], + [ + 183, + "Asia" + ], + [ + 187, + "Ukraine" + ], + [ + 190, + "Pavlodar" + ], + [ + 191, + "Bryansk" + ], + [ + 192, + "Vladimir" + ], + [ + 193, + "Voronezh" + ], + [ + 194, + "Saratov" + ], + [ + 195, + "Ulyanovsk" + ], + [ + 197, + "Barnaul" + ], + [ + 198, + "Ulan-Ude" + ], + [ + 200, + "Los Angeles" + ], + [ + 202, + "New York" + ], + [ + 203, + "Denmark" + ], + [ + 204, + "Spain" + ], + [ + 205, + "Italy" + ], + [ + 206, + "Latvia" + ], + [ + 207, + "Kyrgyzstan" + ], + [ + 208, + "Moldova" + ], + [ + 209, + "Tajikistan" + ], + [ + 210, + "United Arab Emirates" + ], + [ + 211, + "Australia" + ], + [ + 213, + "Moscow" + ], + [ + 214, + "Dolgoprudniy" + ], + [ + 215, + "Dubna" + ], + [ + 216, + "Zelenograd" + ], + [ + 217, + "Pushino" + ], + [ + 219, + "Chernogolovka" + ], + [ + 221, + "Chimkent" + ], + [ + 222, + "Luhansk" + ], + [ + 223, + "Boston" + ], + [ + 225, + "Russia" + ], + [ + 235, + "Magnitogorsk" + ], + [ + 236, + "Naberezhnye Chelny" + ], + [ + 237, + "Novokuznetsk" + ], + [ + 238, + "Novocherkassk" + ], + [ + 239, + "Sochi" + ], + [ + 240, + "Togliatti" + ], + [ + 241, + "Africa" + ], + [ + 245, + "Arctic and Antarctic" + ], + [ + 246, + "Greece" + ], + [ + 382, + "The All-Russian" + ], + [ + 959, + "Sevastopol" + ], + [ + 960, + "Zaporizhia" + ], + [ + 961, + "Khmelnytskyi" + ], + [ + 962, + "Kherson" + ], + [ + 963, + "Vinnytsia" + ], + [ + 964, + "Poltava" + ], + [ + 965, + "Sumy" + ], + [ + 966, + "Chernihiv" + ], + [ + 967, + "Obninsk" + ], + [ + 968, + "Cherepovets" + ], + [ + 969, + "Vyborg" + ], + [ + 970, + "Novorossiysk" + ], + [ + 971, + "Taganrog" + ], + [ + 972, + "Dzerzhinsk" + ], + [ + 973, + "Surgut" + ], + [ + 974, + "Nahodka" + ], + [ + 975, + "Biysk" + ], + [ + 976, + "Bratsk" + ], + [ + 977, + "Republic of Crimea" + ], + [ + 980, + "Baltic" + ], + [ + 983, + "Turkey" + ], + [ + 994, + "India" + ], + [ + 995, + "Thailand" + ], + [ + 1004, + "Middle East" + ], + [ + 1056, + "Egypt" + ], + [ + 1058, + "Tuapse" + ], + [ + 1091, + "Nizhnevartovsk" + ], + [ + 1092, + "Nazran" + ], + [ + 1093, + "Maykop" + ], + [ + 1094, + "Elista" + ], + [ + 1095, + "Abakan" + ], + [ + 1104, + "Cherkessk" + ], + [ + 1106, + "Grozniy" + ], + [ + 1107, + "Anapa" + ], + [ + 1161, + "Svolver" + ], + [ + 2214, + "Are" + ], + [ + 2215, + "Areskutan" + ], + [ + 2824, + "Sirkka" + ], + [ + 3016, + "Skapa" + ], + [ + 3955, + "Cork" + ], + [ + 3958, + "Wexford" + ], + [ + 3963, + "Killarney" + ], + [ + 3964, + "Galway" + ], + [ + 3979, + "County Donegal" + ], + [ + 4048, + "Vestmannaeyjar" + ], + [ + 4063, + "Akureyri" + ], + [ + 4065, + "Grimsi" + ], + [ + 4090, + "Sejdisfjordur" + ], + [ + 4108, + "Isafjordur" + ], + [ + 4127, + "Akranes" + ], + [ + 6012, + "Kirkjubour" + ], + [ + 6013, + "Saksun" + ], + [ + 6014, + "Husar" + ], + [ + 6120, + "Odense" + ], + [ + 6170, + "Roskilde" + ], + [ + 6585, + "Clervaux" + ], + [ + 6586, + "Vianden" + ], + [ + 6587, + "Esch-sur-Sure" + ], + [ + 6597, + "Echternach" + ], + [ + 6598, + "Schengen" + ], + [ + 6989, + "Malbun" + ], + [ + 7222, + "Nantes" + ], + [ + 7727, + "Encamp" + ], + [ + 7728, + "La Massana" + ], + [ + 8529, + "Estoril" + ], + [ + 8533, + "Cascais" + ], + [ + 8547, + "Braga" + ], + [ + 9000, + "Yandex.wifi" + ], + [ + 9980, + "Yandex.DC.Ivanteevka" + ], + [ + 9981, + "Yandex.DC.DC3" + ], + [ + 9982, + "Yandex.DC.ETO" + ], + [ + 9983, + "Yandex.DC.Fian" + ], + [ + 9984, + "Yandex.DC.Ugreshka" + ], + [ + 9990, + "Yandex.KR" + ], + [ + 9991, + "Yandex.Samokatnaya" + ], + [ + 9992, + "Yandex.Benua" + ], + [ + 9993, + "Yandex.EKB" + ], + [ + 9994, + "Yandex.Berlingqym" + ], + [ + 9995, + "Yandex.Kiev" + ], + [ + 9996, + "Yandex.Odessa" + ], + [ + 9997, + "Yandex.Simferopl" + ], + [ + 9999, + "Yandex" + ], + [ + 10000, + "Earth" + ], + [ + 10001, + "Eurasia" + ], + [ + 10002, + "North America" + ], + [ + 10003, + "South America" + ], + [ + 10013, + "Jamaica" + ], + [ + 10015, + "Bolivia" + ], + [ + 10017, + "Cuba" + ], + [ + 10020, + "Morocco" + ], + [ + 10021, + "South Africa" + ], + [ + 10022, + "Seychelles" + ], + [ + 10023, + "Libya" + ], + [ + 10024, + "Tunisia" + ], + [ + 10029, + "Cocos Islands" + ], + [ + 10030, + "Fiji" + ], + [ + 10054, + "Albania" + ], + [ + 10057, + "Bosnia and Herzegovina" + ], + [ + 10063, + "Ireland" + ], + [ + 10064, + "Iceland" + ], + [ + 10067, + "Liechtenstein" + ], + [ + 10068, + "North Macedonia" + ], + [ + 10069, + "Malta" + ], + [ + 10070, + "Monaco" + ], + [ + 10074, + "Portugal" + ], + [ + 10077, + "Romania" + ], + [ + 10083, + "Croatia" + ], + [ + 10088, + "Andorra" + ], + [ + 10089, + "Gibraltar" + ], + [ + 10090, + "Afghanistan" + ], + [ + 10091, + "Bangladesh" + ], + [ + 10093, + "Vietnam" + ], + [ + 10095, + "Indonesia" + ], + [ + 10097, + "Malaysia" + ], + [ + 10098, + "Maldives" + ], + [ + 10099, + "Mongolia" + ], + [ + 10100, + "Myanmar" + ], + [ + 10101, + "Nepal" + ], + [ + 10102, + "Pakistan" + ], + [ + 10104, + "North Korea" + ], + [ + 10105, + "Singapore" + ], + [ + 10108, + "Philippines" + ], + [ + 10109, + "Sri Lanka" + ], + [ + 10114, + "Ottawa" + ], + [ + 10115, + "Toronto" + ], + [ + 10119, + "Honolulu" + ], + [ + 10122, + "Miami" + ], + [ + 10127, + "Salt Lake City" + ], + [ + 10129, + "Philadelphia" + ], + [ + 10130, + "Houston" + ], + [ + 10131, + "Chicago" + ], + [ + 10132, + "Kingston" + ], + [ + 10133, + "Buenos Aires" + ], + [ + 10134, + "La Paz" + ], + [ + 10135, + "Santa Cruz de la Sierra" + ], + [ + 10136, + "Brasilia" + ], + [ + 10137, + "Havana" + ], + [ + 10138, + "Casablanca" + ], + [ + 10139, + "Rabat" + ], + [ + 10140, + "Pretoria" + ], + [ + 10141, + "Victoria" + ], + [ + 10142, + "Tripoli" + ], + [ + 10143, + "Tunis" + ], + [ + 10144, + "Canberra" + ], + [ + 10145, + "Sydney" + ], + [ + 10146, + "Townsville" + ], + [ + 10147, + "Wellington" + ], + [ + 10148, + "West Island" + ], + [ + 10149, + "Nadi" + ], + [ + 10150, + "Suva" + ], + [ + 10174, + "Saint-Petersburg and Leningrad Oblast" + ], + [ + 10176, + "Nenets Autonomous Okrug" + ], + [ + 10231, + "Altai Republic" + ], + [ + 10233, + "Tyva Republic" + ], + [ + 10235, + "Taymyrsky Dolgano-Nenetsky District" + ], + [ + 10239, + "Evenkiysky region" + ], + [ + 10243, + "Jewish Autonomous Oblast" + ], + [ + 10251, + "Chukotka Autonomous Okrug" + ], + [ + 10253, + "Baku" + ], + [ + 10254, + "Gyandja" + ], + [ + 10255, + "Sumgait" + ], + [ + 10256, + "Nakhichevan" + ], + [ + 10257, + "Armavir" + ], + [ + 10258, + "Vanadzor" + ], + [ + 10259, + "Gyumri" + ], + [ + 10260, + "Djermuk" + ], + [ + 10261, + "Dilijan" + ], + [ + 10262, + "Yerevan" + ], + [ + 10263, + "Sevan" + ], + [ + 10265, + "Tsakhkadzor" + ], + [ + 10274, + "Grodno" + ], + [ + 10275, + "Polotsk" + ], + [ + 10276, + "Orsha" + ], + [ + 10277, + "Tbilisi" + ], + [ + 10278, + "Batumi" + ], + [ + 10279, + "Kutaisi" + ], + [ + 10280, + "Gagra" + ], + [ + 10281, + "Suhum" + ], + [ + 10282, + "Pitsunda" + ], + [ + 10283, + "Poti" + ], + [ + 10284, + "Gori" + ], + [ + 10285, + "Rustavi" + ], + [ + 10289, + "Aralsk" + ], + [ + 10291, + "Atyrau" + ], + [ + 10292, + "Baikonur" + ], + [ + 10293, + "Balkhash" + ], + [ + 10295, + "Kostanai" + ], + [ + 10298, + "Petropavlovsk" + ], + [ + 10300, + "Rudny" + ], + [ + 10301, + "Ruzaevka" + ], + [ + 10303, + "Taldikorgan" + ], + [ + 10305, + "Uralsk" + ], + [ + 10306, + "Ust-Kamenogorsk" + ], + [ + 10308, + "Zhezkazgan" + ], + [ + 10309, + "Bishkek" + ], + [ + 10310, + "Osh" + ], + [ + 10311, + "Balykchy" + ], + [ + 10312, + "Djalal-Abad" + ], + [ + 10313, + "Kishinev" + ], + [ + 10314, + "Beltsi" + ], + [ + 10315, + "Bender" + ], + [ + 10316, + "Ribnitsa" + ], + [ + 10317, + "Tiraspol" + ], + [ + 10318, + "Dushanbe" + ], + [ + 10319, + "Bohtar" + ], + [ + 10320, + "Pendjikent" + ], + [ + 10321, + "Nurek" + ], + [ + 10322, + "Khujand" + ], + [ + 10324, + "Ashgabat" + ], + [ + 10325, + "Turkmenabad" + ], + [ + 10326, + "Turkmenbashi" + ], + [ + 10327, + "Dashoguz" + ], + [ + 10328, + "Almalik" + ], + [ + 10329, + "Andijan" + ], + [ + 10330, + "Bukhara" + ], + [ + 10331, + "Karshi" + ], + [ + 10332, + "Kokand" + ], + [ + 10333, + "Oktyabrsky" + ], + [ + 10334, + "Samarkand" + ], + [ + 10335, + "Tashkent" + ], + [ + 10336, + "Fergana" + ], + [ + 10337, + "Nukus" + ], + [ + 10338, + "Termez" + ], + [ + 10339, + "Khiva" + ], + [ + 10343, + "Zhytomyr" + ], + [ + 10345, + "Ivano-Frankivsk" + ], + [ + 10347, + "Kryvyi Rih" + ], + [ + 10355, + "Rivne" + ], + [ + 10357, + "Ternopil" + ], + [ + 10358, + "Uzhhorod" + ], + [ + 10363, + "Cherkasy" + ], + [ + 10365, + "Chernivtsi" + ], + [ + 10366, + "Mariupol" + ], + [ + 10367, + "Melitopol" + ], + [ + 10368, + "Chornobyl" + ], + [ + 10369, + "Bila Tserkva" + ], + [ + 10370, + "Baden" + ], + [ + 10371, + "Vienna" + ], + [ + 10372, + "Salzburg" + ], + [ + 10373, + "Innsbruck" + ], + [ + 10374, + "Tirana" + ], + [ + 10375, + "Antwerp" + ], + [ + 10376, + "Brussels" + ], + [ + 10377, + "Liege" + ], + [ + 10378, + "Albena" + ], + [ + 10379, + "Sofia" + ], + [ + 10380, + "Burgas" + ], + [ + 10381, + "Varna" + ], + [ + 10382, + "Gabrovo" + ], + [ + 10383, + "Dimitrovgrad" + ], + [ + 10384, + "The Golden Sands" + ], + [ + 10385, + "Plovdiv" + ], + [ + 10386, + "Sopot" + ], + [ + 10387, + "Sarajevo" + ], + [ + 10388, + "Aberdeen" + ], + [ + 10389, + "Glasgow" + ], + [ + 10390, + "Dover" + ], + [ + 10391, + "Cambridge" + ], + [ + 10392, + "Liverpool" + ], + [ + 10393, + "London" + ], + [ + 10394, + "Manchester" + ], + [ + 10395, + "Oxford" + ], + [ + 10396, + "Plymouth" + ], + [ + 10397, + "Edinburgh" + ], + [ + 10398, + "Budapest" + ], + [ + 10399, + "Papa" + ], + [ + 10400, + "Baden-Baden" + ], + [ + 10402, + "Bonn" + ], + [ + 10403, + "Bremen" + ], + [ + 10405, + "Hanover" + ], + [ + 10407, + "Dresden" + ], + [ + 10408, + "Dusseldorf" + ], + [ + 10410, + "Leipzig" + ], + [ + 10412, + "Nuremberg" + ], + [ + 10417, + "Potsdam" + ], + [ + 10418, + "Athens" + ], + [ + 10419, + "Heraklion" + ], + [ + 10420, + "Kastoria" + ], + [ + 10421, + "Larnaca" + ], + [ + 10422, + "Lemnos" + ], + [ + 10423, + "Rhodes" + ], + [ + 10424, + "Thessaloniki" + ], + [ + 10425, + "Copenhagen" + ], + [ + 10426, + "Dublin" + ], + [ + 10427, + "Belfast" + ], + [ + 10428, + "Reykyavik" + ], + [ + 10429, + "Barcelona" + ], + [ + 10430, + "Valencia" + ], + [ + 10431, + "Guadalajara" + ], + [ + 10432, + "Ibiza" + ], + [ + 10433, + "Cartagena" + ], + [ + 10434, + "Costa Brava" + ], + [ + 10435, + "Madrid" + ], + [ + 10436, + "Majorca" + ], + [ + 10437, + "Malaga" + ], + [ + 10438, + "Marbella" + ], + [ + 10439, + "Minorca" + ], + [ + 10440, + "Seville" + ], + [ + 10441, + "Tenerife" + ], + [ + 10442, + "Estepona" + ], + [ + 10443, + "Santa Cruz de Tenerife" + ], + [ + 10444, + "Bologna" + ], + [ + 10445, + "Rome" + ], + [ + 10446, + "Naples" + ], + [ + 10447, + "Genoa" + ], + [ + 10448, + "Milan" + ], + [ + 10449, + "Turin" + ], + [ + 10450, + "Brindisi" + ], + [ + 10451, + "Venice" + ], + [ + 10452, + "Verona" + ], + [ + 10453, + "Cagliari" + ], + [ + 10454, + "Capri" + ], + [ + 10455, + "Livigno" + ], + [ + 10456, + "Palermo" + ], + [ + 10457, + "Palermo, Punta Raisi Airport" + ], + [ + 10458, + "Pisa" + ], + [ + 10459, + "Rimini" + ], + [ + 10460, + "San Remo" + ], + [ + 10461, + "Florence" + ], + [ + 10462, + "Vaduz" + ], + [ + 10463, + "Skopje" + ], + [ + 10464, + "Valletta" + ], + [ + 10465, + "Monaco" + ], + [ + 10466, + "Amsterdam" + ], + [ + 10467, + "Oslo" + ], + [ + 10468, + "Ny-Alesund" + ], + [ + 10469, + "Hopen" + ], + [ + 10470, + "Jan Mayen" + ], + [ + 10471, + "Bialystok" + ], + [ + 10472, + "Warsaw" + ], + [ + 10473, + "Katowice" + ], + [ + 10474, + "Krakow" + ], + [ + 10475, + "Lodz" + ], + [ + 10476, + "P\u0142ock" + ], + [ + 10477, + "Poznan" + ], + [ + 10478, + "Lisbon" + ], + [ + 10479, + "Porto" + ], + [ + 10480, + "Santa Maria" + ], + [ + 10481, + "Horta" + ], + [ + 10487, + "Bucharest" + ], + [ + 10488, + "Galati" + ], + [ + 10489, + "Bratislava" + ], + [ + 10490, + "Kosice" + ], + [ + 10491, + "Hopok" + ], + [ + 10492, + "Ljubljana" + ], + [ + 10493, + "Helsinki" + ], + [ + 10494, + "Turku" + ], + [ + 10495, + "Ajaccio" + ], + [ + 10496, + "Bordeaux" + ], + [ + 10497, + "Brest" + ], + [ + 10498, + "Dijon" + ], + [ + 10499, + "Lyon" + ], + [ + 10500, + "Nice" + ], + [ + 10501, + "Marseilles" + ], + [ + 10502, + "Paris" + ], + [ + 10503, + "Saint-Tropez" + ], + [ + 10504, + "Toulouse" + ], + [ + 10505, + "Chamonix" + ], + [ + 10506, + "Dubrovnik" + ], + [ + 10507, + "Zagreb" + ], + [ + 10508, + "Split" + ], + [ + 10509, + "Brno" + ], + [ + 10510, + "Karlovy Vary" + ], + [ + 10511, + "Prague" + ], + [ + 10512, + "Baden" + ], + [ + 10513, + "Bern" + ], + [ + 10514, + "Geneva" + ], + [ + 10515, + "Zurich" + ], + [ + 10516, + "Davos" + ], + [ + 10517, + "St. Moritz" + ], + [ + 10518, + "Gothenburg" + ], + [ + 10519, + "Stockholm" + ], + [ + 10520, + "Lausanne" + ], + [ + 10521, + "Malmo" + ], + [ + 10522, + "Belgrade" + ], + [ + 10523, + "Pe\u0107" + ], + [ + 10524, + "Andorra la Vella" + ], + [ + 10525, + "Gibraltar" + ], + [ + 10526, + "Kabul" + ], + [ + 10527, + "Jessore" + ], + [ + 10528, + "Rangpur" + ], + [ + 10529, + "Sylhet" + ], + [ + 10530, + "Dhaka" + ], + [ + 10531, + "Chittagong" + ], + [ + 10532, + "Bahrain" + ], + [ + 10535, + "Jordan" + ], + [ + 10536, + "Iran" + ], + [ + 10537, + "Kuwait" + ], + [ + 10538, + "Lebanon" + ], + [ + 10540, + "Saudi Arabia" + ], + [ + 10542, + "Syria" + ], + [ + 10543, + "Da Nang" + ], + [ + 10544, + "Donghoi" + ], + [ + 10546, + "L\u1ea1ng S\u01a1n" + ], + [ + 10547, + "Nha Trang" + ], + [ + 10550, + "Thanh Hoa" + ], + [ + 10551, + "Th\u1ed5 Chu" + ], + [ + 10552, + "Hanoi" + ], + [ + 10553, + "Ho Chi Minh" + ], + [ + 10554, + "Allahabad" + ], + [ + 10555, + "Ahmedabad" + ], + [ + 10556, + "Balasore" + ], + [ + 10557, + "Bikaner" + ], + [ + 10558, + "Mumbai" + ], + [ + 10559, + "Gaya" + ], + [ + 10560, + "Gorakhpur" + ], + [ + 10561, + "Guna" + ], + [ + 10562, + "Delhi" + ], + [ + 10563, + "Dehradun" + ], + [ + 10564, + "Jaisalmer" + ], + [ + 10565, + "Kota" + ], + [ + 10566, + "Lucknow" + ], + [ + 10568, + "Port Blair" + ], + [ + 10569, + "Rajkot" + ], + [ + 10570, + "Ranchi" + ], + [ + 10571, + "Surat" + ], + [ + 10572, + "Bali" + ], + [ + 10573, + "Bau-Bau" + ], + [ + 10574, + "Jakarta" + ], + [ + 10575, + "Ketapang" + ], + [ + 10576, + "Merauke" + ], + [ + 10577, + "Medan" + ], + [ + 10578, + "Padang" + ], + [ + 10579, + "Sabang" + ], + [ + 10580, + "Sangkapura" + ], + [ + 10581, + "Semarang" + ], + [ + 10582, + "Tarakan" + ], + [ + 10583, + "Tolitoli" + ], + [ + 10584, + "Hong Kong" + ], + [ + 10585, + "Dongsheng" + ], + [ + 10586, + "Enshi" + ], + [ + 10587, + "Erenhot" + ], + [ + 10588, + "Lhasa" + ], + [ + 10589, + "Macau" + ], + [ + 10590, + "Beijing" + ], + [ + 10591, + "Xi'an" + ], + [ + 10592, + "Taipei" + ], + [ + 10593, + "Tainan" + ], + [ + 10594, + "Urumqi" + ], + [ + 10595, + "Fengning" + ], + [ + 10596, + "Harbin" + ], + [ + 10598, + "Changzhou" + ], + [ + 10599, + "Shanghai" + ], + [ + 10600, + "Yunan" + ], + [ + 10601, + "Yanqi" + ], + [ + 10602, + "Malacca" + ], + [ + 10603, + "Subang" + ], + [ + 10604, + "Kuala Lumpur" + ], + [ + 10605, + "Male" + ], + [ + 10606, + "Ulan Bator" + ], + [ + 10607, + "\u00d6lgii" + ], + [ + 10608, + "Hovd" + ], + [ + 10609, + "Choibalsan" + ], + [ + 10610, + "Pathein" + ], + [ + 10611, + "Thandwe" + ], + [ + 10612, + "Yangon" + ], + [ + 10613, + "Kathmandu" + ], + [ + 10614, + "Islamabad" + ], + [ + 10615, + "Karachi" + ], + [ + 10616, + "Lahore" + ], + [ + 10617, + "Pyongyang" + ], + [ + 10619, + "Singapore" + ], + [ + 10620, + "Bangkok" + ], + [ + 10621, + "Prachuap Khiri Khan" + ], + [ + 10622, + "Phuket" + ], + [ + 10623, + "Surin" + ], + [ + 10624, + "Maprao Island" + ], + [ + 10625, + "Vigan" + ], + [ + 10626, + "Davao" + ], + [ + 10627, + "Infanta" + ], + [ + 10628, + "Coron" + ], + [ + 10629, + "Manila" + ], + [ + 10630, + "Puerto Princesa" + ], + [ + 10631, + "San Jose" + ], + [ + 10632, + "Galle" + ], + [ + 10633, + "Colombo" + ], + [ + 10634, + "Busan" + ], + [ + 10635, + "Seoul" + ], + [ + 10636, + "Tokyo" + ], + [ + 10637, + "Nagasaki" + ], + [ + 10638, + "Wakkanai" + ], + [ + 10639, + "Kushiro" + ], + [ + 10640, + "Naha" + ], + [ + 10641, + "Osaka" + ], + [ + 10642, + "Sapporo" + ], + [ + 10643, + "Urakawa" + ], + [ + 10644, + "Fukuoka" + ], + [ + 10645, + "Belgorod Oblast" + ], + [ + 10646, + "Gubkin" + ], + [ + 10647, + "Noviy Oskol" + ], + [ + 10648, + "Prohorovka" + ], + [ + 10649, + "Stariy Oskol" + ], + [ + 10650, + "Bryansk Oblast" + ], + [ + 10651, + "Dyatkovo" + ], + [ + 10652, + "Zhukovka" + ], + [ + 10653, + "Klintsy" + ], + [ + 10654, + "Novozibkov" + ], + [ + 10655, + "Karachev" + ], + [ + 10656, + "Aleksandrov" + ], + [ + 10657, + "Balakirevo" + ], + [ + 10658, + "Vladimir Oblast" + ], + [ + 10659, + "Vyazniki" + ], + [ + 10660, + "Gorohovec" + ], + [ + 10661, + "Gus-Chrustalniy" + ], + [ + 10662, + "Kameshkovo" + ], + [ + 10663, + "Kirzach" + ], + [ + 10664, + "Kovrov" + ], + [ + 10665, + "Kolchugino" + ], + [ + 10666, + "Krasnaya Gorbatka" + ], + [ + 10667, + "Melenki" + ], + [ + 10668, + "Murom" + ], + [ + 10669, + "Petushki" + ], + [ + 10670, + "Sobinka" + ], + [ + 10671, + "Suzdal" + ], + [ + 10672, + "Voronezh Oblast" + ], + [ + 10673, + "Bobrov" + ], + [ + 10674, + "Boguchar" + ], + [ + 10675, + "Borisoglebsk" + ], + [ + 10676, + "Buturlinovka" + ], + [ + 10677, + "Kalach" + ], + [ + 10678, + "Lisky" + ], + [ + 10679, + "Ostrogozhsk" + ], + [ + 10680, + "Pavlovsk" + ], + [ + 10681, + "Rossosh" + ], + [ + 10682, + "Semiluky" + ], + [ + 10683, + "Ertil" + ], + [ + 10684, + "Talovaya" + ], + [ + 10685, + "Kantemirovka" + ], + [ + 10686, + "Anna" + ], + [ + 10687, + "Ivanovo Oblast" + ], + [ + 10688, + "Vichuga" + ], + [ + 10689, + "Kineshma" + ], + [ + 10690, + "Kohma" + ], + [ + 10691, + "Shuya" + ], + [ + 10692, + "Yurievets" + ], + [ + 10693, + "Kaluga Oblast" + ], + [ + 10695, + "Kozelsk" + ], + [ + 10696, + "Kondrovo" + ], + [ + 10697, + "Maloyaroslavets" + ], + [ + 10698, + "Borovsk" + ], + [ + 10699, + "Kostroma Oblast" + ], + [ + 10700, + "Buy" + ], + [ + 10701, + "Volgorechensk" + ], + [ + 10702, + "Nerekhta" + ], + [ + 10703, + "Galich" + ], + [ + 10704, + "Sharya" + ], + [ + 10705, + "Kursk Oblast" + ], + [ + 10706, + "Dmitriyev" + ], + [ + 10707, + "Rilsk" + ], + [ + 10708, + "Sudzha" + ], + [ + 10709, + "Oboyan" + ], + [ + 10710, + "Zheleznogorsk" + ], + [ + 10711, + "Phatezh" + ], + [ + 10712, + "Lipetsk Oblast" + ], + [ + 10713, + "Yelets" + ], + [ + 10714, + "Chapligin" + ], + [ + 10715, + "Aprelevka" + ], + [ + 10716, + "Balashiha" + ], + [ + 10717, + "Bronnizi" + ], + [ + 10718, + "Bykovo" + ], + [ + 10719, + "Vidnoe" + ], + [ + 10720, + "Vnukovo" + ], + [ + 10721, + "Volokolamsk" + ], + [ + 10722, + "Voskresensk" + ], + [ + 10723, + "Dmitrov" + ], + [ + 10725, + "Domodedovo" + ], + [ + 10727, + "Egorievsk" + ], + [ + 10728, + "Zaraysk" + ], + [ + 10729, + "Zvenigorod" + ], + [ + 10731, + "Istra" + ], + [ + 10732, + "Kashira" + ], + [ + 10733, + "Klin" + ], + [ + 10734, + "Kolomna" + ], + [ + 10735, + "Krasnogorsk" + ], + [ + 10736, + "Lotoshino" + ], + [ + 10737, + "Luhovicy" + ], + [ + 10738, + "Lubercy" + ], + [ + 10739, + "Mozhaysk" + ], + [ + 10740, + "Mytischi" + ], + [ + 10741, + "Naro-Fominsk" + ], + [ + 10742, + "Noginsk" + ], + [ + 10743, + "Odincovo" + ], + [ + 10744, + "Ozery" + ], + [ + 10745, + "Orehovo-Zuevo" + ], + [ + 10746, + "Pavlovskiy Posad" + ], + [ + 10747, + "Podolsk" + ], + [ + 10748, + "Pushkino" + ], + [ + 10750, + "Ramenskoe" + ], + [ + 10751, + "Ruza" + ], + [ + 10752, + "Sergiev Posad" + ], + [ + 10753, + "Serebryanie Prudy" + ], + [ + 10754, + "Serpuhov" + ], + [ + 10755, + "Solnechnogorsk" + ], + [ + 10756, + "Stupino" + ], + [ + 10757, + "Taldom" + ], + [ + 10758, + "Himki" + ], + [ + 10760, + "Cherusty" + ], + [ + 10761, + "Chehov" + ], + [ + 10762, + "Shatura" + ], + [ + 10763, + "Shahovskaya" + ], + [ + 10764, + "Sheremetyevo International Airport" + ], + [ + 10765, + "Shelkovo" + ], + [ + 10768, + "Bolxov" + ], + [ + 10769, + "Livny" + ], + [ + 10770, + "Mtsensk" + ], + [ + 10771, + "Novosil" + ], + [ + 10772, + "Oryol Oblast" + ], + [ + 10773, + "Kasimov" + ], + [ + 10774, + "Rybnoe" + ], + [ + 10775, + "Ryazgsk" + ], + [ + 10776, + "Ryazan Oblast" + ], + [ + 10777, + "Sasovo" + ], + [ + 10778, + "Skopin" + ], + [ + 10779, + "Spas-Klepiki" + ], + [ + 10780, + "Shatsk" + ], + [ + 10781, + "Velizg" + ], + [ + 10782, + "Vyazma" + ], + [ + 10783, + "Gagarin" + ], + [ + 10784, + "Demidov" + ], + [ + 10785, + "Desnogorsk" + ], + [ + 10786, + "Dorogobuzh" + ], + [ + 10787, + "Dukhovshchina" + ], + [ + 10788, + "Elnya" + ], + [ + 10789, + "Krasny" + ], + [ + 10790, + "Monastyrschina" + ], + [ + 10791, + "Pochinok" + ], + [ + 10792, + "Roslavl" + ], + [ + 10793, + "Rudnya" + ], + [ + 10794, + "Safonovo" + ], + [ + 10795, + "Smolensk Oblast" + ], + [ + 10796, + "Sychevka" + ], + [ + 10797, + "Urga" + ], + [ + 10798, + "Hislavichi" + ], + [ + 10799, + "Holm-Zgirkovskiy" + ], + [ + 10800, + "Shumyachi" + ], + [ + 10801, + "Yartsevo" + ], + [ + 10802, + "Tambov Oblast" + ], + [ + 10803, + "Michurinsk" + ], + [ + 10804, + "Bezheck" + ], + [ + 10805, + "Bologoe" + ], + [ + 10806, + "Vesegonsk" + ], + [ + 10807, + "Vishniy Volochek" + ], + [ + 10808, + "Dvina" + ], + [ + 10809, + "Kalyazin" + ], + [ + 10810, + "Kashin" + ], + [ + 10811, + "Kimry" + ], + [ + 10812, + "Konakovo" + ], + [ + 10813, + "Krasniy Holm" + ], + [ + 10814, + "Lixoslavl" + ], + [ + 10815, + "Maksatixa" + ], + [ + 10816, + "Nelidovo" + ], + [ + 10817, + "Olenino" + ], + [ + 10818, + "Ostashkov" + ], + [ + 10819, + "Tver Oblast" + ], + [ + 10820, + "Rzhev" + ], + [ + 10821, + "Staritsa" + ], + [ + 10822, + "Torzgok" + ], + [ + 10823, + "Toropets" + ], + [ + 10824, + "Udomlya" + ], + [ + 10825, + "Aleksin" + ], + [ + 10826, + "Venev" + ], + [ + 10827, + "Donskoy" + ], + [ + 10828, + "Efremov" + ], + [ + 10829, + "Kimovsk" + ], + [ + 10830, + "Novomoskovsk" + ], + [ + 10831, + "Suvorov" + ], + [ + 10832, + "Tula Oblast" + ], + [ + 10833, + "Uzlovaya" + ], + [ + 10834, + "Tshekino" + ], + [ + 10835, + "Danilov" + ], + [ + 10836, + "Myshkin" + ], + [ + 10837, + "Pereslavl-Zalesskiy" + ], + [ + 10838, + "Rostov" + ], + [ + 10839, + "Rybinsk" + ], + [ + 10840, + "Uglich" + ], + [ + 10841, + "Yaroslavl Oblast" + ], + [ + 10842, + "Arkhangel'skaya Oblast'" + ], + [ + 10843, + "Velsk" + ], + [ + 10844, + "Kargopol" + ], + [ + 10845, + "Koryagma" + ], + [ + 10846, + "Kotlas" + ], + [ + 10847, + "Onega" + ], + [ + 10848, + "Pinega" + ], + [ + 10849, + "Severodvinsk" + ], + [ + 10850, + "Kholmogory" + ], + [ + 10851, + "Shenkursk" + ], + [ + 10853, + "Vologda Oblast" + ], + [ + 10854, + "Velikiy Ustug" + ], + [ + 10855, + "Totma" + ], + [ + 10856, + "Ustugna" + ], + [ + 10857, + "Kaliningrad Oblast" + ], + [ + 10858, + "Baltiysk" + ], + [ + 10859, + "Svetlogorsk" + ], + [ + 10860, + "Sovetsk" + ], + [ + 10861, + "Boksitogorsk" + ], + [ + 10862, + "Verevo" + ], + [ + 10863, + "Volosovo" + ], + [ + 10864, + "Volhov" + ], + [ + 10865, + "Vsevolgsk" + ], + [ + 10867, + "Gatchina" + ], + [ + 10868, + "Ivangorod" + ], + [ + 10869, + "Kamennogorsk" + ], + [ + 10870, + "Kingisepp" + ], + [ + 10871, + "Kirishi" + ], + [ + 10872, + "Kirovsk" + ], + [ + 10873, + "Kuznechnoe" + ], + [ + 10874, + "Lodeynoe Pole" + ], + [ + 10875, + "Lomonosov" + ], + [ + 10876, + "Luga" + ], + [ + 10877, + "Nikolskoe" + ], + [ + 10878, + "Otradnoe" + ], + [ + 10879, + "Pikalevo" + ], + [ + 10881, + "Podporogie" + ], + [ + 10882, + "Primorsk" + ], + [ + 10883, + "Priozersk" + ], + [ + 10884, + "Pushkin" + ], + [ + 10885, + "Roshino" + ], + [ + 10886, + "Svetogorsk" + ], + [ + 10887, + "Sertolovo" + ], + [ + 10888, + "Slantsy" + ], + [ + 10889, + "Sovetskiy" + ], + [ + 10891, + "Sosnoviy Bor" + ], + [ + 10892, + "Tikhvin" + ], + [ + 10893, + "Tosno" + ], + [ + 10894, + "Apatity" + ], + [ + 10895, + "Kandalaksha" + ], + [ + 10896, + "Monchegorsk" + ], + [ + 10897, + "Murmansk Oblast" + ], + [ + 10898, + "Severomorsk" + ], + [ + 10899, + "Snegnogorsk" + ], + [ + 10900, + "Pechenga" + ], + [ + 10901, + "Teriberka" + ], + [ + 10902, + "Naryan-Mar" + ], + [ + 10903, + "Amderma" + ], + [ + 10904, + "Novgorod Oblast" + ], + [ + 10905, + "Batetskiy" + ], + [ + 10906, + "Borovichy" + ], + [ + 10907, + "Valday" + ], + [ + 10908, + "Volot" + ], + [ + 10909, + "Malaya Vishera" + ], + [ + 10910, + "Marevo" + ], + [ + 10911, + "Moshenskoe" + ], + [ + 10912, + "Okulovka" + ], + [ + 10913, + "Demyansk" + ], + [ + 10914, + "Krestsi" + ], + [ + 10915, + "Lyubitino" + ], + [ + 10916, + "Parfino" + ], + [ + 10917, + "Hvoinaya" + ], + [ + 10918, + "Shimsk" + ], + [ + 10919, + "Pankovka" + ], + [ + 10920, + "Pestovo" + ], + [ + 10921, + "Poddorye" + ], + [ + 10922, + "Soltsy" + ], + [ + 10923, + "Staraya Russa" + ], + [ + 10924, + "Holm" + ], + [ + 10925, + "Chudovo" + ], + [ + 10926, + "Pskov Oblast" + ], + [ + 10927, + "Bezhanitsy" + ], + [ + 10928, + "Velikie Luky" + ], + [ + 10929, + "Dno" + ], + [ + 10930, + "Novosokolniky" + ], + [ + 10931, + "Pechory" + ], + [ + 10932, + "Sebezh" + ], + [ + 10933, + "Republic of Karelia" + ], + [ + 10934, + "Kondopoga" + ], + [ + 10935, + "Kostomucsha" + ], + [ + 10936, + "Segezha" + ], + [ + 10937, + "Sortavala" + ], + [ + 10938, + "Belomorsk" + ], + [ + 10939, + "Komi Republic" + ], + [ + 10940, + "Vorkuta" + ], + [ + 10941, + "Inta" + ], + [ + 10942, + "Pechora" + ], + [ + 10943, + "Sosnogorsk" + ], + [ + 10944, + "Usinsk" + ], + [ + 10945, + "Uhta" + ], + [ + 10946, + "Astrakhan Oblast" + ], + [ + 10947, + "Znamensk" + ], + [ + 10948, + "Alekseyevskaya" + ], + [ + 10949, + "Bykovo" + ], + [ + 10950, + "Volgograd Oblast" + ], + [ + 10951, + "Volzhskiy" + ], + [ + 10952, + "Gorodische" + ], + [ + 10953, + "Danilovka" + ], + [ + 10954, + "Dubovka" + ], + [ + 10955, + "Yelan'" + ], + [ + 10956, + "Zhirnovsk" + ], + [ + 10957, + "Ilovlya" + ], + [ + 10958, + "Kalach-na-Donu" + ], + [ + 10959, + "Kamishin" + ], + [ + 10960, + "Kletskaya" + ], + [ + 10961, + "Kotel'nikovo" + ], + [ + 10962, + "Kotovo" + ], + [ + 10963, + "Kumylzhenskaya" + ], + [ + 10964, + "Leninsk" + ], + [ + 10965, + "Mihaylovka" + ], + [ + 10966, + "Nekhaevskaya" + ], + [ + 10967, + "Nikolayevsk" + ], + [ + 10968, + "Novoanninsky" + ], + [ + 10969, + "Novonikolaevsky" + ], + [ + 10970, + "Oktyabr'sky" + ], + [ + 10971, + "Ol'hovka" + ], + [ + 10972, + "Pallasovka" + ], + [ + 10973, + "Petrov Val" + ], + [ + 10974, + "Preobrazhenskaya" + ], + [ + 10975, + "Rudnya" + ], + [ + 10976, + "Svetlyy Yar" + ], + [ + 10977, + "Serafimovich" + ], + [ + 10978, + "Srednyaya Akhtuba" + ], + [ + 10979, + "Staraya Poltavka" + ], + [ + 10980, + "Surovikino" + ], + [ + 10981, + "Uryupinsk" + ], + [ + 10982, + "Phrolovo" + ], + [ + 10983, + "Chernyshkovsky" + ], + [ + 10984, + "El'ton" + ], + [ + 10986, + "Apsheronsk" + ], + [ + 10987, + "Armavir" + ], + [ + 10988, + "Belorechensk" + ] + ], + "description": "Parameter defines country or region ID to limit the search results to. Head to the Yandex locations for a full list of supported Yandex locations. If parameter is not set - the matching location of selected `yandex_domain` is used, e.g. `84` for `yandex.com`.", + "group": "geographic_location" + }, + "rstr": { + "type": "checkbox", + "description": "Parameter enables additional filtering to select search results that include specified location (`lr`) in the text snippets/titles.", + "group": "geographic_location" + }, + "within": { + "type": "select", + "options": [ + [ + "0", + "All time" + ], + [ + "9", + "Recent" + ], + [ + "7", + "Today" + ], + [ + "77", + "Last day" + ], + [ + "1", + "Last 2 weeks" + ], + [ + "2", + "Last month" + ] + ], + "description": "Parameter is used to limit the search results to specific time period. It defaults to `all time`", + "group": "advanced_yandex_parameters" + }, + "p": { + "type": "number", + "description": "Parameter defines page number. Pagination starts from 0.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yandex` to use the Yandex API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yandex results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yandex_images.json b/engines/yandex_images.json new file mode 100644 index 0000000..479ca0f --- /dev/null +++ b/engines/yandex_images.json @@ -0,0 +1,161 @@ +{ + "engine": "yandex_images", + "params": { + "text": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Yandex Images search. It can be optional if the url parameter is being used.", + "group": "search_query" + }, + "yandex_domain": { + "type": "select", + "options": [ + "yandex.com", + "yandex.ru", + "ya.ru", + "yandex.by", + "yandex.kz", + "yandex.uz", + "yandex.com.tr", + "yandex.az", + "yandex.com.ge", + "yandex.com.am", + "yandex.co.il", + "yandex.md", + "yandex.tm", + "yandex.tj", + "yandex.eu" + ], + "description": "Parameter defines the Yandex Images domain to use. It defaults to `yandex.com`. Head to the Yandex domains for a full list of supported Yandex domains.", + "group": "localization" + }, + "width": { + "type": "number", + "description": "Parameter defines the width of an image. It can only be used in combination with height parameter.", + "group": "image_size" + }, + "height": { + "type": "number", + "description": "Parameter defines the height of an image. It can only be used in combination with width parameter.", + "group": "image_size" + }, + "file_type": { + "type": "select", + "options": [ + "jpg", + "png", + "gifan" + ], + "description": "Parameter is used for filtering images by file type. It can be set to: `jpg` - JPG file extension `png` - PNG file extension `gifan` - GIF file extension", + "group": "advanced_yandex_images_parameters" + }, + "color": { + "type": "select", + "options": [ + "color", + "gray", + "red", + "orange", + "yellow", + "cyan", + "green", + "blue", + "violet", + "white", + "black" + ], + "description": "Parameter is used for filtering images by color. It can be set to: `color` - Color images only `gray` - Black and white `red` - Red color `orange` - Orange color `yellow` - Yellow color `cyan` - Cyan color `green` - Green color `blue` - Blue color `violet` - Violet color `white` - White color `black` - Black color", + "group": "advanced_yandex_images_parameters" + }, + "orientation": { + "type": "select", + "options": [ + "horizontal", + "vertical", + "square" + ], + "description": "Parameter is used for filtering images by orientation. It can be set to: `horizontal` - Horizontal `vertical` - Vertical `square` - Square", + "group": "advanced_yandex_images_parameters" + }, + "image_type": { + "type": "select", + "options": [ + "photo", + "clipart", + "lineart", + "face", + "demotivator" + ], + "description": "Parameter is used for filtering images by image type. It can be set to: `photo` - Photograph `clipart` - White background `lineart` - Drawings and sketches `demotivator` - Demotivator `face` - People", + "group": "advanced_yandex_images_parameters" + }, + "site": { + "description": "Parameter is used for filtering images by their source. Example value: `www.shutterstock.com`.", + "group": "advanced_yandex_images_parameters" + }, + "recent": { + "type": "checkbox", + "description": "Parameter is used for showing images that appeared in the last 7 days.", + "group": "advanced_yandex_images_parameters" + }, + "url": { + "description": "Parameter defines the URL for an image to perform the reverse image search.", + "group": "yandex_reverse_image_parameters" + }, + "crop": { + "description": "Parameter is used to crop the image and perform the reverse search on the cropped part of the image. E.g. `0.04;0.46;0.27;0.84`. These coordinates are formatted in the next order: `left edge;top edge;right edge;bottom edge`. The minimum and maximum for each coordinate are `0` and `1`, respectively.", + "group": "yandex_reverse_image_parameters" + }, + "crop_id": { + "type": "number", + "description": "Parameter is used to filter results by a specific section of an image. Parameter will only work with images uploaded by Yandex (e.g. `https://avatars.mds.yandex.net/rest-of-the-image-url`). crop and crop_id parameters should not be used together.", + "group": "yandex_reverse_image_parameters" + }, + "tab": { + "type": "select", + "options": [ + "about", + "similar" + ], + "description": "Parameter defines the specific tab for the reverse image search. Yandex defaults to the 'About the image' tab. It can be set to: `about` - 'About the image' tab results `similar` - 'Similar images' tab results.", + "group": "yandex_reverse_image_parameters" + }, + "p": { + "type": "number", + "description": "Parameter defines the page number. Pagination starts from `0`, and it can return up to 30 results.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yandex_images` to use the Yandex Images API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yandex Images results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yandex_videos.json b/engines/yandex_videos.json new file mode 100644 index 0000000..94e219f --- /dev/null +++ b/engines/yandex_videos.json @@ -0,0 +1,126 @@ +{ + "engine": "yandex_videos", + "params": { + "text": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular Yandex Videos search.", + "group": "search_query" + }, + "yandex_domain": { + "type": "select", + "options": [ + "yandex.com", + "yandex.ru", + "ya.ru", + "yandex.by", + "yandex.kz", + "yandex.uz", + "yandex.com.tr", + "yandex.az", + "yandex.com.ge", + "yandex.com.am", + "yandex.co.il", + "yandex.md", + "yandex.tm", + "yandex.tj", + "yandex.eu" + ], + "description": "Parameter defines the Yandex Videos domain to use. It defaults to `yandex.com`. Head to the Yandex domains for a full list of supported Yandex domains.", + "group": "localization" + }, + "duration": { + "type": "select", + "options": [ + "short", + "medium", + "long" + ], + "description": "Parameter is used for filtering videos by duration. It can be set to: `short` - Less than 10 minutes `medium` - 10-65 minutes `long` - More than 65 minutes", + "group": "advanced_yandex_videos_parameters" + }, + "hd": { + "type": "checkbox", + "description": "Parameter is used for filtering videos by quality.", + "group": "advanced_yandex_videos_parameters" + }, + "within": { + "type": "select", + "options": [ + [ + "0", + "All time" + ], + [ + "9", + "Recent" + ], + [ + "7", + "Today" + ], + [ + "77", + "Last day" + ], + [ + "1", + "Last 2 weeks" + ], + [ + "2", + "Last month" + ] + ], + "description": "Parameter is used to limit the search results to specific time period. It defaults to `all time`", + "group": "advanced_yandex_videos_parameters" + }, + "p": { + "type": "number", + "description": "Parameter defines the page number. Pagination starts from `0`, and it can return up to 30 results.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yandex_videos` to use the Yandex Videos API engine.", + "group": "serpapi_parameters" + }, + "device": { + "type": "device", + "options": [ + "desktop", + "tablet", + "mobile" + ], + "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yandex Videos results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yelp.json b/engines/yelp.json new file mode 100644 index 0000000..72d0f29 --- /dev/null +++ b/engines/yelp.json @@ -0,0 +1,122 @@ +{ + "engine": "yelp", + "params": { + "find_desc": { + "description": "Parameter defines the query you want to search. You can use anything that you would use in a regular Yelp search.", + "group": "search_query" + }, + "find_loc": { + "required": true, + "description": "Parameter defines from where you want the search to originate. You can use any location you would use in a regular Yelp search. Following location formats are acceptable: - 706 Mission St, San Francisco, CA - San Francisco, CA - San Francisco, CA 94103 - 94103", + "group": "geographic_location" + }, + "l": { + "description": "Parameter defines the distance (map radius) or neighborhoods you want to search in. You can use our JSON endpoint to fetch values for either of them. Values for distance are accessible through `filters.distance` (e.g. value for 'Bird's-eye View' is `g:-97.86003112792969,30.21635515266855,-97.65541076660156,30.394199462058317`). You can also specify neighborhoods to search in. Values for neighborhoods are accessible through `filters.neighborhoods`. The value for a single neighborhood is formed in the next order: `filters.neighborhoods.value` + `filters.neighborhoods.list[0].value` (e.g. `p:TX:Austin::Downtown`). You can also set value for multiple neighborhoods: `filters.neighborhoods.value` + `[filters.neighborhoods.list[0].value,filters.neighborhoods.list[1].value]` (e.g. `p:TX:Austin::[Downtown,East_Austin]`). Distance and neighborhoods values can't be used together.", + "group": "geographic_location" + }, + "yelp_domain": { + "type": "select", + "options": [ + "ms.yelp.my", + "www.yelp.cz", + "www.yelp.dk", + "www.yelp.de", + "www.yelp.at", + "de.yelp.ch", + "www.yelp.com.au", + "en.yelp.be", + "www.yelp.ca", + "en.yelp.com.hk", + "en.yelp.my", + "www.yelp.co.nz", + "en.yelp.com.ph", + "www.yelp.ie", + "www.yelp.com.sg", + "en.yelp.ch", + "www.yelp.co.uk", + "www.yelp.com", + "www.yelp.com.ar", + "www.yelp.cl", + "www.yelp.es", + "www.yelp.com.mx", + "fil.yelp.com.ph", + "fr.yelp.be", + "fr.yelp.ca", + "www.yelp.fr", + "fr.yelp.ch", + "www.yelp.it", + "it.yelp.ch", + "nl.yelp.be", + "www.yelp.nl", + "www.yelp.no", + "www.yelp.pl", + "www.yelp.com.br", + "www.yelp.pt", + "fi.yelp.fi", + "sv.yelp.fi", + "www.yelp.com.tr", + "www.yelp.co.jp", + "zh.yelp.com.hk", + "www.yelp.com.tw" + ], + "description": "Parameter defines the Yelp domain to use. It defaults to `yelp.com`. Head to the Yelp domains for a full list of supported Yelp domains.", + "group": "localization" + }, + "cflt": { + "description": "Parameter is used to define a category. It can be used alongside find_desc parameter to refine the search.", + "group": "advanced_yelp_parameters" + }, + "sortby": { + "type": "select", + "options": [ + "recommended", + "rating", + "review_count" + ], + "description": "Parameter is used for sorting results. Available options: `recommended` - Recommended (default) `rating` - Highest Rated `review_count` - Most Reviewed", + "group": "advanced_yelp_parameters" + }, + "attrs": { + "description": "Parameter is used for refining results. You can add more filters like 'price', 'features', etc. to your search. You can use our JSON endpoint to fetch values. Values for filters are accessible through `filters` (e.g. value for filtering results by 'No Smoking' is `Smoking.no`). You can also use multiple values: `filters.features[0].value,filters.features[1].value` (e.g. `GoodForKids,DogsAllowed`)", + "group": "advanced_yelp_parameters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.).", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yelp` to use the Yelp API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yelp results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yelp_place.json b/engines/yelp_place.json new file mode 100644 index 0000000..4c2852c --- /dev/null +++ b/engines/yelp_place.json @@ -0,0 +1,107 @@ +{ + "engine": "yelp_place", + "params": { + "place_id": { + "description": "Parameter defines the Yelp ID of a place. Each place has two unique IDs (e.g. `ED7A7vDdg8yLNKJTSVHHmg` and `arabica-brooklyn`) and you can use either of them as a value of the place_id. To extract the IDs of a place you can use our Yelp Search API.", + "group": "search_query" + }, + "yelp_domain": { + "type": "select", + "options": [ + "ms.yelp.my", + "www.yelp.cz", + "www.yelp.dk", + "www.yelp.de", + "www.yelp.at", + "de.yelp.ch", + "www.yelp.com.au", + "en.yelp.be", + "www.yelp.ca", + "en.yelp.com.hk", + "en.yelp.my", + "www.yelp.co.nz", + "en.yelp.com.ph", + "www.yelp.ie", + "www.yelp.com.sg", + "en.yelp.ch", + "www.yelp.co.uk", + "www.yelp.com", + "www.yelp.com.ar", + "www.yelp.cl", + "www.yelp.es", + "www.yelp.com.mx", + "fil.yelp.com.ph", + "fr.yelp.be", + "fr.yelp.ca", + "www.yelp.fr", + "fr.yelp.ch", + "www.yelp.it", + "it.yelp.ch", + "nl.yelp.be", + "www.yelp.nl", + "www.yelp.no", + "www.yelp.pl", + "www.yelp.com.br", + "www.yelp.pt", + "fi.yelp.fi", + "sv.yelp.fi", + "www.yelp.com.tr", + "www.yelp.co.jp", + "zh.yelp.com.hk", + "www.yelp.com.tw" + ], + "description": "Parameter defines the Yelp domain to use. It defaults to `yelp.com`. Head to the Yelp domains for a full list of supported Yelp domains.", + "group": "localization" + }, + "business_alert": { + "required": false, + "type": "checkbox", + "description": "Set parameter to `true` to include business alert information when available. It defaults to `false`.", + "group": "advanced_parameters" + }, + "full_menu": { + "required": false, + "type": "checkbox", + "description": "Set parameter to `true` to scrape business full menu when available. It defaults to `false`. When the parameter full_menu is set to `true`, but the business queried doesn't have a full menu page, then `place_results` will be returned instead of `full_menu_results`. This information will also be returned in `search_information` and `error` keys in the json response.", + "group": "advanced_parameters" + }, + "menu_name": { + "required": false, + "description": "Parameter defines the name of which Full Menu to scrape when more than one Full Menu is available. It can only be used in combination with full_menu parameter.", + "group": "advanced_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yelp_place` to use the Yelp Place API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yelp Place results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/yelp_reviews.json b/engines/yelp_reviews.json new file mode 100644 index 0000000..4975514 --- /dev/null +++ b/engines/yelp_reviews.json @@ -0,0 +1,157 @@ +{ + "engine": "yelp_reviews", + "params": { + "place_id": { + "required": true, + "description": "Parameter defines the Yelp ID of a place. Each place has two unique IDs (e.g. `ED7A7vDdg8yLNKJTSVHHmg` and `arabica-brooklyn`). Only the first ID type is supported (e.g. `ED7A7vDdg8yLNKJTSVHHmg`). To extract the ID of a place, you can use our Yelp Search API.", + "group": "search_query" + }, + "yelp_domain": { + "type": "select", + "options": [ + "ms.yelp.my", + "www.yelp.cz", + "www.yelp.dk", + "www.yelp.de", + "www.yelp.at", + "de.yelp.ch", + "www.yelp.com.au", + "en.yelp.be", + "www.yelp.ca", + "en.yelp.com.hk", + "en.yelp.my", + "www.yelp.co.nz", + "en.yelp.com.ph", + "www.yelp.ie", + "www.yelp.com.sg", + "en.yelp.ch", + "www.yelp.co.uk", + "www.yelp.com", + "www.yelp.com.ar", + "www.yelp.cl", + "www.yelp.es", + "www.yelp.com.mx", + "fil.yelp.com.ph", + "fr.yelp.be", + "fr.yelp.ca", + "www.yelp.fr", + "fr.yelp.ch", + "www.yelp.it", + "it.yelp.ch", + "nl.yelp.be", + "www.yelp.nl", + "www.yelp.no", + "www.yelp.pl", + "www.yelp.com.br", + "www.yelp.pt", + "fi.yelp.fi", + "sv.yelp.fi", + "www.yelp.com.tr", + "www.yelp.co.jp", + "zh.yelp.com.hk", + "www.yelp.com.tw" + ], + "description": "Parameter defines the Yelp domain to use. It defaults to `yelp.com`. Head to the Yelp domains for a full list of supported Yelp domains.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "ms", + "cs", + "da", + "de", + "en", + "es", + "fil", + "fr", + "it", + "nl", + "nb", + "pl", + "pt", + "fi", + "sv", + "tr", + "ja", + "zh" + ], + "description": "Parameter defines the language to use for sorting Yelp Reviews. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French) Head to the Yelp Reviews languages for a full list of supported Yelp Reviews languages.", + "group": "localization" + }, + "q": { + "description": "Parameter defines the query you want to use to search through Yelp Reviews.", + "group": "advanced_yelp_parameters" + }, + "sortby": { + "type": "select", + "options": [ + "relevance_desc", + "date_desc", + "date_asc", + "rating_desc", + "rating_asc", + "elites_desc" + ], + "description": "Parameter is used for sorting results. Available options: `relevance_desc` - Yelp Sort (default) `date_desc` - Newest First `date_asc` - Oldest Rated `rating_desc` - Highest Rated `rating_asc` - Lowest Rated `elites_desc` - Elites", + "group": "advanced_yelp_parameters" + }, + "rating": { + "description": "Parameter filters out the results by rating. Possible values are `5`, `4`, `3`, `2`, and `1`. All results are included by default. To only show results with the five star rating, the value should be set to `5` To include results with multiple ratings, the value should for example be set to `5,4,3` (each rating separated by comma `,`).", + "group": "advanced_yelp_parameters" + }, + "not_recommended": { + "type": "checkbox", + "description": "Parameter fetches reviews that are not recommended by Yelp. It can be set to `true` to only show not recommended reviews, or `false` to show recommended reviews. By default, only recommended reviews are shown.", + "group": "advanced_yelp_parameters" + }, + "start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `49` is the 2nd page of results, `98` is the 3rd page of results, etc.).", + "group": "pagination" + }, + "num": { + "type": "number", + "description": "Parameter defines the maximum number of results to return. `49` (default) returns 49 results. Maximum number of results to return is `49`.", + "group": "pagination" + }, + "not_recommended_start": { + "type": "number", + "description": "Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.). The not_recommended_start parameter can only be used with the not_recommended parameter set to `true`.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `yelp_reviews` to use the Yelp Reviews API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the Yelp Reviews results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/youtube.json b/engines/youtube.json new file mode 100644 index 0000000..4347ec5 --- /dev/null +++ b/engines/youtube.json @@ -0,0 +1,462 @@ +{ + "engine": "youtube", + "params": { + "search_query": { + "required": true, + "description": "Parameter defines the search query. You can use anything that you would use in a regular YouTube search.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Youtube search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "sp": { + "description": "Parameter can be used for pagination. Youtube uses continuous pagination and the next page token can be found in the SerpApi JSON response serpapi_pagination -> next_page_token and pagination -> next_page_token fields. Parameter can also be used to filter the search results: by Upload date, you need to set the sp parameter to `CAI%3D` by 4K, you need to set the sp parameter to `EgJwAQ%3D%3D` ... It can also be used for forcing the exact search query spelling by setting the sp value to `QgIIAQ%3D%3D`. If you are interested in passing other filters, you can visit the YouTube website, set filters you want and simply copy sp value from their URL to SerpApi URL.", + "group": "advanced_youtube_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `youtube` to use the YouTube API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the YouTube results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/youtube_video.json b/engines/youtube_video.json new file mode 100644 index 0000000..1cd7fe4 --- /dev/null +++ b/engines/youtube_video.json @@ -0,0 +1,461 @@ +{ + "engine": "youtube_video", + "params": { + "v": { + "description": "Parameter defines the Video ID.", + "group": "search_query" + }, + "gl": { + "type": "select", + "options": [ + "af", + "al", + "dz", + "as", + "ad", + "ao", + "ai", + "aq", + "ag", + "ar", + "am", + "aw", + "au", + "at", + "az", + "bs", + "bh", + "bd", + "bb", + "by", + "be", + "bz", + "bj", + "bm", + "bt", + "bo", + "ba", + "bw", + "bv", + "br", + "io", + "bn", + "bg", + "bf", + "bi", + "kh", + "cm", + "ca", + "cv", + "ky", + "cf", + "td", + "cl", + "cn", + "cx", + "cc", + "co", + "km", + "cg", + "cd", + "ck", + "cr", + "ci", + "hr", + "cu", + "cy", + "cz", + "dk", + "dj", + "dm", + "do", + "ec", + "eg", + "sv", + "gq", + "er", + "ee", + "et", + "fk", + "fo", + "fj", + "fi", + "fr", + "gf", + "pf", + "tf", + "ga", + "gm", + "ge", + "de", + "gh", + "gi", + "gr", + "gl", + "gd", + "gp", + "gu", + "gt", + "gg", + "gn", + "gw", + "gy", + "ht", + "hm", + "va", + "hn", + "hk", + "hu", + "is", + "in", + "id", + "ir", + "iq", + "ie", + "im", + "il", + "it", + "je", + "jm", + "jp", + "jo", + "kz", + "ke", + "ki", + "kp", + "kr", + "kw", + "kg", + "la", + "lv", + "lb", + "ls", + "lr", + "ly", + "li", + "lt", + "lu", + "mo", + "mk", + "mg", + "mw", + "my", + "mv", + "ml", + "mt", + "mh", + "mq", + "mr", + "mu", + "yt", + "mx", + "fm", + "md", + "mc", + "mn", + "me", + "ms", + "ma", + "mz", + "mm", + "na", + "nr", + "np", + "nl", + "an", + "nc", + "nz", + "ni", + "ne", + "ng", + "nu", + "nf", + "mp", + "no", + "om", + "pk", + "pw", + "ps", + "pa", + "pg", + "py", + "pe", + "ph", + "pn", + "pl", + "pt", + "pr", + "qa", + "re", + "ro", + "ru", + "rw", + "sh", + "kn", + "lc", + "pm", + "vc", + "ws", + "sm", + "st", + "sa", + "sn", + "rs", + "sc", + "sl", + "sg", + "sk", + "si", + "sb", + "so", + "za", + "gs", + "es", + "lk", + "sd", + "sr", + "sj", + "sz", + "se", + "ch", + "sy", + "tw", + "tj", + "tz", + "th", + "tl", + "tg", + "tk", + "to", + "tt", + "tn", + "tr", + "tm", + "tc", + "tv", + "ug", + "ua", + "ae", + "uk", + "gb", + "us", + "um", + "uy", + "uz", + "vu", + "ve", + "vn", + "vg", + "vi", + "wf", + "eh", + "ye", + "zm", + "zw" + ], + "description": "Parameter defines the country to use for the Youtube video. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) Head to the Google countries page for a full list of supported Google countries.", + "group": "localization" + }, + "hl": { + "type": "select", + "options": [ + "af", + "ak", + "sq", + "ws", + "am", + "ar", + "hy", + "az", + "eu", + "be", + "bem", + "bn", + "bh", + "xx-bork", + "bs", + "br", + "bg", + "bt", + "km", + "ca", + "chr", + "ny", + "zh-cn", + "zh-tw", + "co", + "hr", + "cs", + "da", + "nl", + "xx-elmer", + "en", + "eo", + "et", + "ee", + "fo", + "tl", + "fi", + "fr", + "fy", + "gaa", + "gl", + "ka", + "de", + "el", + "kl", + "gn", + "gu", + "xx-hacker", + "ht", + "ha", + "haw", + "iw", + "he", + "hi", + "hu", + "is", + "ig", + "id", + "ia", + "ga", + "it", + "ja", + "jw", + "kn", + "kk", + "rw", + "rn", + "xx-klingon", + "kg", + "ko", + "kri", + "ku", + "ckb", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "loz", + "lg", + "ach", + "mk", + "mg", + "ms", + "ml", + "mt", + "mv", + "mi", + "mr", + "mfe", + "mo", + "mn", + "sr-me", + "my", + "ne", + "pcm", + "nso", + "no", + "nn", + "oc", + "or", + "om", + "ps", + "fa", + "xx-pirate", + "pl", + "pt", + "pt-br", + "pt-pt", + "pa", + "qu", + "ro", + "rm", + "nyn", + "ru", + "gd", + "sr", + "sh", + "st", + "tn", + "crs", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "es", + "es-419", + "su", + "sw", + "sv", + "tg", + "ta", + "tt", + "te", + "th", + "ti", + "to", + "lua", + "tum", + "tr", + "tk", + "tw", + "ug", + "uk", + "ur", + "uz", + "vu", + "vi", + "cy", + "wo", + "xh", + "yi", + "yo", + "zu" + ], + "description": "Parameter defines the language to use for the Youtube video. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages.", + "group": "localization" + }, + "next_page_token": { + "description": "Parameter defines the next page token. It is used for retrieving the next page results for related videos, comments or replies. It should be one of - `related_videos_next_page_token` - `comments_next_page_token` - `comments_sorting_token.token` - `replies_next_page_token` from the search results.", + "group": "pagination" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `youtube_video` to use the YouTube Video API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the YouTube Video results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/engines/youtube_video_transcript.json b/engines/youtube_video_transcript.json new file mode 100644 index 0000000..604dba2 --- /dev/null +++ b/engines/youtube_video_transcript.json @@ -0,0 +1,275 @@ +{ + "engine": "youtube_video_transcript", + "params": { + "v": { + "required": true, + "description": "Parameter defines the Video ID, it can be found in the URL of the video as `youtu.be/video_id` or `youtube.com/watch?v=video_id`", + "group": "search_query" + }, + "language_code": { + "type": "select", + "options": [ + "ab", + "aa", + "af", + "ak", + "sq", + "ase", + "am", + "ar", + "arc", + "hy", + "as", + "ay", + "az", + "bn", + "ba", + "eu", + "be", + "bh", + "bho", + "bi", + "bs", + "br", + "bg", + "yue", + "yue-HK", + "ca", + "ceb", + "chr", + "zh", + "zh-CN", + "zh-HK", + "zh-Hans", + "zh-SG", + "zh-TW", + "zh-Hant", + "cho", + "co", + "hr", + "cs", + "da", + "dv", + "nl", + "nl-BE", + "nl-NL", + "dz", + "en", + "en-CA", + "en-IE", + "en-GB", + "en-US", + "eo", + "et", + "ee", + "fo", + "fj", + "fil", + "fi", + "fr", + "gaa", + "fr-BE", + "fr-CA", + "fr-FR", + "fr-CH", + "gl", + "lg", + "ka", + "de", + "de-AT", + "de-DE", + "de-CH", + "el", + "kl", + "gn", + "gu", + "ht", + "hak", + "hak-TW", + "ha", + "haw", + "iw", + "hi", + "hmn", + "hi-Latn", + "hu", + "is", + "ig", + "id", + "ia", + "ie", + "iu", + "ik", + "ga", + "it", + "ja", + "jv", + "kn", + "ks", + "kk", + "kha", + "km", + "rw", + "tlh", + "ko", + "kri", + "ku", + "ky", + "lo", + "la", + "lv", + "ln", + "lt", + "lua", + "luo", + "lb", + "mk", + "mg", + "ms", + "ml", + "mt", + "gv", + "mi", + "mr", + "mas", + "nan", + "nan-TW", + "mo", + "mn", + "mfe", + "my", + "na", + "nv", + "ne", + "new", + "nso", + "no", + "ny", + "oc", + "or", + "om", + "os", + "pam", + "ps", + "fa", + "fa-AF", + "fa-IR", + "pl", + "pt", + "pt-BR", + "pt-PT", + "pa", + "qu", + "ro", + "rm", + "rn", + "ru", + "ru-Latn", + "sm", + "sg", + "sa", + "gd", + "sr", + "crs", + "sr-Cyrl", + "sr-Latn", + "sh", + "sdp", + "sn", + "sd", + "si", + "sk", + "sl", + "so", + "st", + "es", + "es-419", + "es-MX", + "es-ES", + "su", + "sw", + "ss", + "sv", + "tl", + "tg", + "ta", + "tt", + "te", + "th", + "bo", + "ti", + "to", + "ts", + "tn", + "tum", + "tr", + "tk", + "tw", + "uk", + "ur", + "ug", + "uz", + "ve", + "vi", + "war", + "vo", + "cy", + "fy", + "wo", + "xh", + "yi", + "yo", + "zu", + "und" + ], + "description": "Parameter defines the language to use for the YouTube video transcript. It accepts a language code, which may be a two-letter or extended code (e.g., `en` for English, `es-ES` for Spanish (Spain), or `zh-Hans` for Simplified Chinese). If no language is provided, the default language will be English (`en`). If the requested language code is not available for the video, the first available language for the transcript will be used instead. Head to the YouTube Video Transcript Languages page for a full list of supported YouTube Video Transcript languages.", + "group": "localization" + }, + "title": { + "required": false, + "description": "Parameter is used to get the specific transcript using the transcript title, e.g. `Twitch Chat - Simple`.", + "group": "advanced_parameters" + }, + "type": { + "type": "select", + "options": [ + "asr" + ], + "description": "Parameter is used to get the transcript type. E.g: `asr` for automatic speech recognition (auto-generated) transcript.", + "group": "advanced_parameters" + } + }, + "common_params": { + "engine": { + "required": true, + "description": "Set parameter to `youtube_video_transcript` to use the YouTube Video Transcript API engine.", + "group": "serpapi_parameters" + }, + "no_cache": { + "type": "checkbox", + "description": "Parameter will force SerpApi to fetch the YouTube Video Transcript results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together.", + "group": "serpapi_parameters" + }, + "async": { + "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled.", + "group": "serpapi_parameters" + }, + "zero_trace": { + "description": "Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.", + "group": "serpapi_parameters" + }, + "api_key": { + "required": true, + "description": "Parameter defines the SerpApi private key to use.", + "group": "serpapi_parameters" + }, + "output": { + "description": "Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved.", + "group": "serpapi_parameters" + }, + "json_restrictor": { + "description": "Parameter defines the fields you want to restrict in the outputs for smaller, faster responses. See JSON Restrictor for more details.", + "group": "serpapi_parameters" + } + } +} \ No newline at end of file diff --git a/src/server.py b/src/server.py index 5c9521d..634d33a 100644 --- a/src/server.py +++ b/src/server.py @@ -6,6 +6,7 @@ from starlette.responses import JSONResponse from starlette.requests import Request from fastmcp import FastMCP +from fastmcp.resources.resource import Resource from fastmcp.server.dependencies import get_http_request from dotenv import load_dotenv import os @@ -14,6 +15,7 @@ import serpapi import logging from datetime import datetime +from pathlib import Path load_dotenv() @@ -21,6 +23,54 @@ logger = logging.getLogger(__name__) logger.setLevel(logging.INFO) +ENGINES_DIR = Path(__file__).resolve().parents[1] / "engines" + + +def _get_engine_files() -> list[Path]: + if not ENGINES_DIR.exists(): + logger.warning("Engines directory not found: %s", ENGINES_DIR) + return [] + return sorted(ENGINES_DIR.glob("*.json")) + + +@mcp.resource( + "serpapi://engines", + name="serpapi-engines-index", + description="Index of available SerpApi engines and their resource URIs.", + mime_type="application/json", +) +def engines_index() -> dict[str, Any]: + engine_files = _get_engine_files() + engines = [path.stem for path in engine_files] + return { + "count": len(engines), + "engines": engines, + "resources": [f"serpapi://engines/{engine}" for engine in engines], + "schema": { + "note": "Each engine resource uses a flat schema: params are engine-specific; common_params are shared SerpApi parameters.", + "params_key": "params", + "common_params_key": "common_params", + }, + } + + +def _engine_resource_factory(engine: str, engine_path: Path) -> Resource: + def _load_engine() -> dict[str, Any]: + return json.loads(engine_path.read_text()) + + return Resource.from_function( + fn=_load_engine, + uri=f"serpapi://engines/{engine}", + name=f"serpapi-engine-{engine}", + description=f"SerpApi engine specification for {engine}.", + mime_type="application/json", + ) + + +for _engine_path in _get_engine_files(): + _engine_name = _engine_path.stem + mcp.add_resource(_engine_resource_factory(_engine_name, _engine_path)) + def emit_metric(namespace: str, metrics: dict, dimensions: dict = {}): emf_event = { @@ -167,7 +217,7 @@ async def search(params: dict[str, Any] = {}, mode: str = "complete") -> str: General: {"params": {"q": "coffee shops", "engine": "google_light", "location": "Austin, TX"}, "mode": "complete"} Compact: {"params": {"q": "news"}, "mode": "compact"} - Supported engines: + Supported engines include (not limited to): - google - google_light - google_flights @@ -183,6 +233,8 @@ async def search(params: dict[str, Any] = {}, mode: str = "complete") -> str: - youtube_search - baidu - ebay + + Engine params are available via resources at serpapi://engines/ (index: serpapi://engines). """ # Validate mode parameter