{
  "openapi": "3.0.1",
  "info": {
    "title": "Free Amazon Search Results Scraper",
    "description": "Retrieve ranked Amazon product listings for any keyword or search URL, including titles, prices, ratings, Prime status, sponsored flags, images, and available filters for any marketplace.",
    "version": "1.0",
    "x-build-id": "3XdptfPgfL5abqrIL"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/easyparser~amazon-search-results/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-easyparser-amazon-search-results",
        "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/easyparser~amazon-search-results/runs": {
      "post": {
        "operationId": "runs-sync-easyparser-amazon-search-results",
        "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/easyparser~amazon-search-results/run-sync": {
      "post": {
        "operationId": "run-sync-easyparser-amazon-search-results",
        "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": [
          "domain"
        ],
        "properties": {
          "keyword": {
            "title": "Keyword",
            "type": "string",
            "description": "Search keyword to query on Amazon. Example: vacuum bottle. Use either keyword or url, not both."
          },
          "url": {
            "title": "Search URL (alternative to keyword)",
            "type": "string",
            "description": "Full Amazon search URL. Use instead of a keyword if you want to search with specific filters already applied. Example: https://www.amazon.com/s?k=vacuum+bottle. Do not use both keyword and url at the same time."
          },
          "domain": {
            "title": "Amazon Marketplace",
            "enum": [
              ".com",
              ".co.uk",
              ".de",
              ".fr",
              ".co.jp",
              ".ca",
              ".it",
              ".es",
              ".com.au",
              ".com.br",
              ".com.mx",
              ".nl",
              ".se",
              ".pl",
              ".sg",
              ".com.tr",
              ".ae",
              ".sa",
              ".in",
              ".eg",
              ".com.be"
            ],
            "type": "string",
            "description": "The Amazon marketplace to query."
          },
          "sort_by": {
            "title": "Sort By (Optional)",
            "enum": [
              "",
              "featured",
              "price-asc-rank",
              "price-desc-rank",
              "review-rank",
              "date-desc-rank"
            ],
            "type": "string",
            "description": "Sort search results by a specific order. Leave empty for Amazon's default featured order.",
            "default": ""
          },
          "exclude_sponsored": {
            "title": "Exclude Sponsored Products",
            "type": "boolean",
            "description": "If enabled, sponsored (ad) products are removed from results and only organic listings are returned.",
            "default": false
          },
          "language": {
            "title": "Language (Optional)",
            "enum": [
              "",
              "en_US",
              "de_DE",
              "fr_FR",
              "it_IT",
              "es_ES",
              "ja_JP",
              "zh_CN",
              "pt_BR",
              "nl_NL",
              "pl_PL",
              "sv_SE",
              "tr_TR",
              "ar_AE"
            ],
            "type": "string",
            "description": "Language code to request the Amazon search page in. Leave empty for the default marketplace language.",
            "default": ""
          },
          "currency": {
            "title": "Currency (Optional)",
            "type": "string",
            "description": "Currency code for displaying prices. Leave empty to use the default marketplace currency. Example: usd, eur, gbp."
          },
          "refinements": {
            "title": "Refinements (Optional)",
            "type": "string",
            "description": "Apply category or attribute filters using Amazon's refinement format. Example: n:7141123011,p_123:502215. Category IDs and filter values can be found in Amazon search URLs."
          },
          "max_pages": {
            "title": "Max Pages (1-5)",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Number of search result pages to retrieve. Each page returns up to 20-60 products and consumes 1 credit. Maximum is 5 pages.",
            "default": 1
          },
          "api_key": {
            "title": "Easyparser API Key (Optional)",
            "type": "string",
            "description": "Your personal Easyparser API key for higher request limits. Leave empty to use the shared demo key. Get your own free key at https://app.easyparser.com/signup - 100 free credits/month, no credit card required."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}