{
  "openapi": "3.0.1",
  "info": {
    "title": "AliExpress Scraper API - Prices, Orders & Sales Velocity",
    "description": "Scrape AliExpress by keyword, category or pasted link: one row per product with the exact order count, listing date, price and tax rate for your country, Choice and sponsored flags. Run the same task again and every row says how many sold since. Free row filters. No seller data.",
    "version": "0.1",
    "x-build-id": "e8EixhwOh7DMJwsnC"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lowlanddata~aliexpress-product-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lowlanddata-aliexpress-product-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/lowlanddata~aliexpress-product-scraper/runs": {
      "post": {
        "operationId": "runs-sync-lowlanddata-aliexpress-product-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/lowlanddata~aliexpress-product-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-lowlanddata-aliexpress-product-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": {
          "keywords": {
            "title": "Search keywords",
            "type": "string",
            "description": "What to search for, exactly as you would type it into AliExpress."
          },
          "moreKeywords": {
            "title": "More keywords",
            "type": "array",
            "description": "More searches in the same run, one per line, with the same filters. <b>maxItems</b> is shared between them.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "AliExpress links",
            "type": "array",
            "description": "Paste the address of a search (<code>/w/wholesale-...html</code>) or category (<code>/category/...html</code>) results page. Sorting, price band and other filters in the link apply. When links are given, the keyword fields and the filters below are not used. Product and store pages are refused, with the reason.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "shipTo": {
            "title": "Ship to (country)",
            "enum": [
              "US",
              "GB",
              "DE",
              "FR",
              "ES",
              "IT",
              "NL",
              "BE",
              "PL",
              "SE",
              "CA",
              "AU",
              "BR",
              "IN",
              "MX"
            ],
            "type": "string",
            "description": "Which country the prices are for. AliExpress shows different offers and a different currency per destination, so this decides what you get - not just the exchange rate. Applies to links too.",
            "default": "US"
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "orders",
              "newest",
              "price-asc",
              "price-desc"
            ],
            "type": "string",
            "description": "How AliExpress should order the results. 'Most orders' is the useful one for finding what actually sells."
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Only products at or above this price, in the currency AliExpress serves you."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Only products at or below this price."
          },
          "freeShipping": {
            "title": "Free shipping only",
            "type": "boolean",
            "description": "Only products AliExpress flags as free shipping.",
            "default": false
          },
          "choiceOnly": {
            "title": "Choice only",
            "type": "boolean",
            "description": "Only products in the AliExpress Choice programme (fast delivery, free returns). Same switch as on the site.",
            "default": false
          },
          "onSale": {
            "title": "On sale only",
            "type": "boolean",
            "description": "Only products in the current sale event, when one is running (the site's 'Big Sale' toggle).",
            "default": false
          },
          "shipFrom": {
            "title": "Ships from",
            "type": "string",
            "description": "Only products shipped from this country: a two-letter code like <code>CN</code>, <code>US</code>, <code>ES</code>, or <code>EU</code> for any European warehouse. Leave empty for any origin."
          },
          "minOrders": {
            "title": "Minimum orders",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only products with at least this many orders. Order counts are exact numbers here (3188, not '3k+'), so a threshold means something."
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Keep only products rated at least this many stars. Products with no rating yet are dropped when this is set."
          },
          "listedWithinDays": {
            "title": "Listed in the last N days",
            "minimum": 1,
            "type": "integer",
            "description": "Keep only products first listed within this many days. Combine with a minimum order count to find new listings that already sell."
          },
          "trackOrders": {
            "title": "Remember order counts between runs",
            "type": "boolean",
            "description": "When on, each run keeps the order count and price per product for this task, and the next run adds <code>ordersDelta</code>, <code>pricePrevious</code> and <code>priceDelta</code> to every row: the sales and the price move since the previous run. The first run only records a baseline. Nothing is ever withheld because of it.",
            "default": true
          },
          "resetMemory": {
            "title": "Forget previous runs",
            "type": "boolean",
            "description": "Start the sales memory over for this task: this run becomes the new baseline.",
            "default": false
          },
          "maxItems": {
            "title": "Maximum products",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many products in total, across every search and link. One page carries 60.",
            "default": 200
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "AliExpress challenges suspicious requests with a slider served as HTTP 200, and prices by destination - so the run pins a residential session to the Ship to country. Leave this as it is: a custom proxy without that targeting returns another country's offers.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          },
          "reportFailures": {
            "title": "Anonymous reports to the developer",
            "type": "boolean",
            "description": "Only two things are sent to the developer. When a run fails: the actor name and build, an error category, the truncated error message and a one-way hash of your input. At the start of every run: the actor name, the build, a one-way hash of your Apify account id and whether the account is on a paid Apify plan. <b>Your input, your results, your name and your account id itself are never sent.</b> Turn this off and nothing is sent; the actor behaves the same.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}