← API documentation

Shopee Brazil: search products

Discover public products by search, select relevant results and use their identifiers or URLs for product detail requests.

5 credits per request. Public data only; GeckoAPI is independent of the marketplace.

Try this endpoint

Region, pagination and limitations

Search takes keyword or a /search URL; page is not supported. Use each result URL for product details. This endpoint covers Brazil with BRL prices. Requests can take up to one minute: allow 90 seconds in your client. These are public product data, not seller account operations or affiliate commissions.

HTTP request

cURL
curl -X POST https://api.geckoapi.com.br/v1/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "notebook gamer",
  "target": "shopee.com.br",
  "type": "plp"
}'

Replace YOUR_API_KEY with your own server-side credential. Read the quickstart for authentication and error handling.

Supported inputs

FieldRequirementMeaning
urlconditionalComplete public search or product URL. Keep its country and query parameters.
keywordconditionalPublic search term. Use a query appropriate for the selected market.
targetrequiredSource identifier shown in the example.
typerequiredplp for search; pdp for product details.

Conditional means an alternative input can satisfy the request, such as keyword or search URL. Fields absent from this table are unsupported for this endpoint.

Example response

One possible response, not a guarantee of current price or availability. Product text stays in the source language. Fields may be missing or null; preserve that distinction in your database.

JSON
{
  "requestId": "f38d98f0-8d1b-42a7-9a15-8f75d20ac1e7",
  "executionId": "5afac754-6361-4f84-8a78-80b8dc6ce6dd",
  "data": {
    "source": "shopee.com.br",
    "type": "plp",
    "url": "https://shopee.com.br/search?keyword=notebook%20gamer",
    "requestUrl": "https://shopee.com.br/search?keyword=notebook%20gamer",
    "extractedAt": "2026-04-18T15:20:30.000Z",
    "query": "notebook gamer",
    "totalResults": 6167,
    "primaryResults": 1,
    "page": 1,
    "resultsPerPage": 60,
    "offset": 0,
    "nextPage": 2,
    "items": [
      {
        "url": "https://shopee.com.br/product/387363734/58254322220",
        "itemId": "58254322220",
        "shopId": "387363734",
        "sku": "58254322220",
        "name": "Notebook Dell 3410 Core I5 10g 8gb 240ssd Detalhe Na Carcaça Cinza (Usado)",
        "currency": "BRL",
        "currencyRaw": "R$",
        "price": 1784.15,
        "priceMin": 1784.15,
        "priceMax": 1784.15,
        "regularPrice": 2099,
        "regularPriceMin": 2099,
        "regularPriceMax": 2099,
        "discountPercentage": 15,
        "soldCount": 254,
        "likedCount": 31,
        "stock": 12,
        "brand": "Dell",
        "categoryId": "100644",
        "itemStatus": "normal",
        "thumbnail": "https://down-br.img.susercontent.com/file/br-11134207-81ztc-mk2ad5a2hypuab",
        "images": [
          {
            "url": "https://down-br.img.susercontent.com/file/br-11134207-81ztc-mk2ad5a2hypuab"
          },
          {
            "url": "https://down-br.img.susercontent.com/file/br-11134207-81ztc-mk2eg23w6sxud7"
          }
        ],
        "variants": [
          "8GB",
          "16GB"
        ],
        "shopLocation": "São Paulo",
        "sellerName": "Loja Dell Usados",
        "sellerId": "387363734",
        "sellerIsOfficialShop": false,
        "sellerIsShopeeVerified": false,
        "sellerIsPreferredPlus": true,
        "freeShipping": true,
        "isServiceByShopee": false,
        "canUseCod": false,
        "sponsored": false,
        "aggregateRating": {
          "rating": 5,
          "reviewCount": 7
        }
      }
    ]
  }
}

Response fields

Field paths and types
{
  "requestId": "string (uuid)",
  "executionId": "string (uuid)",
  "notFound": "boolean (optional; true when the upstream entity was not found and data is null)",
  "data.source": "string",
  "data.type": "string",
  "data.url": "string",
  "data.requestUrl": "string",
  "data.extractedAt": "string (iso datetime)",
  "data.query": "string",
  "data.totalResults": "number",
  "data.primaryResults": "number",
  "data.page": "number",
  "data.resultsPerPage": "number",
  "data.offset": "number",
  "data.nextPage": "number | null",
  "data.nextPageUrl": "string | null (optional)",
  "data.items[].url": "string",
  "data.items[].itemId": "string",
  "data.items[].shopId": "string",
  "data.items[].sku": "string",
  "data.items[].name": "string",
  "data.items[].currency": "string",
  "data.items[].currencyRaw": "string",
  "data.items[].price": "number",
  "data.items[].priceMin": "number",
  "data.items[].priceMax": "number",
  "data.items[].regularPrice": "number",
  "data.items[].regularPriceMin": "number",
  "data.items[].regularPriceMax": "number",
  "data.items[].discountPercentage": "number",
  "data.items[].soldCount": "number",
  "data.items[].likedCount": "number",
  "data.items[].stock": "number | null",
  "data.items[].brand": "string",
  "data.items[].categoryId": "string",
  "data.items[].itemStatus": "string",
  "data.items[].thumbnail": "string",
  "data.items[].images[].url": "string",
  "data.items[].variants[]": "string",
  "data.items[].shopLocation": "string",
  "data.items[].sellerName": "string",
  "data.items[].sellerId": "string",
  "data.items[].sellerIsOfficialShop": "boolean | null",
  "data.items[].sellerIsShopeeVerified": "boolean | null",
  "data.items[].sellerIsPreferredPlus": "boolean | null",
  "data.items[].freeShipping": "boolean | null",
  "data.items[].isServiceByShopee": "boolean | null",
  "data.items[].canUseCod": "boolean | null",
  "data.items[].sponsored": "boolean | null",
  "data.items[].aggregateRating.rating": "number | null",
  "data.items[].aggregateRating.reviewCount": "number | null"
}