{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Search Scraper: Products, Prices & Rank",
    "description": "Amazon search scraper for keyword and category results on any marketplace: position, organic rank, sponsored flag, title, ASIN, price, list price, rating, reviews, Prime, coupons, deals, badges and delivery. Every keyword's rank kept, each product charged once. No login.",
    "version": "0.1",
    "x-build-id": "vIv3fePKPSz4HOyNx"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/deepmine~amazon-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-deepmine-amazon-search-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/deepmine~amazon-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-deepmine-amazon-search-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/deepmine~amazon-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-deepmine-amazon-search-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": {
          "keywords": {
            "title": "🔍 Search keywords",
            "type": "array",
            "description": "What you'd type in Amazon's search box, one search per line (wireless earbuds, phone case...). Read on the marketplace below.",
            "items": {
              "type": "string"
            }
          },
          "searchUrls": {
            "title": "🔗 Search or category URLs",
            "type": "array",
            "description": "Amazon search pages (amazon.com/s?k=...) or category pages (amazon.com/b?node=...), copied from your browser with any filters or sort you set there: every parameter of the URL is kept. Any marketplace.",
            "items": {
              "type": "string"
            }
          },
          "domain": {
            "title": "🌍 Marketplace",
            "pattern": "^\\s*(https?://)?((www|smile|m)\\.)?amazon\\.[a-z.]{2,8}/?\\s*$",
            "type": "string",
            "description": "The Amazon site keywords are searched on. URLs keep their own site. Pick one, or type a host such as amazon.de or www.amazon.de.",
            "default": "www.amazon.com"
          },
          "maxItemsPerQuery": {
            "title": "📊 Results per search",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Each search stops after this many products (empty: 100). A product two searches return is one product, charged once (the second search goes on to fill its count); every search keeps its rank of it in the Rankings dataset."
          },
          "sponsoredResults": {
            "title": "📢 Include sponsored results (uses residential, extra charge)",
            "type": "boolean",
            "description": "Datacenter pages (the default) rarely show ads: turn this on to get the sponsored slots shoppers see (+$0.79 per 1,000 products). Amazon shows sponsored slots to most home (residential) visitors and rarely to the datacenter IPs this Actor reads with by default. On: every results page is read over residential IPs, so ads are flagged isSponsored and counted in positions as a shopper sees them; when Amazon shows a page without ads, its rows have isSponsored false. The add-on (see Pricing) pays for the residential pages, so it's charged for every product while this is on, ads or not. Off: no add-on.",
            "default": false
          },
          "sort": {
            "title": "↕️ Sort by",
            "enum": [
              "relevance",
              "price-asc",
              "price-desc",
              "reviews",
              "newest",
              "best-sellers"
            ],
            "type": "string",
            "description": "Amazon's sort order (added to the search URL unless the URL sets its own).",
            "default": "relevance"
          },
          "minPrice": {
            "title": "⬇️ Minimum price",
            "minimum": 0,
            "maximum": 10000000,
            "type": "integer",
            "description": "Only products at or above this price, in the marketplace's currency (whole units). Products without a shown price are left out when a price filter is set."
          },
          "maxPrice": {
            "title": "⬆️ Maximum price",
            "minimum": 0,
            "maximum": 10000000,
            "type": "integer",
            "description": "Only products at or below this price, in the marketplace's currency (whole units)."
          },
          "minRating": {
            "title": "⭐ Minimum rating",
            "enum": [
              "4.5",
              "4",
              "3.5",
              "3",
              "2",
              "1"
            ],
            "type": "string",
            "description": "Only products rated at least this many stars. Products without a rating are left out."
          },
          "primeOnly": {
            "title": "✅ Prime only",
            "type": "boolean",
            "description": "Only products whose result card offers Prime delivery. A results page that shows no Prime signs gives none.",
            "default": false
          },
          "includeSponsored": {
            "title": "📢 Keep sponsored rows",
            "type": "boolean",
            "description": "On: sponsored (ad) results are rows too, flagged isSponsored. Off: only organic results. Positions and organic ranks are the same either way.",
            "default": true
          },
          "zipCode": {
            "title": "📍 Delivery postcode",
            "type": "string",
            "description": "Read prices and delivery 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 shipping prices, e.g. DE on amazon.com. Empty = the marketplace's own country. Not used with a postcode."
          },
          "maxPagesPerQuery": {
            "title": "📄 Max pages per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Each search reads at most this many results pages, about 16-48 products each (empty: 20)."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Leave as is: Apify datacenter proxies work for Amazon. Residential is replaced by datacenter (for results pages with sponsored slots, turn on Include sponsored results).",
            "default": {
              "useApifyProxy": true
            }
          },
          "maxItemsPerStartUrl": {
            "title": "Results per URL",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Same as Results per search (the Amazon Scraper's key). Both given: the lower one."
          },
          "maxSearchPagesPerStartUrl": {
            "title": "Pages per URL",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Same as Max pages per search (the Amazon Scraper's key). Both given: the lower one."
          },
          "scrapeProductDetails": {
            "title": "Product details",
            "type": "boolean",
            "description": "Kept for saved Amazon Scraper inputs: product pages aren't read here (the run log says so); use the Amazon Scraper for full details."
          },
          "maxConcurrency": {
            "title": "Concurrency",
            "minimum": 1,
            "maximum": 32,
            "type": "integer",
            "description": "Engine setting.",
            "default": 12
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Kept for saved inputs: rows are read from Amazon's English pages where the marketplace has them."
          },
          "useCaptchaSolver": {
            "title": "Captcha solver",
            "type": "boolean",
            "description": "Kept for saved 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}