{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Scraper — Products, Offers & Bestsellers",
    "description": "Scrape Amazon product details, all offers and sellers, search results, seller profiles and Best Sellers ranks on 23 marketplaces. USD 2.50 per 1,000 rows.",
    "version": "1.0",
    "x-build-id": "QlTHeHFoUiHUBaYCZ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/muhammadafzal~amazon-product-offers-bestsellers-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-muhammadafzal-amazon-product-offers-bestsellers-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/muhammadafzal~amazon-product-offers-bestsellers-scraper/runs": {
      "post": {
        "operationId": "runs-sync-muhammadafzal-amazon-product-offers-bestsellers-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/muhammadafzal~amazon-product-offers-bestsellers-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-muhammadafzal-amazon-product-offers-bestsellers-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": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "What to scrape",
            "enum": [
              "product",
              "offers",
              "search",
              "sellers",
              "bestsellers"
            ],
            "type": "string",
            "description": "Use this to choose the data you want. product: full product details for each ASIN or product link. offers: every seller offer (price, condition, shipping, seller rating) for each ASIN. search: the products Amazon lists for each keyword, with prices and sponsored flags. sellers: a seller's profile page (name, business name and address, description). bestsellers: the Best Sellers ranking (top 100) of each category. Each mode reads only its own list below.",
            "default": "product"
          },
          "asins": {
            "title": "ASINs",
            "type": "array",
            "description": "Use this in product or offers mode. Amazon product IDs (ASINs): 10 letters and digits, for example B09B8V1LZ3, or a 10-digit ISBN for books. Up to 500 per run, together with product links. Entries that are not ASINs are skipped before any request and listed in OUTPUT.",
            "items": {
              "type": "string"
            }
          },
          "productUrls": {
            "title": "Product links",
            "type": "array",
            "description": "Use this in product mode when you have Amazon product page links instead of ASINs, for example https://www.amazon.com/dp/B09B8V1LZ3. The link's storefront is used, so links from different Amazon countries can be mixed. Search and category links are not product links: use search or bestsellers mode for those.",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Use this in search mode. Keywords exactly as a shopper types them in the Amazon search box, for example wireless earbuds. Up to 50 per run. A product found under several keywords is returned once.",
            "items": {
              "type": "string"
            }
          },
          "sellerIds": {
            "title": "Seller IDs",
            "type": "array",
            "description": "Use this in sellers mode. Amazon seller IDs (start with A, for example A2L77EE7U53NWQ) or seller page links such as https://www.amazon.com/sp?seller=A2L77EE7U53NWQ (a link is read on its own storefront). Offers mode returns the seller ID of every offer. Up to 500 per run.",
            "items": {
              "type": "string"
            }
          },
          "categoryIds": {
            "title": "Best Sellers category IDs",
            "type": "array",
            "description": "Use this in bestsellers mode. The category number from a Best Sellers link, for example 172282 for Electronics on amazon.com, or the whole link such as https://www.amazon.com/Best-Sellers-Electronics/zgbs/electronics/172282 (a link is read on its own storefront; category numbers differ between storefronts). Each category gives up to 100 ranked products (2 pages). Up to 50 per run. Top-level links without a number (…/zgbs/electronics) are not accepted; open a subcategory or copy its number.",
            "items": {
              "type": "string"
            }
          },
          "marketplace": {
            "title": "Amazon marketplace",
            "enum": [
              "com",
              "ca",
              "com.mx",
              "com.br",
              "co.uk",
              "ie",
              "de",
              "fr",
              "it",
              "es",
              "nl",
              "com.be",
              "se",
              "pl",
              "com.tr",
              "ae",
              "sa",
              "eg",
              "in",
              "co.jp",
              "sg",
              "com.au",
              "co.za"
            ],
            "type": "string",
            "description": "Which Amazon storefront to read ASINs, keywords, seller IDs and category IDs on. Prices come in that storefront's currency. Product, seller and Best Sellers links always use their own storefront.",
            "default": "com"
          },
          "postalCode": {
            "title": "Delivery ZIP or postal code",
            "maxLength": 40,
            "type": "string",
            "description": "Optional. Use this when prices, stock or delivery dates must match a buyer location, for example 10001 (New York) on amazon.com, SW1A 1AA on amazon.co.uk or 10115 on amazon.de. amazon.ae and amazon.co.za take a city name (Dubai, Johannesburg); amazon.com.tr takes none. Left empty, Amazon uses its default delivery location for the marketplace, which can change between runs."
          },
          "currency": {
            "title": "Currency",
            "maxLength": 3,
            "type": "string",
            "description": "Optional. A currency the marketplace offers for display, for example EUR on amazon.co.uk. Left empty, prices come in the marketplace's own currency (USD on amazon.com)."
          },
          "sortBy": {
            "title": "Sort search results by",
            "enum": [
              "featured",
              "price_low_to_high",
              "price_high_to_low",
              "average_review",
              "most_recent",
              "bestsellers"
            ],
            "type": "string",
            "description": "Search mode only. The order Amazon lists results in. Left empty, Amazon's default order (featured) is used."
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "number",
            "description": "Search mode only. Lowest price to include, in the marketplace currency, for example 25 or 19.99."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "number",
            "description": "Search mode only. Highest price to include, in the marketplace currency."
          },
          "maxPages": {
            "title": "Pages per keyword, ASIN or category",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Search, offers and bestsellers modes. How many result pages to read for each input: a search page lists about 20 to 80 products, an offers page 10 offers, a Best Sellers page 50 products (2 pages = top 100). Reading stops early when Amazon has no more pages. Each page read is one request, so more pages cost more only when they return rows.",
            "default": 1
          },
          "maxResults": {
            "title": "Maximum rows",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "The run stops after this many dataset rows (products, offers, search results, sellers or Best Sellers entries). You pay only for rows delivered.",
            "default": 1000
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}