{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Best Sellers Scraper",
    "description": "Amazon Best Sellers and New Releases: all 100 ranks of any category, its subcategories to any depth, ten marketplaces. ASIN, title, price, rating, reviews, author, format, image, category path. No browser, no login, pay per product.",
    "version": "1.0",
    "x-build-id": "CkKlyvnqAqEcadXax"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/steadyscrape~amazon-bestsellers-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-steadyscrape-amazon-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/steadyscrape~amazon-bestsellers-scraper/runs": {
      "post": {
        "operationId": "runs-sync-steadyscrape-amazon-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/steadyscrape~amazon-bestsellers-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-steadyscrape-amazon-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",
        "properties": {
          "categories": {
            "title": "Categories",
            "type": "array",
            "description": "One category per line: any Amazon Best Sellers or New Releases link (<code>https://www.amazon.com/gp/bestsellers/books</code>, <code>https://www.amazon.com/Best-Sellers-Kitchen-Dining/zgbs/kitchen</code>, a link copied from the site's category menu), or a department with an optional node (<code>electronics</code>, <code>books/5267710011</code>) on the marketplace below. A link's domain picks its marketplace. Leave it empty to read every department of the marketplace.",
            "items": {
              "type": "string"
            }
          },
          "lists": {
            "title": "Charts",
            "type": "array",
            "description": "Which charts to read for each category. Movers & Shakers, Most Wished For and Gift Ideas are left out: Amazon currently shows them empty to visitors.",
            "items": {
              "type": "string",
              "enum": [
                "bestsellers",
                "new-releases"
              ],
              "enumTitles": [
                "Best Sellers",
                "New Releases"
              ]
            },
            "default": [
              "bestsellers"
            ]
          },
          "maxProductsPerList": {
            "title": "Products per chart",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many ranks to read from each chart, from #1 down. Amazon's charts end at 100.",
            "default": 100
          },
          "subcategoryDepth": {
            "title": "Subcategory depth",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "0 reads only the categories above; 1 also reads every subcategory their menu lists; 2 the subcategories of those, and so on.",
            "default": 0
          },
          "maxCategories": {
            "title": "Max categories",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "The most categories one run reads, the ones above and their subcategories together. A department at depth 2 can hold several hundred.",
            "default": 100
          },
          "marketplace": {
            "title": "Marketplace for department names",
            "enum": [
              "com",
              "ca",
              "com.mx",
              "com.br",
              "co.uk",
              "de",
              "fr",
              "it",
              "es",
              "nl",
              "com.be",
              "ie",
              "se",
              "pl",
              "com.tr",
              "co.jp",
              "in",
              "com.au",
              "sg",
              "ae",
              "sa",
              "eg"
            ],
            "type": "string",
            "description": "Where a department without a link (<code>books</code>) is read, and whose departments an empty Categories reads. Measured from Apify's cloud on 2026-10-19: .com, .ca, .com.mx, .com.br, .es, .fr, .it, .in, .co.jp and .com.au answer directly, .co.uk and .de through residential proxies of their country. Department names differ by marketplace (electronics is <code>ce-de</code> on amazon.de): a link copied from Amazon's menu always works.",
            "default": "com"
          },
          "residentialFallback": {
            "title": "Fall back to residential proxies",
            "type": "boolean",
            "description": "When Amazon refuses the run's own IP and the datacenter proxies, retry through residential proxies (included in the price: you pay per product, not per proxy byte). Off: those charts come back with status <code>blocked</code>, unpaid.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}