{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Search Scraper — Search Results, Keyword Rank & Prices",
    "description": "Amazon search results by keyword in 20 marketplaces, plus Best Sellers and New Releases charts. One row per product: ASIN, title, price, rating, ratings count, image, sponsored flag, position on the page, chart rank. Free filters: skip sponsored (organic rank), min rating, department.",
    "version": "1.4",
    "x-build-id": "Wzep7xPbhNAjFWHAM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/kestrel~amazon-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-kestrel-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/kestrel~amazon-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-kestrel-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/kestrel~amazon-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-kestrel-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": {
          "queries": {
            "title": "Search keywords",
            "uniqueItems": true,
            "type": "array",
            "description": "Search keywords exactly as a shopper types them, e.g. [\"wireless earbuds\", \"cast iron skillet\"]. Each keyword is searched over `pages` result pages (about 20 organic products plus sponsored ones per page, $0.004 per row). Use for \"search results for X\", \"where does ASIN Y rank for X\" (read `position`; organic rank with skipSponsored), \"prices for X\", competitor listings. A keyword with no results costs nothing. Either queries or categories is required.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "domain": {
            "title": "Marketplace",
            "type": "string",
            "description": "Marketplace, e.g. \"de\" for amazon.de. Default \"com\". One of: com, co.uk, de, fr, it, es, ca, com.au, co.jp, in, com.mx, com.br, nl, se, pl, sa, ae, sg, com.tr, com.be. Rank and price differ per marketplace, so run each marketplace as its own run; prices come in the marketplace's currency.",
            "default": "com"
          },
          "department": {
            "title": "Search department",
            "type": "string",
            "description": "Department to search inside, Amazon's own slug as in the search URL's i= parameter, e.g. \"electronics\", \"kitchen\", \"books\". Empty (default) = all departments. Use when the user names a department (\"in Electronics\").",
            "default": ""
          },
          "pages": {
            "title": "Pages per keyword or category",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Result pages per keyword or category, 1 to 20, e.g. 3 (default 1). A search page is about 20 organic products plus sponsored ones; a chart page 30. Walking stops early when a page adds nothing new. Cost = pages × rows per page × $0.004: 3 keywords × 2 pages is a little over 100 rows.",
            "default": 1
          },
          "maxResultsPerQuery": {
            "title": "Max products per keyword or category",
            "minimum": 0,
            "maximum": 2000,
            "type": "integer",
            "description": "0 (default) = everything the pages returned. N = only the first N per keyword or category in Amazon's order, e.g. 10 for \"the top 10 results for X\". Applied after skipSponsored and minRating. Rows beyond N are never charged.",
            "default": 0
          },
          "skipSponsored": {
            "title": "Skip sponsored results",
            "type": "boolean",
            "description": "true = drop sponsored (ad) placements before billing and keep organic results only: the honest keyword rank. Default false (sponsored rows are delivered with sponsored: true, in the slot a shopper sees). Use for \"organic rank\", \"where do we rank excluding ads\".",
            "default": false
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Keep only products rated at or above this, e.g. 4 or 4.5. 0 (default) = every product. Products without a rating are dropped too. Filtered rows are never charged.",
            "default": 0
          },
          "categories": {
            "title": "Category charts",
            "uniqueItems": true,
            "type": "array",
            "description": "Category slugs to pull a chart for instead of (or as well as) keywords, e.g. [\"electronics\", \"kitchen\", \"books\"]: the segment after /gp/bestsellers/ in a Best Sellers URL. A chart page renders 30 of its 50 entries; for every rank of the Top 100 use kestrel/amazon-best-sellers-scraper. Empty (default) = no charts.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "chart": {
            "title": "Chart type",
            "enum": [
              "bestsellers",
              "new_releases"
            ],
            "type": "string",
            "description": "\"bestsellers\" (default) or \"new_releases\": which chart to pull for each category above. Ignored for keyword searches. Movers & Shakers is not available (Amazon renders it client-side; the page carries no products).",
            "default": "bestsellers"
          },
          "sessions": {
            "title": "Parallel sessions",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "Parallel proxy sessions (one egress IP each), 1 to 16, e.g. 4 (default 4). More is faster for long keyword lists; each session is paced separately.",
            "default": 4
          },
          "perIp": {
            "title": "Requests per second per IP",
            "minimum": 0.1,
            "maximum": 2,
            "type": "number",
            "description": "Requests per second per session, 0.1 to 2 (default 0.5). Amazon tolerates about 0.5/s per IP; faster causes captchas, not speed. Leave the default.",
            "default": 0.5
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify Proxy, default {\"useApifyProxy\": true} (datacentre). Required: Amazon captchas unrotated datacentre traffic and refuses search pages from whole datacentre ranges for minutes at a time; the run rotates the IP on a captcha or 503 and after two refusals in a row moves to residential proxies by itself. Pass {\"useApifyProxy\": true, \"apifyProxyGroups\": [\"RESIDENTIAL\"]} for the most reliable runs.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}