{
  "openapi": "3.0.1",
  "info": {
    "title": "AliExpress Search Scraper | Prices, Sold Count & Shipping",
    "description": "Get AliExpress search and category results: title, price, original price, discount, exact sold count, rating, Choice and ad flags, ships-from country, delivery days and rank. Keywords, category ids or search URLs; 20 delivery countries, 16 currencies, 11 languages. No login.",
    "version": "0.0",
    "x-build-id": "VWXUPlc3jdJA61P5j"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/genial_candlestand~aliexpress-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-genial_candlestand-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/genial_candlestand~aliexpress-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-genial_candlestand-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/genial_candlestand~aliexpress-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-genial_candlestand-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": {
          "queries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Keywords to search on AliExpress, one per line, in any language (e.g. \"gaming mouse\", \"handyhülle\"). Each keyword is one search. With Category IDs, every keyword is searched inside every category. Give at least one of Search keywords, Category IDs or Start URLs.",
            "items": {
              "type": "string"
            }
          },
          "categoryIds": {
            "title": "Category IDs",
            "type": "array",
            "description": "Numeric AliExpress category ids (e.g. 44 = Consumer Electronics, 100003109 = Women's Clothing) or category URLs like https://www.aliexpress.com/category/44/consumer-electronics.html (the id is taken from the URL). Alone: lists the products of each category. With Search keywords: each keyword is searched inside each category.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs (search or category pages)",
            "type": "array",
            "description": "AliExpress search (/w/wholesale-….html) or category (/category/<id>/….html) URLs copied from the browser, e.g. https://www.aliexpress.com/w/wholesale-phone-case.html?attr=3079-4148335. Their filters (catId, attr such as brand or colour, SortType, minPrice, maxPrice, selectedSwitches) are kept; the fields below override them when set. aliexpress.us and language subdomains such as de.aliexpress.com are rewritten to www.aliexpress.com. Product (/item/) URLs, store pages and aliexpress.ru are not supported.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxItemsPerSearch": {
            "title": "Max products per search",
            "minimum": 1,
            "maximum": 3600,
            "type": "integer",
            "description": "Stop each search (keyword, category or URL) after this many unique products (1–3,600). AliExpress shows at most 60 pages (about 3,600 cards, roughly 2,700 unique) per search; split big searches by price range or category to get more.",
            "default": 100
          },
          "maxItems": {
            "title": "Max products in total",
            "minimum": 1,
            "type": "integer",
            "description": "Optional cap on all products of the run across all searches. Empty = no total cap (only Max products per search applies)."
          },
          "sort": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "orders",
              "priceAsc",
              "priceDesc",
              "newest"
            ],
            "type": "string",
            "description": "Order of the results, as on AliExpress: Best match, Orders (most sold first), Price low to high, Price high to low, or Newest listings.",
            "default": "relevance"
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "number",
            "description": "Only products priced at least this much, in the selected Currency (e.g. 10 with EUR = €10). Can be used alone or with Max price; Min price must not be greater than Max price."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "number",
            "description": "Only products priced at most this much, in the selected Currency. Can be used alone or with Min price."
          },
          "freeShipping": {
            "title": "Free shipping only",
            "type": "boolean",
            "description": "AliExpress filter \"Free shipping\" for the selected delivery Country. Combines with the other filters.",
            "default": false
          },
          "choiceOnly": {
            "title": "Choice products only",
            "type": "boolean",
            "description": "AliExpress filter \"Choice\" (products of the AliExpress Choice programme). Combines with the other filters.",
            "default": false
          },
          "fourStarsAndUp": {
            "title": "4 stars & up only",
            "type": "boolean",
            "description": "AliExpress filter \"4★ & up\". AliExpress returns nothing for it together with a price sort, so with Price low to high or Price high to low the actor keeps only cards rated 4 or more itself (unrated cards are skipped, not charged). With the AliExpress filter, totalResults is only a running count.",
            "default": false
          },
          "shipFrom": {
            "title": "Ships from",
            "enum": [
              "any",
              "local",
              "CN"
            ],
            "type": "string",
            "description": "Any warehouse; Local warehouse = ships from the delivery Country itself (e.g. US warehouses when Country is United States); or China. Products not shipping from the chosen place are skipped and not charged.",
            "default": "any"
          },
          "country": {
            "title": "Country (deliver to)",
            "enum": [
              "US",
              "GB",
              "DE",
              "FR",
              "ES",
              "IT",
              "NL",
              "PL",
              "SE",
              "TR",
              "IL",
              "SA",
              "BR",
              "MX",
              "CA",
              "AU",
              "NZ",
              "KR",
              "JP",
              "UA"
            ],
            "type": "string",
            "description": "Delivery country: decides the shipping options, local warehouses and delivery days shown. Prices are shown in Currency, independent of the country. Russia, India and Switzerland are not offered: AliExpress serves them with another site or returns other countries' results.",
            "default": "US"
          },
          "currency": {
            "title": "Currency",
            "enum": [
              "USD",
              "EUR",
              "GBP",
              "CAD",
              "AUD",
              "NZD",
              "BRL",
              "MXN",
              "JPY",
              "KRW",
              "PLN",
              "SEK",
              "TRY",
              "ILS",
              "SAR",
              "UAH"
            ],
            "type": "string",
            "description": "Currency of all prices and of Min/Max price. Works with every Country.",
            "default": "USD"
          },
          "language": {
            "title": "Language",
            "enum": [
              "en",
              "de",
              "fr",
              "es",
              "it",
              "pt",
              "nl",
              "pl",
              "tr",
              "ja",
              "ko"
            ],
            "type": "string",
            "description": "Language of product titles and tags (AliExpress machine-translates them). Works with every Country.",
            "default": "en"
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "The Apify datacenter proxy is enough and included in the price; blocked pages are retried automatically on new IPs and, if needed, through Apify residential proxy. Running without a proxy gets blocked quickly.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}