API Platform

Use the Shopee API for Vietnam

Target Shopee data for Vietnam with country code VN. Requests return the marketplace signals available through the Ecomblade product-data pipeline.

Start free Overview

Authentication and access

Get API access

API Platform access requires an eligible Ecomblade plan. Create a key in the authenticated API Platform, save the secret when it is shown, and send it as a Bearer token. Keys can be revoked from the same workspace.

GET/api/v1/products/searchProduct search · platform, query, country, page=1, filters?

GET/api/v1/products/categoryCategory products · platform, categoryId, country, categoryLevel=2, page=1

Example request

curl --get 'https://api.ecomblade.com/api/v1/products/search?platform=shopee&query=wireless+earbuds&page=1&country=VN' \
  --header 'Authorization: Bearer $ECOMBLADE_API_KEY'

Data returned by the API

Example response

Responses contain normalized product fields plus marketplace-specific data. Depending on the source, useful fields include product identity, URLs, images, price, currency, ratings, reviews, sales and revenue signals, store details, and pagination state.

JSON

{
  "success": true,
  "data": {
    "status": 200,
    "items": [
      {
        "itemId": "10001234567",
        "name": "Wireless Noise-Cancelling Earbuds",
        "slug": "wireless-noise-cancelling-earbuds-i.500123456.10001234567",
        "url": "https://shopee.vn/wireless-noise-cancelling-earbuds-i.500123456.10001234567",
        "brand": "Example Audio",
        "image": "https://cf.example.com/file/example-earbuds",
        "shopId": "500123456",
        "shopName": "Example Audio Official",
        "price": 749000,
        "originalPrice": 999000,
        "discount": 24,
        "currency": "VND",
        "sold": 1280,
        "monthlySold": 340,
        "totalSold": 4620,
        "revenue": 958720000,
        "monthlyRevenue": 254660000,
        "totalRevenue": 3460380000,
        "listingDate": "2026-01-15T00:00:00.000Z",
        "reviews": 894,
        "marketplaceData": {
          "shopee": {
            "rating": 4.8,
            "like": 1200,
            "comment": 415,
            "stock": 680,
            "stockValue": 509320000,
            "location": "Ho Chi Minh City"
          }
        }
      }
    ],
    "hasFullAccess": true,
    "isLimited": false
  }
}

Useful marketplace signals

Errors and usage limits

Invalid parameters, expired or revoked credentials, plan access, rate limits, upstream parsing, and exhausted pages return explicit HTTP error responses. Clients should check the response status, respect Retry-After when present, and avoid assuming that every marketplace returns identical optional fields.

Frequently asked questions

Which endpoints support Shopee?

Ecomblade exposes GET /api/v1/products/search and GET /api/v1/products/category for Shopee. Marketplace-specific query parameters are documented in the authenticated API Platform.

Which country value selects Vietnam?

Use country=VN for Vietnam requests. The country parameter is required for this marketplace.

Get API access

Choose an eligible plan to create API keys and connect marketplace data to your workflow.

Get API accessNo credit card required.