{
  "openapi": "3.0.1",
  "info": {
    "title": "Amazon Keyword Research & Rank Tracker: Reverse ASIN",
    "description": "Reverse ASIN keywords, Amazon search volume, related keywords and daily organic + sponsored rank tracking for your ASINs, with day-over-day changes. No Seller Central login, no monthly subscription.",
    "version": "0.1",
    "x-build-id": "QyDPcCYW8FuL5udIG"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/steady-scrape~amazon-keyword-research-rank-tracker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-steady-scrape-amazon-keyword-research-rank-tracker",
        "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/steady-scrape~amazon-keyword-research-rank-tracker/runs": {
      "post": {
        "operationId": "runs-sync-steady-scrape-amazon-keyword-research-rank-tracker",
        "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/steady-scrape~amazon-keyword-research-rank-tracker/run-sync": {
      "post": {
        "operationId": "run-sync-steady-scrape-amazon-keyword-research-rank-tracker",
        "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": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "What do you need?",
            "enum": [
              "reverse_asin",
              "related",
              "volume",
              "rank_track"
            ],
            "type": "string",
            "description": "Reverse ASIN and related keywords: Amazon US, UAE, Saudi Arabia, Egypt. Search volume: 16 marketplaces. Rank tracking: 15 marketplaces (live Amazon results).",
            "default": "reverse_asin"
          },
          "asins": {
            "title": "ASINs or product links",
            "type": "array",
            "description": "Reverse ASIN and rank tracking. Up to 10 ASINs (like B00FLYWNYQ) or Amazon product URLs. Apify Free plan: 1 ASIN per run.",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Related: up to 20 seed keywords. Search volume: up to 1,000 keywords. Rank tracking: up to 100 keywords (each is checked for every ASIN). Apify Free plan: 1 related seed, 50 volume keywords, 5 tracked keywords.",
            "items": {
              "type": "string"
            }
          },
          "marketplace": {
            "title": "Amazon marketplace",
            "enum": [
              "US",
              "UK",
              "CA",
              "DE",
              "FR",
              "IT",
              "ES",
              "NL",
              "AT",
              "IN",
              "AU",
              "MX",
              "AE",
              "SA",
              "EG",
              "SG"
            ],
            "type": "string",
            "description": "Which Amazon store. Reverse ASIN and related keywords work for US, AE, SA and EG.",
            "default": "US"
          },
          "maxKeywordsPerItem": {
            "title": "Keywords per ASIN / seed",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Reverse ASIN and related modes: most keywords returned per ASIN or seed (sorted by search volume). Apify Free plan: 50.",
            "default": 100
          },
          "minSearchVolume": {
            "title": "Min monthly searches",
            "minimum": 0,
            "type": "integer",
            "description": "Skip keywords with fewer monthly Amazon searches."
          },
          "maxSearchVolume": {
            "title": "Max monthly searches",
            "minimum": 0,
            "type": "integer",
            "description": "Skip keywords with more monthly searches."
          },
          "maxRank": {
            "title": "Max organic rank (reverse ASIN)",
            "minimum": 1,
            "maximum": 700,
            "type": "integer",
            "description": "Reverse ASIN: only keywords where the product ranks this high or better, like 20 for page one."
          },
          "includeWords": {
            "title": "Must contain one of",
            "type": "array",
            "description": "Keep only keywords containing at least one of these words.",
            "items": {
              "type": "string"
            }
          },
          "excludeWords": {
            "title": "Must not contain",
            "type": "array",
            "description": "Drop keywords containing any of these words (brand names, for example).",
            "items": {
              "type": "string"
            }
          },
          "rankDepthPages": {
            "title": "Rank tracking depth (pages of 100)",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "How deep to look for your ASIN: 1 = top 100 results, 2 = top 200, 3 = top 300. Each page of 100 results is one rank check, so depth 3 costs 3 rank checks per ASIN x keyword.",
            "default": 1
          },
          "department": {
            "title": "Department (optional)",
            "type": "string",
            "description": "Search inside one Amazon department, like 'Home & Kitchen' or 'Electronics'. Empty = All departments."
          },
          "historyStoreName": {
            "title": "History store name",
            "type": "string",
            "description": "Named key-value store in your account where previous ranks are kept for day-over-day changes. Use different names for different projects.",
            "default": "amazon-rank-history"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}