{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Product Scraper API",
    "description": "Scrape Amazon products from search, category and product URLs across 23 marketplaces. Pricing is localized to the delivery location you choose, so a ZIP code, a region or a whole country each return what a buyer there actually pays.",
    "version": "0.1",
    "x-build-id": "ik1Gz29KliJbl0gEu"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/shakamize~amazon-product-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-shakamize-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/shakamize~amazon-product-scraper/runs": {
      "post": {
        "operationId": "runs-sync-shakamize-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/shakamize~amazon-product-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-shakamize-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",
        "required": [
          "categoryOrProductUrls"
        ],
        "properties": {
          "categoryOrProductUrls": {
            "title": "Amazon search, category or product URLs",
            "type": "array",
            "description": "Search result pages, category pages or product detail pages. Bare ASINs are accepted too. Example: https://www.amazon.com/s?k=microsd+card or https://www.amazon.com/dp/B09X7MPX8L",
            "items": {
              "type": "string"
            }
          },
          "maxItemsPerStartUrl": {
            "title": "Max results (per start URL)",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many products for each start URL. Leave empty for no limit, which on a broad search means every page of results."
          },
          "maxSearchPagesPerStartUrl": {
            "title": "Max search pages (per start URL)",
            "minimum": 1,
            "type": "integer",
            "description": "How many pages of a search or category listing to walk before stopping.",
            "default": 9999
          },
          "scrapeProductDetails": {
            "title": "Open each product page",
            "type": "boolean",
            "description": "On by default. Turn it off to keep only the summary fields shown on the listing page, which is faster and billed at the lower listing-only rate.",
            "default": true
          },
          "countryCode": {
            "title": "Delivery country",
            "enum": [
              "AE",
              "AU",
              "BE",
              "BR",
              "CA",
              "DE",
              "EG",
              "ES",
              "FR",
              "GB",
              "IE",
              "IN",
              "IT",
              "JP",
              "MX",
              "NL",
              "PL",
              "SA",
              "SE",
              "SG",
              "TR",
              "US",
              "ZA"
            ],
            "type": "string",
            "description": "The country to receive prices for. Amazon prices and availability depend on where the order would ship, so this changes the numbers you get back."
          },
          "zipCode": {
            "title": "Delivery ZIP / postal code",
            "type": "string",
            "description": "A postal code within the delivery country, for prices that match a specific address. This is the setting that makes the scraped price match what a buyer at that address sees."
          },
          "locationDeliverableRoutes": {
            "title": "Apply the delivery location to",
            "type": "array",
            "description": "Which page types the delivery location is applied to. Applying it to fewer page types is faster.",
            "items": {
              "type": "string",
              "enum": [
                "PRODUCT",
                "SEARCH",
                "OFFERS"
              ]
            },
            "default": [
              "PRODUCT",
              "SEARCH",
              "OFFERS"
            ]
          },
          "language": {
            "title": "Language",
            "enum": [
              "ar",
              "bn",
              "cs",
              "da",
              "de",
              "en",
              "es",
              "fr",
              "he",
              "hi",
              "it",
              "ja",
              "kn",
              "ko",
              "ml",
              "mr",
              "nl",
              "pl",
              "pt",
              "ru",
              "sv",
              "ta",
              "te",
              "tr",
              "uk",
              "zh_CN"
            ],
            "type": "string",
            "description": "Language to read Amazon in. Each marketplace supports a different set; an unsupported choice falls back to that marketplace default rather than failing."
          },
          "proxyCountry": {
            "title": "Proxy country",
            "enum": [
              "AUTO_SELECT_PROXY_COUNTRY",
              "AE",
              "AU",
              "BE",
              "BR",
              "CA",
              "DE",
              "EG",
              "ES",
              "FR",
              "GB",
              "IE",
              "IN",
              "IT",
              "JP",
              "MX",
              "NL",
              "PL",
              "SA",
              "SE",
              "SG",
              "TR",
              "US",
              "ZA"
            ],
            "type": "string",
            "description": "Country to route requests through. Leave on AUTO when using a ZIP code: an exit inside the marketplace country makes Amazon resolve its own location and refuse to hand over the token needed to change it.",
            "default": "AUTO_SELECT_PROXY_COUNTRY"
          },
          "maxProductVariantsAsSeparateResults": {
            "title": "Max variants as separate results",
            "minimum": 0,
            "type": "integer",
            "description": "Scrape this many variants of each product as full products of their own. 0 keeps only the parent.",
            "default": 0
          },
          "scrapeProductVariantPrices": {
            "title": "Price every variant",
            "type": "boolean",
            "description": "Emit a price for each variant of a product. Variant prices are fetched independently, so a variant that cannot be loaded never removes the parent product from your results.",
            "default": false
          },
          "maxOffers": {
            "title": "Max offers per product",
            "minimum": 0,
            "type": "integer",
            "description": "Also collect competing offers for each product. 0 collects none.",
            "default": 0
          },
          "scrapeSellers": {
            "title": "Include seller details",
            "type": "boolean",
            "description": "Attach seller information to each collected offer.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify residential proxy is required in practice: Amazon serves an anti-bot interstitial to unproxied traffic and blocks datacenter addresses after roughly one request.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}