google_shopping_light.json

{
  "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’s 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. For consistent results with coordinates-based uule parameter, a matching gl parameter is required. Head to UULE Generator if you need to convert a location or GPS coordinates to uule parameter, and vice versa.",
      "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 format of the result. It can be set to `json` (default) to get a structured JSON of the results, `html` to get the raw HTML retrieved, or `md` to get a markdown-formatted version optimized for LLMs and AI agents.",
      "group": "serpapi_parameters"
    },
    "json_restrictor": {
      "description": "Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details.",
      "group": "serpapi_parameters"
    }
  }
}