{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Keyword Research Tool",
    "description": "Amazon keyword research tool: look up keywords and get what the results page shows for each: the result count, first-page prices, ratings, reviews, sponsored share and bought-past-month totals. Track where your ASINs rank, or run a reverse ASIN lookup for the keywords a product shows up for.",
    "version": "0.1",
    "x-build-id": "xbFTNf2AZgPLaOtDe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dami_studio~amazon-keyword-research-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dami_studio-amazon-keyword-research-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/dami_studio~amazon-keyword-research-scraper/runs": {
      "post": {
        "operationId": "runs-sync-dami_studio-amazon-keyword-research-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/dami_studio~amazon-keyword-research-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-dami_studio-amazon-keyword-research-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": "Keywords",
            "maxItems": 1000,
            "type": "array",
            "description": "Each keyword is looked up on Amazon's results page and comes back as one row: the result count, the first page's prices, ratings, reviews, sponsored share and bought-past-month totals, and the first products. Up to 1,000 a run.",
            "items": {
              "type": "string"
            }
          },
          "asins": {
            "title": "Products to track (ASINs or product links)",
            "maxItems": 100,
            "type": "array",
            "description": "Every keyword row says where each of these products sits on that keyword's first page of results: its organic rank, its sponsored rank, or not found. Turn on the reverse ASIN option below to have the run find keywords for them too. Up to 100.",
            "items": {
              "type": "string"
            }
          },
          "findKeywordsForAsins": {
            "title": "Find the keywords these products show up for (reverse ASIN)",
            "type": "boolean",
            "description": "For each product, the run reads its title, builds keywords from it and from Amazon's suggestions for its main phrases, and checks each one. Every keyword checked is a row, with asinFound true or false.",
            "default": false
          },
          "keywordsPerAsin": {
            "title": "Keywords to check per product (reverse ASIN)",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many keywords the reverse ASIN option checks for each product. Each one checked is a row.",
            "default": 30
          },
          "includeSearchVolume": {
            "title": "Add monthly search volumes",
            "type": "boolean",
            "description": "Adds searchVolume, how many times a month shoppers search Amazon for the keyword, to each keyword row on amazon.com, .ca, .com.mx, .nl, .ae, .sa, .eg and .in. Each volume added is charged, and so is each request for them: one per store per 1,000 keywords.",
            "default": false
          },
          "fullKeywordListForAsins": {
            "title": "Full keyword list for each product",
            "type": "boolean",
            "description": "For each product in \"ASINs\", adds the keywords it ranks for, best rank first, one row each with its monthly search volume and the product's rank, up to \"Keywords to check per product\". On amazon.com, .eg, .sa and .ae. Each row is charged, and so is each product's list, even one with no keywords.",
            "default": false
          },
          "addSuggestions": {
            "title": "Add Amazon's suggestions for each keyword",
            "type": "boolean",
            "description": "Look up the phrases Amazon suggests in its search box for each of your keywords too. Each one becomes its own row.",
            "default": false
          },
          "expandAlphabet": {
            "title": "Also try each keyword followed by a to z",
            "type": "boolean",
            "description": "Asks Amazon for suggestions after \"keyword a\", \"keyword b\" and so on, which brings out the long tail.",
            "default": false
          },
          "expandNumbers": {
            "title": "Also try each keyword followed by 0 to 9",
            "type": "boolean",
            "description": "Asks for suggestions after \"keyword 0\" to \"keyword 9\": sizes, pack counts and model numbers.",
            "default": false
          },
          "expandModifiers": {
            "title": "Also try buyer words",
            "type": "boolean",
            "description": "Asks for suggestions with buying words around the keyword, in the store's language: best, cheap, for women, for men, for kids, small, large, set, gift and a few more.",
            "default": false
          },
          "customSuffixes": {
            "title": "Your own endings",
            "maxItems": 50,
            "type": "array",
            "description": "Words to put after each keyword before asking for suggestions, for example \"for dogs\" or \"stainless steel\". Up to 50.",
            "items": {
              "type": "string"
            }
          },
          "suggestionsPerLookup": {
            "title": "Suggestions to keep per lookup",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Amazon shows up to 10 suggestions for each thing typed. Keep fewer to stay with the most searched ones.",
            "default": 10
          },
          "marketplaces": {
            "title": "Amazon stores",
            "type": "array",
            "description": "Which Amazon store to look the keywords up on. Pick several to compare stores in one run; each keyword in each store is a row.",
            "items": {
              "type": "string",
              "enum": [
                "com",
                "ca",
                "com.mx",
                "com.br",
                "ie",
                "nl",
                "com.be",
                "se",
                "pl",
                "com.tr",
                "ae",
                "sa",
                "eg",
                "in",
                "de",
                "co.jp",
                "com.au",
                "sg"
              ],
              "enumTitles": [
                "amazon.com (US, USD)",
                "amazon.ca (Canada, CAD)",
                "amazon.com.mx (Mexico, MXN)",
                "amazon.com.br (Brazil, BRL)",
                "amazon.ie (Ireland, EUR)",
                "amazon.nl (Netherlands, EUR)",
                "amazon.com.be (Belgium, EUR)",
                "amazon.se (Sweden, SEK)",
                "amazon.pl (Poland, PLN)",
                "amazon.com.tr (Turkey, TRY)",
                "amazon.ae (UAE, AED)",
                "amazon.sa (Saudi Arabia, SAR)",
                "amazon.eg (Egypt, EGP)",
                "amazon.in (India, INR)",
                "amazon.de (Germany, EUR)",
                "amazon.co.jp (Japan, JPY)",
                "amazon.com.au (Australia, AUD)",
                "amazon.sg (Singapore, SGD)"
              ]
            },
            "default": [
              "com"
            ]
          },
          "department": {
            "title": "Department",
            "pattern": "^$|^[a-z0-9][a-z0-9-]{0,39}$",
            "type": "string",
            "description": "Optional. Search inside one department, as Amazon names it in its search links: electronics, stripbooks, grocery, toys-and-games, beauty, fashion and so on. Leave empty for all departments."
          },
          "language": {
            "title": "Page language",
            "enum": [
              "en_US",
              "es_US",
              "en_CA",
              "fr_CA",
              "es_MX",
              "pt_BR",
              "en_IE",
              "nl_NL",
              "en_GB",
              "fr_BE",
              "nl_BE",
              "sv_SE",
              "pl_PL",
              "tr_TR",
              "en_AE",
              "ar_AE",
              "en_IN",
              "hi_IN",
              "de_DE",
              "ja_JP",
              "en_AU",
              "en_SG"
            ],
            "type": "string",
            "description": "Optional. Ask the store for its pages in this language where it offers it, for example Spanish on amazon.com. Leave empty for the store's own language."
          },
          "topProducts": {
            "title": "Products to list per keyword",
            "minimum": 0,
            "maximum": 60,
            "type": "integer",
            "description": "How many of the first page's products to include in each row, with their rank, price, rating, reviews and badges. 0 leaves the list out; the page numbers are counted over every product either way.",
            "default": 10
          },
          "maxKeywords": {
            "title": "Maximum keyword rows",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "The run stops after this many keyword rows, across every store, suggestion and product.",
            "default": 100
          },
          "delayBetweenLookupsMs": {
            "title": "Extra pause between lookups (ms)",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Optional. Slows the run down by this much between results pages.",
            "default": 0
          },
          "maxConcurrency": {
            "title": "Pages read at once",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "How many results pages the run reads at the same time.",
            "default": 2
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. Leave this alone unless you need the run to go out through your own proxy servers; those are tried first."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}