{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Product Search Scraper & API - Prices, ASINs, Ranks",
    "description": "Amazon product scraper and search API: search Amazon by keyword or URL on any marketplace (.com, .co.uk, .de, .co.jp, .in...). One row per product: rank, ASIN, title, price, list price, rating, ratings count, bought last month, sponsored/badge flags, URL. Optional details. $2.00 per 1,000 results.",
    "version": "1.0",
    "x-build-id": "Kg2DFf1saWPO3mDY3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rel8ble~amazon-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rel8ble-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/rel8ble~amazon-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-rel8ble-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/rel8ble~amazon-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-rel8ble-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": "Provide these or searchUrls. One search per line, written as you would type it into Amazon's search box: \"wireless earbuds\", \"standing desk\", \"nike running shoes men\". Each keyword is searched on the marketplace in domain, within department, sorted by sort, and returns up to maxItemsPerSearch products. Default [\"wireless earbuds\"] (demo).",
            "items": {
              "type": "string"
            }
          },
          "searchUrls": {
            "title": "Amazon search or category URLs (alternative to keywords)",
            "type": "array",
            "description": "Optional. Full Amazon search result URLs from any marketplace, one per line, with any filters already applied (price, brand, Prime, rating, category node...), e.g. https://www.amazon.de/s?k=kopfh%C3%B6rer&i=electronics&rh=p_36%3A2000-5000. Each URL carries its own marketplace and filters; domain, department, sort and price settings do not apply to them.",
            "items": {
              "type": "string"
            }
          },
          "domain": {
            "title": "Marketplace domain (for keywords)",
            "type": "string",
            "description": "Optional. Amazon marketplace used for keywords: \"amazon.com\", \"amazon.co.uk\", \"amazon.de\", \"amazon.fr\", \"amazon.it\", \"amazon.es\", \"amazon.ca\", \"amazon.com.au\", \"amazon.co.jp\", \"amazon.in\", \"amazon.com.mx\", \"amazon.com.br\", \"amazon.nl\", \"amazon.se\", \"amazon.pl\", \"amazon.sg\", \"amazon.ae\", \"amazon.sa\", \"amazon.eg\", \"amazon.com.tr\", \"amazon.be\", \"amazon.ie\". Default \"amazon.com\". Prices come back in the marketplace currency.",
            "default": "amazon.com"
          },
          "department": {
            "title": "Department (for keywords)",
            "type": "string",
            "description": "Optional. Amazon department alias to search within (the \"i=\" parameter): \"aps\" (All, default), \"electronics\", \"computers\", \"fashion\", \"beauty\", \"hpc\" (health), \"home-garden\" or \"garden\", \"kitchen\", \"toys-and-games\", \"sporting\", \"automotive\", \"pets\", \"grocery\", \"office-products\", \"tools\", \"stripbooks\" (books), \"videogames\", \"baby-products\", \"luggage\", \"industrial\", \"appliances\", \"arts-crafts\", \"software\", \"music\", \"movies-tv\", \"pet-supplies\". Any alias Amazon accepts works.",
            "default": "aps"
          },
          "sort": {
            "title": "Sort order (for keywords)",
            "enum": [
              "relevance",
              "price-asc",
              "price-desc",
              "reviews",
              "newest",
              "bestsellers"
            ],
            "type": "string",
            "description": "Optional. \"relevance\" (Amazon's default ranking), \"price-asc\", \"price-desc\", \"reviews\" (average review), \"newest\" (newest arrivals), \"bestsellers\" (best sellers). Default \"relevance\".",
            "default": "relevance"
          },
          "minPrice": {
            "title": "Min price (for keywords)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Lowest price in the marketplace's currency, whole units (e.g. 20 for $20 / 20 EUR). Leave empty for no minimum."
          },
          "maxPrice": {
            "title": "Max price (for keywords)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Highest price in the marketplace's currency, whole units (e.g. 100). Leave empty for no maximum."
          },
          "maxItemsPerSearch": {
            "title": "Max products per search",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Optional. Products to save per keyword or URL, integer 1-500. Default 50. Amazon returns 16-60 products per page and up to about 7 pages (300+ products) per search; set 20 for a quick answer, 300 for everything. Sponsored and organic results count together.",
            "default": 50
          },
          "includeSponsored": {
            "title": "Include sponsored products",
            "type": "boolean",
            "description": "Optional boolean. true (default) = keep sponsored (ad) listings too, flagged with isSponsored: true and organicPosition: null. false = organic results only.",
            "default": true
          },
          "includeDetails": {
            "title": "Open each product page (details)",
            "type": "boolean",
            "description": "Optional boolean. true = also open every product's page and add a details object: brand, bullet points, description, availability, seller, ships from, Best Sellers Rank per category, category path, all images, specs (dimensions, weight, model number, date first available), variations. Costs one extra request per product (still one result) and makes the run several times slower. Default false.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Optional, advanced. Parallel requests, integer 1-20. Default 5. Keep it low; Amazon rate-limits aggressively.",
            "default": 5
          },
          "maxRequestRetries": {
            "title": "Max retries per request",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Optional, advanced. Retries per blocked or failed request, integer 0-20; each retry uses a new proxy session. Default 8.",
            "default": 8
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional, advanced. Apify Proxy settings object. Default: Apify residential proxies in the marketplace's country, which Amazon rarely blocks and which return local prices and delivery dates. Datacenter proxies ({\"useApifyProxy\": true}) work but see more captchas and retries.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}