{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Best Sellers Rank Tracker: BSR & Top 100",
    "description": "Amazon best sellers rank tracker: the top 100 ranks of any Best Sellers, New Releases, Movers & Shakers, Most Wished For or Gift Ideas list, with ASIN, price, rating, reviews and subcategories, on any Amazon marketplace. Schedule it to track Amazon bestsellers over time. No login.",
    "version": "0.1",
    "x-build-id": "KfamsMzkjHgY0brpM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/deepmine~amazon-best-sellers-rank-tracker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-deepmine-amazon-best-sellers-rank-tracker",
        "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/deepmine~amazon-best-sellers-rank-tracker/runs": {
      "post": {
        "operationId": "runs-sync-deepmine-amazon-best-sellers-rank-tracker",
        "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/deepmine~amazon-best-sellers-rank-tracker/run-sync": {
      "post": {
        "operationId": "run-sync-deepmine-amazon-best-sellers-rank-tracker",
        "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": {
          "categoryUrls": {
            "title": "🔗 Best seller lists (URLs or categories)",
            "type": "array",
            "description": "Any Best Sellers, New Releases, Movers & Shakers, Most Wished For or Gift Ideas list URL, one per line, on any Amazon site. Or just a category (electronics, books/4), read on the marketplace and chart below.",
            "items": {
              "type": "string"
            }
          },
          "maxItemsPerStartUrl": {
            "title": "📊 Products per list",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Top N ranks of each list (Amazon ranks 100). A product several lists rank is charged once; the free Rankings dataset keeps every rank.",
            "default": 100
          },
          "depthOfCrawl": {
            "title": "🗂️ Subcategory levels",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "1 = only the lists you give. 2 = also each list's subcategories (Electronics → Headphones, Camera & Photo...), 3 = their subcategories too, and so on, up to Max lists.",
            "default": 1
          },
          "domain": {
            "title": "🌍 Marketplace for categories",
            "pattern": "^\\s*(https?://)?((www|smile|m)\\.)?amazon\\.[a-z.]{2,8}/?\\s*$",
            "type": "string",
            "description": "The Amazon site a category typed without a URL is read on. URLs keep their own site. Pick one, or type a host such as amazon.de or www.amazon.de.",
            "default": "www.amazon.com"
          },
          "listType": {
            "title": "📑 Chart for categories",
            "enum": [
              "bestsellers",
              "new-releases",
              "movers-and-shakers",
              "most-wished-for",
              "most-gifted"
            ],
            "type": "string",
            "description": "Which ranked list a category typed without a URL is read from.",
            "default": "bestsellers"
          },
          "maxCategories": {
            "title": "🗂️ Max lists",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "With Subcategory levels above 1: no more subcategories are added once the run has this many lists (the lists you give are always read).",
            "default": 1000
          },
          "zipCode": {
            "title": "📍 Delivery postcode",
            "type": "string",
            "description": "Read the lists' prices for this postcode, e.g. 10001 (amazon.com) or 10115 (amazon.de). Empty = each marketplace's capital; amazon.com uses the proxy's US location. The run stops if Amazon rejects it."
          },
          "countryCode": {
            "title": "🌐 Deliver to country",
            "type": "string",
            "description": "Two-letter country to deliver to, for international prices, e.g. DE on amazon.com. Empty = the marketplace's own country. Not used with a postcode. In another country most list cards show their offer count and lowest offer ('15 offers from $17.87')."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Leave as is: Apify datacenter proxies work for Amazon lists. Residential is replaced by datacenter (it costs more per page than a row earns).",
            "default": {
              "useApifyProxy": true
            }
          },
          "detailedInformation": {
            "title": "Full product details",
            "type": "boolean",
            "description": "Kept for saved junglee/amazon-bestsellers inputs: this Actor reads the lists only (the Amazon Best Sellers Scraper reads full details). True is noted in the run summary."
          },
          "maxConcurrency": {
            "title": "Concurrency",
            "minimum": 1,
            "maximum": 32,
            "type": "integer",
            "description": "Engine setting.",
            "default": 12
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Kept for saved junglee/amazon-bestsellers inputs: rows are read from Amazon's English pages."
          },
          "useCaptchaSolver": {
            "title": "Captcha solver",
            "type": "boolean",
            "description": "Kept for saved junglee/amazon-bestsellers inputs: not needed (a refused page is retried on a new IP)."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}