{
  "openapi": "3.0.1",
  "info": {
    "title": "AliExpress Reviews Scraper",
    "description": "AliExpress Reviews Scraper collects AliExpress product reviews in bulk: text with translation, star rating, buyer country, photos, follow-ups, seller replies, sentiment and issue labels, plus rating summaries. Filter by stars, date, keywords and country. Export JSON, CSV or Excel, or use the API.",
    "version": "0.1",
    "x-build-id": "4dgvIFzgqjnKTKoW2"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/fastdataapi~aliexpress-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-fastdataapi-aliexpress-reviews-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/fastdataapi~aliexpress-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-fastdataapi-aliexpress-reviews-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/fastdataapi~aliexpress-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-fastdataapi-aliexpress-reviews-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": {
          "products": {
            "title": "🆔 Product IDs or URLs",
            "type": "array",
            "description": "AliExpress products to scrape, one per line: a numeric product ID (1005006079931969) or a product URL (https://www.aliexpress.com/item/1005006079931969.html). Add as many as you like. Provide products here, in Start URLs, or both.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 Start URLs",
            "type": "array",
            "description": "Product URLs as a list, or a link to a text file with one URL per line. Used together with the product list above.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxReviewsPerProduct": {
            "title": "🔢 Max reviews per product",
            "minimum": 1,
            "type": "integer",
            "description": "How many reviews to save for each product. Reviews removed by your filters do not count. Free plan: up to 20 reviews per run (all products together) and 200 per month; paid plans have no limit.",
            "default": 20
          },
          "language": {
            "title": "🌍 Review language",
            "enum": [
              "EN",
              "RU",
              "PT",
              "ES",
              "FR",
              "ID",
              "IT",
              "TH",
              "JA",
              "AR",
              "VI",
              "TR",
              "DE",
              "HE",
              "KO",
              "NL",
              "PL",
              "MX",
              "CL",
              "IN"
            ],
            "type": "string",
            "description": "Reviews are returned translated into this language; the original text is kept next to the translation.",
            "default": "EN"
          },
          "sort": {
            "title": "🔃 Sort by",
            "enum": [
              "default",
              "newest",
              "oldest",
              "lowest_rating",
              "highest_rating"
            ],
            "type": "string",
            "description": "Order of the reviews. Lowest and highest rating go through the star ratings in turn (1 to 5 or 5 to 1) and replace the review filter below, except when the filter is a single star value: then that filter is kept and a rating sort has no effect.",
            "default": "default"
          },
          "reviewFilter": {
            "title": "🎯 Review filter",
            "enum": [
              "all",
              "5",
              "4",
              "3",
              "2",
              "1",
              "image",
              "additional",
              "local"
            ],
            "type": "string",
            "description": "Show only one group of reviews: one star value, reviews with photos, reviews with a follow-up, or reviews from the country set below.",
            "default": "all"
          },
          "country": {
            "title": "📍 Your country",
            "type": "string",
            "description": "Two-letter country code (e.g. US, BR, FR). Used by the \"From my country\" filter.",
            "default": "US"
          },
          "minRating": {
            "title": "🎯 Min star rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Keep reviews rated at least this many stars (1-5). Leave empty for no lower bound."
          },
          "maxRating": {
            "title": "🎯 Max star rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Keep reviews rated at most this many stars (1-5). Leave empty for no upper bound."
          },
          "sinceDate": {
            "title": "📅 Reviews since",
            "type": "string",
            "description": "Keep reviews published on or after this date. With \"Newest first\" the run stops paging once reviews get older than this date."
          },
          "keywords": {
            "title": "🔎 Keywords",
            "type": "array",
            "description": "Keep reviews whose text (translated or original) contains any of these words, case-insensitive.",
            "items": {
              "type": "string"
            }
          },
          "countries": {
            "title": "📍 Reviewer countries",
            "type": "array",
            "description": "Keep reviews written by buyers from these countries, as two-letter codes (e.g. US, BR).",
            "items": {
              "type": "string"
            }
          },
          "writtenOnly": {
            "title": "✅ Written reviews only",
            "type": "boolean",
            "description": "Skip rating-only reviews that have no text, photos or follow-up.",
            "default": true
          },
          "onlyNewReviews": {
            "title": "✅ Only new reviews",
            "type": "boolean",
            "description": "Skip reviews this actor already returned to you in earlier runs. Review IDs are remembered in a key-value store in your Apify account.",
            "default": false
          },
          "onlyNewStateKey": {
            "title": "🔧 Only-new memory name",
            "type": "string",
            "description": "Name of the remembered review list used by Only new reviews. Use different names to track separate projects. Letters, digits and !-_.'() only.",
            "default": "seen-reviews"
          },
          "startPage": {
            "title": "🔢 Start page",
            "minimum": 1,
            "type": "integer",
            "description": "Page of reviews to start from (20 reviews per page). The status row gives the next page to continue from when more reviews are left.",
            "default": 1
          },
          "analyzeReviews": {
            "title": "✅ Sentiment and issue labels",
            "type": "boolean",
            "description": "Add a sentiment score (0-4) and the main problem the review raises (defect, shipping delay, size, wrong item...) to every review.",
            "default": true
          },
          "reportsClaim": {
            "title": "🎯 Check reviews for a claim",
            "maxLength": 300,
            "type": "string",
            "description": "A short statement, e.g. \"the battery drains quickly\". With Sentiment and issue labels on, every review gets the probability (0-1) that it says this; with labels off the claim is ignored. Up to 300 characters; reviews and claim should use the same alphabet."
          },
          "includeEvidence": {
            "title": "✅ Include evidence quotes",
            "type": "boolean",
            "description": "For each label, add the sentence from the review that shows it.",
            "default": false
          },
          "goal": {
            "title": "🎯 Research goal",
            "maxLength": 300,
            "type": "string",
            "description": "Keep only the reviews that help with this goal, e.g. \"how long the battery lasts\". The first and last review and uncertain matches are kept; the others are left out and not charged. Up to 300 characters."
          },
          "goalTokenBudget": {
            "title": "🔢 Goal size budget",
            "minimum": 1,
            "type": "integer",
            "description": "Optional size cap (in AI tokens, about 4 characters each) for the reviews kept by Research goal; the least relevant are left out first."
          },
          "hideBuyerDetails": {
            "title": "✅ Hide buyer details",
            "type": "boolean",
            "description": "Leave out the buyer's name and avatar.",
            "default": false
          },
          "includeProductRow": {
            "title": "✅ Product row",
            "type": "boolean",
            "description": "Save one row per product (title, image, average rating, star counts, positive/neutral/negative shares, review topics and attributes) in the Products table of the output.",
            "default": true
          },
          "maxConcurrency": {
            "title": "⚡ Max concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many review pages are loaded at the same time.",
            "default": 4
          },
          "maxRetries": {
            "title": "🔁 Max retries",
            "minimum": 4,
            "maximum": 10,
            "type": "integer",
            "description": "How many times a failed page is tried again. At least 4, so a blocked page can move from a direct connection to a datacenter proxy and then get 3 residential proxy tries.",
            "default": 5
          },
          "connectTimeoutSecs": {
            "title": "⏳ Connect timeout (seconds)",
            "minimum": 1,
            "type": "integer",
            "description": "How long to wait for a connection before trying again.",
            "default": 8
          },
          "requestTimeoutSecs": {
            "title": "⏳ Request timeout (seconds)",
            "minimum": 1,
            "type": "integer",
            "description": "How long to wait for one page in total.",
            "default": 30
          },
          "proxyConfiguration": {
            "title": "🌐 Proxy configuration",
            "type": "object",
            "description": "Proxy to start with. Without one, the actor connects directly and moves to a datacenter, then a residential proxy if the site blocks it."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}