{
  "openapi": "3.0.1",
  "info": {
    "title": "AliExpress Products Scraper & Price Tracker",
    "description": "AliExpress products scraper and price tracker: scrape AliExpress search results for any keywords — price, discount, rating, units sold, ship-from country, free shipping, delivery estimate and image, for your country and currency. Price-drop monitoring. One flat row per product, no personal data.",
    "version": "0.2",
    "x-build-id": "iCFcFgptxz0gqCQUg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/myth84~aliexpress-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-myth84-aliexpress-search-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/myth84~aliexpress-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-myth84-aliexpress-search-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/myth84~aliexpress-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-myth84-aliexpress-search-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 keywords",
            "type": "array",
            "description": "Enter one search per line, as you would type it in the AliExpress search box, e.g. <code>wireless earbuds</code> or <code>bluetooth speaker</code>. Each search gets its own results, up to the maximum number of products below. No default: give keywords here or search URLs below (the form is prefilled with wireless earbuds).",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "AliExpress search URLs",
            "type": "array",
            "description": "Paste one or more AliExpress search result URLs copied from your browser (<code>https://www.aliexpress.com/w/wholesale-....html?SearchText=...</code>); their category and filter parameters are kept. The sorting and filters below are applied on top only when you set them. Default empty: keywords are enough for most searches.",
            "items": {
              "type": "string",
              "pattern": "^https?://([a-z0-9-]+\\.)*aliexpress\\.[a-z.]+/"
            },
            "default": []
          },
          "maxResults": {
            "title": "Maximum products per search",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop each search (keyword or URL) after this many unique products; you are never charged for more. A result page holds 60 products. Default 100: the top of a market in two pages; 20 to 60 is enough for a quick answer (the form is prefilled with 20 for a quick first run).",
            "default": 100
          },
          "maxPages": {
            "title": "Maximum pages per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Safety cap on the number of result pages read for one search (60 products per page). The scraper also stops when two consecutive pages bring no new product. Default 100: high enough never to stop a search before maxResults.",
            "default": 100
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "default",
              "orders",
              "price_asc",
              "price_desc"
            ],
            "type": "string",
            "description": "Order of the results, as offered by the AliExpress sort bar: best matches, most ordered, price from low to high, price from high to low. AliExpress sorts each page of 60 on its own: the order is exact within a page and approximate across pages. Default: best matches, the order a shopper sees.",
            "default": "default"
          },
          "priceMin": {
            "title": "Min price",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Keep only products priced at least this amount, a whole number in the selected currency, e.g. <code>10</code> for 10 USD; sent to AliExpress as its own price filter. Leave empty for no minimum."
          },
          "priceMax": {
            "title": "Max price",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Keep only products priced at most this amount, a whole number in the selected currency, e.g. <code>50</code> for 50 USD; sent to AliExpress as its own price filter; it must be at least priceMin. Leave empty for no maximum."
          },
          "freeShippingOnly": {
            "title": "Free shipping only",
            "type": "boolean",
            "description": "Keep only products that AliExpress ships for free to the selected country (the site's own filter). Default false: every product, with free shipping reported in shippingFree and conditional offers in attributes.freeShippingThreshold.",
            "default": false
          },
          "includeSponsored": {
            "title": "Include sponsored products",
            "type": "boolean",
            "description": "AliExpress mixes about 15 sponsored products into each page of 60. Keep them (they are flagged in the isSponsored column) or skip them. Default true: they are real offers, and the ranks stay those shown on the site.",
            "default": true
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Keep only products rated at least this value (0 to 5, decimals allowed, e.g. 4.5). Products without a rating yet are left out. Leave empty for no minimum."
          },
          "minSold": {
            "title": "Minimum units sold",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Keep only products with at least this many units sold, compared with the exact figure behind AliExpress' rounded label (soldCount: \"1,000+ sold\" can be 1,720). Products without a sales figure are left out. Leave empty for no minimum."
          },
          "shipsFrom": {
            "title": "Ships from",
            "type": "array",
            "description": "Keep only products shipped from these countries (ISO 3166-1 alpha-2 codes, one per line: <code>US</code>, <code>CN</code>, <code>FR</code>…). Products with an unknown origin are left out. Default empty: every origin.",
            "items": {
              "type": "string",
              "pattern": "^[A-Za-z]{2}$"
            },
            "default": []
          },
          "choiceOnly": {
            "title": "AliExpress Choice only",
            "type": "boolean",
            "description": "Keep only products with the AliExpress Choice badge (platform-curated offers with combined shipping and free returns), reported in the isChoice column. Default false: every product.",
            "default": false
          },
          "listedWithinDays": {
            "title": "Listed within the last N days",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Keep only products listed on AliExpress within this many days (new arrivals), from the listing date shown on the card (listedAt column). Products without a listing date are left out. Leave empty for no limit."
          },
          "country": {
            "title": "Ship-to (delivery) country",
            "pattern": "^[A-Za-z]{2}$",
            "type": "string",
            "description": "ISO 3166-1 alpha-2 code of the delivery (ship-to) country: US, FR, DE, GB, BR… AliExpress adapts the catalogue, prices, shipping badges and delivery dates to it. Pick one from the list or type any code; recorded in viewCountryCode and attributes.shipsTo. Default US: the largest catalogue; use FR for deliveries to France.",
            "default": "US"
          },
          "currency": {
            "title": "Currency",
            "pattern": "^[A-Za-z]{3}$",
            "type": "string",
            "description": "ISO 4217 code of the currency for every price (USD, EUR, GBP…). Pick one from the list or type any code AliExpress supports. If AliExpress ignores the request for a country, the rows carry the currency actually displayed. Default USD: pair it with the country (EUR for FR, GBP for GB).",
            "default": "USD"
          },
          "language": {
            "title": "Language",
            "enum": [
              "en",
              "fr",
              "es",
              "de",
              "it",
              "pt",
              "nl",
              "pl",
              "ru",
              "uk",
              "tr",
              "ja",
              "ko",
              "th",
              "vi",
              "id",
              "ar",
              "he"
            ],
            "type": "string",
            "description": "Language of the product titles and badges. Default en: English titles whatever the ship-to country, easiest to compare.",
            "default": "en"
          },
          "monitorMode": {
            "title": "Price monitoring mode",
            "enum": [
              "off",
              "changes",
              "all"
            ],
            "type": "string",
            "description": "Off: every product is returned. Changes: only new products and price changes since the previous run of the same search are returned and charged; a run without any change succeeds with an empty dataset. All: every product with its changeType (new, price_changed, unchanged). attributes.priceDirection tells drop, rise or same. maxResults is the number of products compared per search. Default off: a plain search.",
            "default": "off"
          },
          "monitorStoreName": {
            "title": "Monitoring store name",
            "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,42}[A-Za-z0-9])?$",
            "type": "string",
            "description": "Required when price monitoring is on: names the key-value store of your account that keeps the previous prices (aliexpress-monitor-&lt;name&gt;). Use one name per schedule, e.g. <code>earbuds-daily</code>. Letters, digits and dashes only, at most 44 characters; upper case is lowered. No default: leave empty when monitoring is off."
          },
          "onlyPriceDrops": {
            "title": "Only price drops",
            "type": "boolean",
            "description": "Write and charge only the products whose price went down since the previous run of the same search (attributes.priceDirection = drop): a ready-made price-drop alert for a daily schedule. Needs monitorMode changes or all and a monitorStoreName; the first run records the prices and writes nothing. Default false: new products and price rises are returned too.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify datacenter proxies (automatic) are enough for AliExpress search pages. If your runs get blocked, switch to Apify residential proxies. You can also provide your own proxy URLs. Default: Apify datacenter proxies, included in the price.",
            "default": {
              "useApifyProxy": true
            }
          },
          "maxRequests": {
            "title": "Max page requests",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Safety cap on the number of result pages fetched in one run, all searches included (60 products per page). Default 500: about 30,000 products, far above a usual run.",
            "default": 500
          },
          "delayMs": {
            "title": "Delay between pages",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Pause between two page requests of the same search, in milliseconds. Increase it if you get blocked; 0 disables the pause. Default 800: polite pacing that keeps a page of 60 products to a few seconds.",
            "default": 800
          },
          "debugStoreHtml": {
            "title": "Store raw HTML pages",
            "type": "boolean",
            "description": "Debugging only: save every fetched page in the run's key-value store. Slows the run down and uses storage. Default false.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}