{
  "openapi": "3.0.1",
  "info": {
    "title": "AliExpress Product Scraper: Search Results & Prices",
    "description": "Every product of an AliExpress search to its last page, with exact sold counts and ratings. $1 per 1,000 products. Prices in your country and currency.",
    "version": "0.1",
    "x-build-id": "EjwlbRQU1DhvEBTP8"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/luzivanlt~aliexpress-products-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-luzivanlt-aliexpress-products-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/luzivanlt~aliexpress-products-scraper/runs": {
      "post": {
        "operationId": "runs-sync-luzivanlt-aliexpress-products-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/luzivanlt~aliexpress-products-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-luzivanlt-aliexpress-products-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": "Words to search AliExpress for, one search per line, as you would type them in AliExpress's search box, up to 200 characters each. Ship to, Currency and Sort by apply to them. A link here is refused: paste it under Search links. A product found by two searches is saved and charged once. Example: phone case",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Search links",
            "type": "array",
            "description": "AliExpress search results links in either form (https://www.aliexpress.com/w/wholesale-…html or aliexpress.com/wholesale?SearchText=…), on aliexpress.com or aliexpress.us, with any filters or sort you picked on AliExpress. A link keeps its filters and sort and is read from its first page; the country and currency below apply to it. Example: https://www.aliexpress.com/w/wholesale-phone-case.html",
            "items": {
              "type": "string"
            }
          },
          "shipTo": {
            "title": "Ship to",
            "enum": [
              "US",
              "CA",
              "MX",
              "BR",
              "CL",
              "CO",
              "PE",
              "GB",
              "IE",
              "DE",
              "AT",
              "CH",
              "FR",
              "BE",
              "NL",
              "ES",
              "PT",
              "IT",
              "GR",
              "PL",
              "CZ",
              "HU",
              "RO",
              "UA",
              "SE",
              "NO",
              "DK",
              "FI",
              "TR",
              "IL",
              "SA",
              "AE",
              "EG",
              "MA",
              "NG",
              "ZA",
              "JP",
              "KR",
              "VN",
              "TH",
              "PH",
              "MY",
              "SG",
              "AU",
              "NZ"
            ],
            "type": "string",
            "description": "The country AliExpress shows prices and delivery for, for the search terms and the links. US by default. A product may be missing where it does not ship. Titles are in English in every country. Russia, Kazakhstan, India and Indonesia cannot be picked. Example: DE",
            "default": "US"
          },
          "currency": {
            "title": "Currency",
            "enum": [
              "USD",
              "EUR",
              "GBP",
              "CAD",
              "MXN",
              "BRL",
              "CLP",
              "COP",
              "PEN",
              "CHF",
              "PLN",
              "CZK",
              "HUF",
              "RON",
              "UAH",
              "SEK",
              "NOK",
              "DKK",
              "TRY",
              "ILS",
              "SAR",
              "AED",
              "QAR",
              "KWD",
              "EGP",
              "MAD",
              "NGN",
              "ZAR",
              "JPY",
              "KRW",
              "HKD",
              "TWD",
              "VND",
              "THB",
              "PHP",
              "MYR",
              "SGD",
              "IDR",
              "INR",
              "KZT",
              "RUB",
              "AUD",
              "NZD"
            ],
            "type": "string",
            "description": "The currency prices are shown in, for the search terms and the links: one of 43 currencies, USD by default. It is set on its own, apart from Ship to, and replaces a link's own currency. Example: EUR",
            "default": "USD"
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "best_match",
              "orders",
              "price_low_to_high",
              "price_high_to_low"
            ],
            "type": "string",
            "description": "The order AliExpress lists the products in, for the search terms above: best match (the default), orders, price low to high or price high to low. Search links keep their own sort. Example: orders",
            "default": "best_match"
          },
          "maxProductsPerSearch": {
            "title": "Max products per search",
            "minimum": 1,
            "maximum": 3600,
            "type": "integer",
            "description": "Stop each search after this many products, in AliExpress's order, from 1 to 3,600 (100 by default). A search ends on its own at AliExpress's last results page (at most 60 pages, about 3,500 products). You pay per product saved ($1 per 1,000), so this also caps what each search costs. Example: 500",
            "default": 100
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}