{
  "openapi": "3.0.1",
  "info": {
    "title": "AliExpress Search Scraper: Prices, Sold Counts & Ratings",
    "description": "Scrape AliExpress search results and categories: price, discount, exact sold count, rating, delivery estimate, ships-from, Choice and sponsored flags, rank and listing date, for 60 countries. For dropshipping product research, price tracking and trend analysis.",
    "version": "1.0",
    "x-build-id": "aCvg2BtFEk29mygMg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/panix~aliexpress-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-panix-aliexpress-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/panix~aliexpress-scraper/runs": {
      "post": {
        "operationId": "runs-sync-panix-aliexpress-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/panix~aliexpress-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-panix-aliexpress-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": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "One search per line, as you would type it on AliExpress, for example <code>wireless earbuds</code>, <code>yoga mat</code>, <code>phone holder for car</code>.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "AliExpress search or category links",
            "type": "array",
            "description": "Paste links of AliExpress search results (<code>https://www.aliexpress.com/w/wholesale-yoga-mat.html</code>) or category pages (<code>https://www.aliexpress.com/category/100003109/women-clothing.html</code>). Filters and sorting you chose on AliExpress before copying the link are kept. Links from aliexpress.us and language subdomains (de., es., fr. ...) work too.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxItems": {
            "title": "Max products per search",
            "minimum": 1,
            "maximum": 3600,
            "type": "integer",
            "description": "Stop each search term or link after this many products. AliExpress shows at most 60 pages of 60 products (3,600) per search; use more specific terms or price ranges to go further.",
            "default": 100
          },
          "sort": {
            "title": "Sort by",
            "enum": [
              "bestMatch",
              "orders",
              "priceLowToHigh",
              "priceHighToLow"
            ],
            "type": "string",
            "description": "Order of the results, as on AliExpress. <b>Most orders</b> finds proven best sellers.",
            "default": "bestMatch"
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "number",
            "description": "Lowest price, in the currency below. Also checked by the Actor on every product."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "number",
            "description": "Highest price, in the currency below. Also checked by the Actor on every product."
          },
          "freeShippingOnly": {
            "title": "Free shipping only",
            "type": "boolean",
            "description": "AliExpress's own free-shipping filter for the ship-to country.",
            "default": false
          },
          "choiceOnly": {
            "title": "AliExpress Choice only",
            "type": "boolean",
            "description": "Only products in AliExpress Choice (faster delivery, free returns in many countries).",
            "default": false
          },
          "shipFrom": {
            "title": "Ships from",
            "enum": [
              "CN",
              "US",
              "GB",
              "CA",
              "AU",
              "NZ",
              "IE",
              "DE",
              "FR",
              "ES",
              "IT",
              "NL",
              "BE",
              "AT",
              "CH",
              "PL",
              "PT",
              "SE",
              "NO",
              "DK",
              "FI",
              "CZ",
              "SK",
              "HU",
              "RO",
              "BG",
              "GR",
              "HR",
              "SI",
              "LT",
              "LV",
              "EE",
              "LU",
              "UA",
              "TR",
              "IL",
              "SA",
              "AE",
              "QA",
              "KW",
              "EG",
              "MA",
              "ZA",
              "NG",
              "BR",
              "MX",
              "CL",
              "CO",
              "PE",
              "AR",
              "JP",
              "KR",
              "IN",
              "PK",
              "ID",
              "TH",
              "VN",
              "PH",
              "MY",
              "SG",
              "HK"
            ],
            "type": "string",
            "description": "Only products sent from a warehouse in this country, for example the United States for fast local delivery. Leave empty for all."
          },
          "categoryId": {
            "title": "Category ID",
            "pattern": "^[0-9]*$",
            "type": "string",
            "description": "Limit the search terms to one AliExpress category, e.g. <code>200001928</code>. Every result row has its <code>categoryId</code>, so you can take one from a first run."
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Keep products rated at least this many stars (0 to 5, e.g. 4.5). Products without a rating are left out when this is set."
          },
          "minOrders": {
            "title": "Minimum sold",
            "minimum": 0,
            "type": "integer",
            "description": "Keep products sold at least this many times (exact sold counts, not the rounded \"5,000+\" label)."
          },
          "listedWithinDays": {
            "title": "Listed within the last (days)",
            "minimum": 1,
            "type": "integer",
            "description": "Keep only products listed on AliExpress in the last N days, for example 30 to find new products that already sell."
          },
          "excludeSponsored": {
            "title": "Leave out sponsored listings",
            "type": "boolean",
            "description": "Skip paid ad placements in the results (they are marked <code>isSponsored</code>).",
            "default": false
          },
          "uniqueProducts": {
            "title": "Each product once per run",
            "type": "boolean",
            "description": "A product already returned for an earlier search in this run is skipped (and not charged). Turn off to get it again under every search, for example for rank tracking.",
            "default": true
          },
          "shipTo": {
            "title": "Ship to",
            "enum": [
              "US",
              "GB",
              "CA",
              "AU",
              "NZ",
              "IE",
              "DE",
              "FR",
              "ES",
              "IT",
              "NL",
              "BE",
              "AT",
              "CH",
              "PL",
              "PT",
              "SE",
              "NO",
              "DK",
              "FI",
              "CZ",
              "SK",
              "HU",
              "RO",
              "BG",
              "GR",
              "HR",
              "SI",
              "LT",
              "LV",
              "EE",
              "LU",
              "UA",
              "TR",
              "IL",
              "SA",
              "AE",
              "QA",
              "KW",
              "EG",
              "MA",
              "ZA",
              "NG",
              "BR",
              "MX",
              "CL",
              "CO",
              "PE",
              "AR",
              "JP",
              "KR",
              "IN",
              "PK",
              "ID",
              "TH",
              "VN",
              "PH",
              "MY",
              "SG",
              "HK"
            ],
            "type": "string",
            "description": "Destination country. AliExpress shows a different catalogue, prices and delivery times per country.",
            "default": "US"
          },
          "currency": {
            "title": "Currency",
            "enum": [
              "USD",
              "EUR",
              "GBP",
              "CAD",
              "AUD",
              "NZD",
              "CHF",
              "SEK",
              "NOK",
              "DKK",
              "PLN",
              "CZK",
              "HUF",
              "RON",
              "BGN",
              "UAH",
              "TRY",
              "ILS",
              "SAR",
              "AED",
              "QAR",
              "KWD",
              "EGP",
              "MAD",
              "ZAR",
              "NGN",
              "BRL",
              "MXN",
              "CLP",
              "COP",
              "PEN",
              "ARS",
              "JPY",
              "KRW",
              "INR",
              "PKR",
              "IDR",
              "THB",
              "VND",
              "PHP",
              "MYR",
              "SGD",
              "HKD"
            ],
            "type": "string",
            "description": "Currency of all prices. Leave empty for the ship-to country's own currency (US dollar for the United States, euro for Germany)."
          },
          "language": {
            "title": "Language",
            "enum": [
              "en_US",
              "es_ES",
              "fr_FR",
              "de_DE",
              "it_IT",
              "pt_BR",
              "nl_NL",
              "pl_PL",
              "tr_TR",
              "ja_JP",
              "ko_KR",
              "ar_MA",
              "th_TH"
            ],
            "type": "string",
            "description": "Language of product titles and labels.",
            "default": "en_US"
          },
          "watchlistName": {
            "title": "Watchlist name",
            "type": "string",
            "description": "Any name, e.g. <code>earbuds-us</code>. With a name, every product gets <code>changeType</code> (new, priceChanged, unchanged) and <code>firstSeenAt</code>, plus <code>previousPrice</code> when the seller changed the price. Use one name per set of searches, and sort by <b>Most orders</b>: AliExpress reshuffles best-match results between visits."
          },
          "onlyNewProducts": {
            "title": "Only new products",
            "type": "boolean",
            "description": "Return only products not seen in earlier runs of this watchlist. Products seen before are left out and not charged. <b>Max products per search</b> then sets how many of the top results are checked, so every run looks at the same top N.",
            "default": false
          },
          "includePriceChanges": {
            "title": "Also products whose price changed",
            "type": "boolean",
            "description": "With Only new products: also return products seen before whose seller changed the price, with the old price and the change. Visitor discounts that AliExpress varies from visit to visit don't count as changes.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify datacenter proxy by default, with a new IP address for every few pages. Pages that keep hitting AliExpress's captcha are retried on residential IPs automatically, at no extra cost to you.",
            "default": {
              "useApifyProxy": true
            }
          },
          "maxConcurrency": {
            "title": "Pages in parallel",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many result pages are loaded at the same time.",
            "default": 4
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}