{
  "openapi": "3.0.1",
  "info": {
    "title": "Alibaba Products Scraper: Wholesale Suppliers, Prices & MOQ",
    "description": "Scrape Alibaba.com products and suppliers by keyword, search URL, product URL, storefront or image: wholesale price range and tiers, MOQ, SKUs, specs, certifications, and the supplier's name, country, years, verified badges and rating. Supplier search and product details too. Misses free.",
    "version": "0.2",
    "x-build-id": "jCwQlokrhDfkh1Dug"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/hyperbach~alibaba-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-hyperbach-alibaba-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/hyperbach~alibaba-scraper/runs": {
      "post": {
        "operationId": "runs-sync-hyperbach-alibaba-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/hyperbach~alibaba-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-hyperbach-alibaba-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "searchQueries": {
            "title": "Search words",
            "type": "array",
            "description": "What to search for on Alibaba.com, one search a line (`led lights`), as you would type it in Alibaba's search box. Each search is read apart. Up to 100 searches, URLs, storefronts, images and supplier searches a run together. An empty line gets a free `invalid` row, a search given twice a free `duplicate` row.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Alibaba.com URLs",
            "type": "array",
            "description": "Alibaba.com URLs as your browser shows them: a search (`https://www.alibaba.com/trade/search?SearchText=led+strip+light`, with the filters you set there; they are kept), a category page (`/catalog/…_cid…`), a `/products/`, `/showroom/` or `/countrysearch/` page (read as the search of its words), a product page (read like `productUrls`) or a supplier's storefront (`https://<name>.en.alibaba.com/`, its product catalogue). A URL of another site gets a free `invalid` row.",
            "items": {
              "type": "string"
            }
          },
          "productUrls": {
            "title": "Product URLs or ids",
            "type": "array",
            "description": "Alibaba.com product pages to read, one a line: the URL (`https://www.alibaba.com/product-detail/…_1600318274427.html`) or the id (`1600318274427`). Each row carries the whole product page (ladder, SKUs, specs, description, certificates, supplier profile). An id Alibaba answers \"Product Not Available\" for on two exits gets a free `not_found` row. Up to 1,000 a run.",
            "items": {
              "type": "string"
            }
          },
          "imageUrls": {
            "title": "Image URLs (search by image)",
            "type": "array",
            "description": "Find products that look like an image: one image URL a line (JPEG, PNG, WebP). An image on Alibaba's own CDN (`*.alicdn.com`) is searched directly; any other image is downloaded by the run and uploaded to Alibaba's search by image. Alibaba gives no similarity score; the order is its own.",
            "items": {
              "type": "string"
            }
          },
          "supplierQueries": {
            "title": "Supplier search words",
            "type": "array",
            "description": "Search Alibaba's suppliers (the Suppliers tab), one search a line (`insulated water bottle`). Each supplier is a `supplier` row: name, id, store and profile URLs, years, Verified and Verified Pro flags, rating and reviews, main products, factory area, staff, 6-month transactions, response time, capability tags and a sample product.",
            "items": {
              "type": "string"
            }
          },
          "maxItemsPerQuery": {
            "title": "Max results per input",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Stop each search, category, storefront, image or supplier search after this many products or suppliers (0 = every one it lists). A product Alibaba repeats on a later page, or one an earlier input of the run already delivered, is skipped and not counted. Alibaba lists about 1,700 products of an ordinary search to a reader on its small list and more on its big one, whatever its own count says.",
            "default": 100
          },
          "maxItems": {
            "title": "Max charged rows (the whole run)",
            "minimum": 0,
            "maximum": 200000,
            "type": "integer",
            "description": "Stop the run after this many product and supplier rows across every input (0 = no limit). Search rows are free and not counted; an input left unread at the cap gets a free `not_read` row.",
            "default": 0
          },
          "includeDetails": {
            "title": "Read each product's page (details)",
            "type": "boolean",
            "description": "For each product of a search, a category or an image search, also read its product page: the price ladder by quantity (in your currency and in USD), every SKU with its values, price and stock, the specs, the seller's description, certificate documents with number and validity, lead times, samples, customization, trade terms, places of dispatch, the category path and the supplier's profile (business type, staff, floorspace, revenue, on-time rate, response time, 6-month orders). Charged as `details` on each row that carries its page; a page Alibaba does not serve leaves the card's row, not charged for details. Product URLs and storefront products always carry their page.",
            "default": false
          },
          "includeSupplierReport": {
            "title": "Read the supplier's report",
            "type": "boolean",
            "description": "Add the supplier's verification report from its storefront: the assessment and on-site check flags, the verified business type, the main markets with their shares, the response rate, the Trade Assurance limit, and the profile sections (company overview, production capacity, quality control, R&D, trade capability) with their items. Read once a run per supplier; charged as `supplier_report` on each row that carries it.",
            "default": false
          },
          "shipToCountry": {
            "title": "Ship-to country (the view)",
            "enum": [
              "US",
              "CN",
              "DE",
              "GB",
              "FR",
              "IT",
              "ES",
              "NL",
              "BE",
              "SE",
              "PL",
              "CH",
              "AT",
              "IE",
              "DK",
              "NO",
              "FI",
              "PT",
              "GR",
              "CZ",
              "IN",
              "JP",
              "KR",
              "HK",
              "SG",
              "MY",
              "TH",
              "VN",
              "ID",
              "PH",
              "AE",
              "SA",
              "TR",
              "IL",
              "CA",
              "MX",
              "BR",
              "AR",
              "VE",
              "AU",
              "NZ",
              "ZA",
              "CL",
              "CO",
              "PE",
              "EC",
              "UY",
              "RO",
              "HU",
              "BG",
              "HR",
              "SK",
              "SI",
              "LT",
              "LV",
              "EE",
              "UA",
              "PK",
              "BD",
              "TW",
              "LK",
              "QA",
              "KW",
              "BH",
              "OM",
              "JO",
              "EG",
              "NG",
              "KE",
              "MA",
              "GH"
            ],
            "type": "string",
            "description": "The country Alibaba shows the products for, as its \"Deliver to\" selector does: the list, its prices and what can ship there follow it. Every answer is checked to be in this view; a page in another one is never delivered. The run's exits are in this country where the proxy has them (US otherwise); each row says the view in `ship_to_country`.",
            "default": "US"
          },
          "currency": {
            "title": "Currency",
            "enum": [
              "AED",
              "ARS",
              "AUD",
              "BDT",
              "BHD",
              "BRL",
              "CAD",
              "CHF",
              "CLP",
              "CNY",
              "COP",
              "CZK",
              "DKK",
              "EGP",
              "EUR",
              "GBP",
              "GHS",
              "HKD",
              "HUF",
              "IDR",
              "ILS",
              "INR",
              "JOD",
              "JPY",
              "KES",
              "KRW",
              "KWD",
              "LKR",
              "MAD",
              "MXN",
              "MYR",
              "NGN",
              "NOK",
              "NZD",
              "OMR",
              "PEN",
              "PHP",
              "PKR",
              "PLN",
              "QAR",
              "RON",
              "SAR",
              "SEK",
              "SGD",
              "THB",
              "TRY",
              "TWD",
              "UAH",
              "USD",
              "UYU",
              "VND",
              "ZAR"
            ],
            "type": "string",
            "description": "The currency of every price, chosen apart from the country (Alibaba converts at its own rate). `price`, `price_min` and `price_max` are in it; with details each ladder tier also carries its USD price. A page whose prices are not in this currency is never delivered.",
            "default": "USD"
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "number",
            "description": "Only products priced at least this much (in the run's currency), as Alibaba's own price filter applies it."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "number",
            "description": "Only products priced at most this much (in the run's currency)."
          },
          "maxMOQ": {
            "title": "Max minimum order",
            "minimum": 0,
            "type": "integer",
            "description": "Only products whose minimum order is at most this many units (0 = any)."
          },
          "supplierCountries": {
            "title": "Supplier countries",
            "type": "array",
            "description": "Only suppliers located in these countries: two-letter codes, one a line (`CN`, `US`, `IN`).",
            "items": {
              "type": "string"
            }
          },
          "verifiedSupplier": {
            "title": "Verified Supplier only",
            "type": "boolean",
            "description": "Only suppliers verified by a third-party inspection (Alibaba's Verified Supplier filter).",
            "default": false
          },
          "verifiedProSupplier": {
            "title": "Verified Pro Supplier only",
            "type": "boolean",
            "description": "Only Verified Pro suppliers.",
            "default": false
          },
          "guaranteed": {
            "title": "Guaranteed only",
            "type": "boolean",
            "description": "Only products with Alibaba's Guaranteed delivery and price.",
            "default": false
          },
          "productCertTags": {
            "title": "Product certifications",
            "type": "array",
            "description": "Only products with these certifications, one a line (`CE`, `ROHS`, `FSC`), as Alibaba's filter names them.",
            "items": {
              "type": "string"
            }
          },
          "companyAuthTags": {
            "title": "Company certifications",
            "type": "array",
            "description": "Only suppliers with these management certifications, one a line (`ISO`, `BSCI`, `SEDEX`).",
            "items": {
              "type": "string"
            }
          },
          "minReviewScore": {
            "title": "Min store rating",
            "enum": [
              "any",
              "4",
              "4.5",
              "5"
            ],
            "type": "string",
            "description": "Only suppliers whose store rating is at least this.",
            "default": "any"
          },
          "maxDeliveryDays": {
            "title": "Max delivery days",
            "minimum": 0,
            "maximum": 365,
            "type": "integer",
            "description": "Only products Alibaba can deliver within this many days (its \"Delivery by\" filter offers 18, 24 and 30 days; another value is read as the next lower one; under 18 is refused). 0 = any."
          },
          "localStock": {
            "title": "Local stock only",
            "type": "boolean",
            "description": "Only products stocked in a warehouse that ships to your ship-to country (Alibaba's \"Local stock\"). The run reads the view's own filter value from Alibaba's first page (US in the US view, EU in European views); a view that offers none gets a free `not_offered` row.",
            "default": false
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "sales_volume"
            ],
            "type": "string",
            "description": "The order Alibaba lists the products in: its own relevance order, or its sort by the units sold in the last 180 days. A search URL's own sort stays the URL's.",
            "default": "relevance"
          },
          "excludeIds": {
            "title": "Skip these ids",
            "type": "array",
            "description": "Product ids or supplier ids you already have, one a line (`1600318274427`, `230538595`): a product with that id, or a product of that supplier, or that supplier, is skipped before it is counted or charged. Up to 500,000.",
            "items": {
              "type": "string"
            }
          },
          "skipAds": {
            "title": "Skip sponsored products",
            "type": "boolean",
            "description": "Leave out the products Alibaba marks as ads. Off: they are delivered with `is_ad` true.",
            "default": false
          },
          "egressFirst": {
            "title": "Proxy to lead with (tests)",
            "type": "string",
            "description": "For the maintainers' tests: the proxy the run leads with: `residential` (the default) or `datacenter` (Apify's datacenter group). Leave it as it is.",
            "default": "residential"
          },
          "feedback": {
            "title": "Feedback to the maintainers",
            "maxLength": 2000,
            "type": "string",
            "description": "A note to the people who maintain this Actor: what you needed and did not get. For example a missing field, a wrong or empty result, or the Actor you switch from or to, and why. The run does not read it: the rows and the charges stay the same. A person reads every note."
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}