{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Scraper - Products, Best Sellers & Price Tracker",
    "description": "Amazon product data from 20 Amazon sites: price, list price, stock, rating, reviews, Best Sellers Rank, bought in past month, seller, variations. Search and Best Sellers lists. Price, stock and rank tracking. $3 per 1,000 products, failed pages free.",
    "version": "0.1",
    "x-build-id": "PXCaQ2BN5nYEzRxFr"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tidytools~amazon-product-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tidytools-amazon-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/tidytools~amazon-product-scraper/runs": {
      "post": {
        "operationId": "runs-sync-tidytools-amazon-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/tidytools~amazon-product-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-tidytools-amazon-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",
        "properties": {
          "urls": {
            "title": "Amazon URLs or ASINs",
            "type": "array",
            "description": "JSON array of Amazon product URLs, bare ASINs, search URLs or list URLs, e.g. {\"urls\":[\"B079M8FPTW\",\"https://www.amazon.de/s?k=coffee\"]}; enter one per line in the form. Accepts Best Sellers, New Releases, Movers & Shakers, Most Wished For and Gift Ideas lists. Bare ASINs use the marketplace setting. Tabs, semicolons and comma/space-separated ASINs or links work. Duplicate targets run once; invalid lines are free invalid_input rows.",
            "items": {
              "type": "string"
            }
          },
          "searchTerms": {
            "title": "Search terms (optional)",
            "type": "array",
            "description": "Keywords to search on the marketplace below, one per line; each result is one row with its position.",
            "items": {
              "type": "string"
            }
          },
          "marketplace": {
            "title": "Marketplace",
            "enum": [
              "com",
              "ca",
              "com.mx",
              "com.br",
              "co.uk",
              "de",
              "fr",
              "it",
              "es",
              "nl",
              "com.be",
              "se",
              "pl",
              "com.tr",
              "ae",
              "sa",
              "in",
              "co.jp",
              "com.au",
              "sg"
            ],
            "type": "string",
            "description": "For bare ASINs and search terms. URLs keep their own Amazon site.",
            "default": "com"
          },
          "maxResultsPerInput": {
            "title": "Max rows per search or list",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Search results (about 16-60 per page) or list positions (a best-seller list has 50 per page, 100 in total) per input.",
            "default": 50
          },
          "maxItems": {
            "title": "Max rows per run",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "The run stops after this many charged rows. With the maximum charge per run, this caps the cost.",
            "default": 1000
          },
          "productDetails": {
            "title": "Product details for search and list rows",
            "type": "boolean",
            "description": "Open the product page of every search result and list position: full details (brand, list price, stock, seller, Best Sellers Rank, bought in past month, features, images, variations, specs). Each one is charged as a product instead of a list row.",
            "default": false
          },
          "includeSponsored": {
            "title": "Include sponsored search results",
            "type": "boolean",
            "description": "Sponsored (ad) results are marked sponsored: true. Off = skipped (free) and they do not use up the rows per search.",
            "default": true
          },
          "includeDescription": {
            "title": "Include product description",
            "type": "boolean",
            "description": "Add the product description text (up to 5,000 characters) to product rows.",
            "default": false
          },
          "trackChanges": {
            "title": "Track price, stock and rank changes",
            "type": "boolean",
            "description": "Compare with the previous run of the same monitor (schedule this Actor daily or hourly): price drop or increase with the old price, back in stock / out of stock, Best Sellers Rank or list rank up or down, seller changed, new entries and products that dropped out of a list. Unchanged products cost a reduced check fee; unchanged list rows are free.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Name of the saved history (letters, digits, dashes). Use one name per product list or schedule; empty = derived from the first input.",
            "default": ""
          },
          "onlyChanges": {
            "title": "Output only changes",
            "type": "boolean",
            "description": "With tracking on: only new and changed rows (and products that dropped out of a list) are returned; unchanged ones are counted in the run summary.",
            "default": false
          },
          "httpVia": {
            "title": "Requests from",
            "enum": [
              "auto",
              "backend",
              "direct"
            ],
            "type": "string",
            "description": "Amazon answers some networks with a robot check. Auto reads from Apify's network first and retries through our Cloudflare route. Every route uses our honest TidyTools user agent and respects robots.txt; robot checks are never solved, the page is then a free \"blocked\" row.",
            "default": "auto"
          },
          "proxyConfiguration": {
            "title": "Proxy (optional)",
            "type": "object",
            "description": "Only used for requests sent from Apify's network. Apify proxy usage is billed to your Apify account."
          },
          "maxConcurrency": {
            "title": "Pages in parallel",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "How many pages are read at the same time. Requests to each Amazon site stay spaced out regardless; higher values mostly help with many sites at once.",
            "default": 4
          },
          "pageTimeoutSecs": {
            "title": "Time limit per page (seconds)",
            "minimum": 20,
            "maximum": 300,
            "type": "integer",
            "description": "A product that takes longer (all routes together) is reported as a timeout (free).",
            "default": 90
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}