{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Product Scraper: Prices by ZIP Code, Full Search",
    "description": "Scrape Amazon.com and Amazon.de products from searches, categories, URLs or ASINs: price, delivery for your ZIP code at no extra cost, seller, rating, bought past month, best sellers rank, AI review summary. Full coverage reads past the 7-page limit. No login, no browser.",
    "version": "0.1",
    "x-build-id": "L2Nmb9d7JNvpPR4Dn"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/alexmorain~amazon-product-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-alexmorain-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/alexmorain~amazon-product-scraper/runs": {
      "post": {
        "operationId": "runs-sync-alexmorain-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/alexmorain~amazon-product-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-alexmorain-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": {
          "searchQueries": {
            "title": "Search terms",
            "type": "array",
            "description": "One per line, as you would type them in the Amazon search box. Each search returns up to <b>Max products per search</b> unique products on the marketplace chosen below.",
            "items": {
              "type": "string"
            }
          },
          "productUrls": {
            "title": "Product URLs or ASINs",
            "type": "array",
            "description": "One per line: a product URL (<code>https://www.amazon.com/dp/B07S98411N</code>, amazon.com or amazon.de) or a bare ASIN (<code>B07S98411N</code>, read on the marketplace chosen below). Each product page is read in full. A product that no longer exists is reported in the log and not charged.",
            "items": {
              "type": "string"
            }
          },
          "categoryUrls": {
            "title": "Category or search result URLs",
            "type": "array",
            "description": "One per line: a category page (<code>https://www.amazon.com/b?node=289745</code>) or a search result page with its filters (<code>https://www.amazon.com/s?k=kettle&rh=n%3A289745</code>). The marketplace (amazon.com or amazon.de) is read from the URL. Best sellers pages are not supported yet.",
            "items": {
              "type": "string"
            }
          },
          "marketplace": {
            "title": "Marketplace",
            "enum": [
              "com",
              "de"
            ],
            "type": "string",
            "description": "Used for search terms and bare ASINs. URLs keep their own marketplace. Other Amazon marketplaces are not supported yet: their search pages answer with a JavaScript challenge that this Actor does not run.",
            "default": "com"
          },
          "zipCode": {
            "title": "Delivery postcode",
            "type": "string",
            "description": "Prices, availability and delivery dates are those Amazon shows for this postcode, for example <code>90210</code> or <code>99501</code> on amazon.com. Included in the price, no extra charge. Leave empty for the marketplace's capital (New York 10001 on amazon.com, 10115 Berlin on amazon.de). Each product row says the location actually applied in <code>deliverTo</code>, and the run fails rather than return prices for another place if Amazon refuses the postcode."
          },
          "maxItemsPerSearch": {
            "title": "Max products per search",
            "minimum": 0,
            "type": "integer",
            "description": "Stop each search term or category after this many unique products. <code>0</code> means no limit. A product is counted and charged once per search, even when it shows up on several pages.",
            "default": 100
          },
          "fullCoverage": {
            "title": "Full coverage (past the 7-page limit)",
            "type": "boolean",
            "description": "Amazon serves 7 pages per search whatever the number of results it announces, about 300 products for <code>coffee maker</code> out of \"over 40,000\". With this on, the search is split into price bands, each with its own 7 pages, and bands that are still full are split again. Measured on <code>coffee maker</code>: 113,802 unique products in 40 minutes instead of 281. Most of the extra products are the long tail Amazon attaches to the query (carafes, filters, spare parts), so keep <b>Max products per search</b> set unless you want all of it. Products are deduplicated, so a product found in two bands is charged once. Products without a price only appear in the first 7 pages.",
            "default": false
          },
          "includeDetails": {
            "title": "Include product page details",
            "type": "boolean",
            "description": "For search results, also read each product's page: delivery date and price for your postcode, seller and who ships it, best sellers rank, star histogram, AI review summary, review aspects (each with positive and negative mention counts), top reviews shown on the page (about 10 to 13 on amazon.de, none on amazon.com where Amazon requires sign-in), features, attributes, variants and all images. Charged as a detailed product instead of a product. Product URLs and ASINs always come with these fields.",
            "default": false
          },
          "includeSponsored": {
            "title": "Include sponsored results",
            "type": "boolean",
            "description": "Sponsored products are part of what a shopper sees and are flagged with <code>sponsored: true</code>. Turn off to keep organic results only.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Leave as is. Product pages go through Apify datacenter proxies with one IP per session; search pages fall back to residential IPs when Amazon refuses datacenter ones, at the Actor's own cost. The price per product is the same whatever you choose.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}