{
  "openapi": "3.0.1",
  "info": {
    "title": "AliExpress Product Scraper - Search, Reviews & Price Data",
    "description": "Scrape AliExpress at scale: bulk product search, full item details, customer reviews with rating breakdowns, SKU price tiers, shipping estimates and store/seller data. Export clean structured datasets to JSON, CSV or Excel. Pay only for the rows you keep.",
    "version": "1.0",
    "x-build-id": "aykc5QVpPfUfVhLv3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~aliexpress-product-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-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/sian.agency~aliexpress-product-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-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/sian.agency~aliexpress-product-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-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",
        "required": [
          "operation"
        ],
        "properties": {
          "operation": {
            "title": "🎯 Operation — what do you want to scrape?",
            "enum": [
              "productSearch",
              "productDetail",
              "productReviews",
              "skuPrices",
              "shippingEstimate",
              "storeInfo"
            ],
            "type": "string",
            "description": "🎯 **PICK ONE OPERATION PER RUN.** Each run produces one clean dataset matching the chosen mode.\n\n- **🔍 Product Search** — keyword or category search across AliExpress (~60 products/page) with price, sales, rating and image\n- **📦 Product Detail** — deep scrape of a single product (title, images, price ranges, delivery, package weight/size, seller)\n- **⭐ Product Reviews** — paginated customer reviews with star rating, buyer country, photos, and an aggregate rating breakdown\n- **💲 SKU Prices** — the per-variant price matrix for one product (price, promo price, stock per option)\n- **🚚 Shipping Estimates** — shipping options for a product and destination (fee, carrier, ETA, tracking)\n- **🏪 Store / Seller** — a seller's store profile (followers, positive-rate, seller level and score)\n\n💡 **TIP:** To combine operations, run the actor multiple times with different configurations — e.g. Search first to collect product IDs, then Detail or Reviews per ID.",
            "default": "productSearch"
          },
          "keyword": {
            "title": "🔍 Search Keyword (for Product Search)",
            "type": "string",
            "description": "🔍 **Required for the `Product Search` operation.**\n\nAny AliExpress search query, e.g.:\n- `wireless earbuds`\n- `summer dress`\n- `phone case`\n\n💡 **TIP:** Specific queries return higher-relevance results. Combine with the price filters below to narrow a product niche.\n\n⚠️ **Ignored** for all other operations.",
            "default": "wireless earbuds"
          },
          "sort": {
            "title": "↕️ Sort Order (for Product Search)",
            "enum": [
              "default",
              "salesDesc",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "↕️ **Optional, applies to `Product Search`.** How to order search results.",
            "default": "default"
          },
          "minPrice": {
            "title": "💲 Minimum Price (for Product Search)",
            "minimum": 0,
            "type": "integer",
            "description": "💲 **Optional, applies to `Product Search`.** Only return products at or above this price (in the result currency). Leave blank for no minimum."
          },
          "maxPrice": {
            "title": "💰 Maximum Price (for Product Search)",
            "minimum": 0,
            "type": "integer",
            "description": "💰 **Optional, applies to `Product Search`.** Only return products at or below this price (in the result currency). Leave blank for no maximum."
          },
          "itemId": {
            "title": "📦 Product ID (for Detail / Reviews / SKU / Shipping)",
            "type": "string",
            "description": "📦 **Required for `Product Detail`, `Product Reviews`, `SKU Prices`, and `Shipping Estimates`.**\n\nThe numeric AliExpress product ID. You can find it:\n- In any AliExpress product URL: `https://www.aliexpress.com/item/{ID}.html` → the numeric segment\n- In the `itemId` field of any `Product Search` result row\n\n💡 **TIP:** Run a `Product Search` first, copy the `itemId` from the result rows, then run Detail / Reviews / SKU / Shipping per ID.\n\n⚠️ **Ignored** for the Store / Seller operation.",
            "default": "3256808868342109"
          },
          "sellerId": {
            "title": "🏪 Seller ID (for Store / Seller)",
            "type": "string",
            "description": "🏪 **Required for the `Store / Seller` operation.**\n\nThe numeric AliExpress seller ID. You can find it:\n- In the `sellerId` field of any `Product Detail` result row\n\n💡 **TIP:** Run a `Product Detail` first to get a product's `sellerId`, then run `Store / Seller` to pull the full store profile.\n\n⚠️ **Ignored** for all other operations.",
            "default": "2678280160"
          },
          "region": {
            "title": "🌐 Region",
            "type": "string",
            "description": "🌐 **Optional.** Two-letter destination country code used for localized pricing, currency and shipping estimates (e.g. `US`, `GB`, `DE`, `FR`, `BR`). Defaults to `US`.",
            "default": "US"
          },
          "currency": {
            "title": "💱 Currency",
            "type": "string",
            "description": "💱 **Optional.** Three-letter currency code for prices (e.g. `USD`, `EUR`, `GBP`). Defaults to `USD`.",
            "default": "USD"
          },
          "locale": {
            "title": "🗣️ Language Locale",
            "type": "string",
            "description": "🗣️ **Optional.** Language/locale for titles and text (e.g. `en_US`, `de_DE`, `fr_FR`). Defaults to `en_US`.",
            "default": "en_US"
          },
          "maxPages": {
            "title": "📄 Max pages to fetch",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "📄 **Applies to paginated operations** (Product Search, Product Reviews). Ignored for single-record operations (Detail, SKU, Shipping, Store).\n\n- **Product Search:** ~60 products per page\n- **Product Reviews:** ~20 reviews per page\n\n💡 **TIP:** Start small (1–2 pages) to preview results before scaling up.\n\n⚠️ Hard cap: 50 pages to prevent runaway runs.",
            "default": 3
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}