{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ecommercedataapi-com/json-schema/ecommercedataapi-com-amazon-keywords-miner-request-schema.json",
  "title": "AmazonKeywordsMinerRequest",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ecommercedataapi-com-openapi.json#/components/schemas/AmazonKeywordsMinerRequest",
  "type": "object",
  "properties": {
    "amazonChoice": {
      "type": "boolean",
      "description": "Amazon choice."
    },
    "excludeKeywords": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Exclude keywords."
      },
      "description": "Exclude keywords."
    },
    "filterRootWord": {
      "type": "integer",
      "format": "int32",
      "description": "Filter root word."
    },
    "historyDate": {
      "type": "string",
      "description": "History date. Date or timestamp value."
    },
    "includeKeywords": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Include keywords."
      },
      "description": "Include keywords."
    },
    "keyword": {
      "type": "string",
      "description": "Keyword used by the query."
    },
    "keywordList": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "List of keywords used by the query."
      },
      "description": "List of keywords used by the query."
    },
    "marketplace": {
      "type": "string",
      "enum": [
        "US",
        "UK",
        "DE",
        "FR",
        "IT",
        "ES",
        "MX",
        "CA",
        "AU",
        "JP",
        "IN",
        "AE",
        "BR"
      ],
      "description": "Amazon marketplace code. Supported values are listed in the schema."
    },
    "maxAdProducts": {
      "type": "integer",
      "format": "int32",
      "description": "Max ad products. Maximum value."
    },
    "maxBid": {
      "type": "number",
      "format": "float",
      "description": "Max bid. Maximum value."
    },
    "maxMonopolyClickRate": {
      "type": "number",
      "format": "float",
      "description": "Max monopoly click rate. Maximum value."
    },
    "maxPrice": {
      "type": "number",
      "format": "float",
      "description": "Max price. Maximum value."
    },
    "maxProducts": {
      "type": "integer",
      "format": "int32",
      "description": "Max products. Maximum value."
    },
    "maxPurchases": {
      "type": "integer",
      "format": "int32",
      "description": "Max purchases. Maximum value."
    },
    "maxPurchasesRate": {
      "type": "number",
      "format": "float",
      "description": "Max purchases rate. Maximum value. Percentage or ratio value as documented."
    },
    "maxRating": {
      "type": "number",
      "format": "float",
      "description": "Max rating. Maximum value."
    },
    "maxRatings": {
      "type": "integer",
      "format": "int32",
      "description": "Max ratings. Maximum value."
    },
    "maxRelevancy": {
      "type": "number",
      "format": "float",
      "description": "Max relevancy. Maximum value."
    },
    "maxSPR": {
      "type": "integer",
      "format": "int32",
      "description": "Max SPR. Maximum value."
    },
    "maxSearch": {
      "type": "integer",
      "format": "int32",
      "description": "Max search. Maximum value."
    },
    "maxSearchRank": {
      "type": "integer",
      "format": "int32",
      "description": "Max search rank. Maximum value."
    },
    "maxSupplyDemandRatio": {
      "type": "number",
      "format": "float",
      "description": "Max supply demand ratio. Maximum value."
    },
    "maxTitleDensity": {
      "type": "integer",
      "format": "int32",
      "description": "Max title density. Maximum value."
    },
    "maxWordCount": {
      "type": "integer",
      "format": "int32",
      "description": "Max word count. Maximum value."
    },
    "minAdProducts": {
      "type": "integer",
      "format": "int32",
      "description": "Min ad products. Minimum value."
    },
    "minBid": {
      "type": "number",
      "format": "float",
      "description": "Min bid. Minimum value."
    },
    "minMonopolyClickRate": {
      "type": "number",
      "format": "float",
      "description": "Min monopoly click rate. Minimum value."
    },
    "minPrice": {
      "type": "number",
      "format": "float",
      "description": "Min price. Minimum value."
    },
    "minProducts": {
      "type": "integer",
      "format": "int32",
      "description": "Min products. Minimum value."
    },
    "minPurchases": {
      "type": "integer",
      "format": "int32",
      "description": "Min purchases. Minimum value."
    },
    "minPurchasesRate": {
      "type": "number",
      "format": "float",
      "description": "Min purchases rate. Minimum value. Percentage or ratio value as documented."
    },
    "minRating": {
      "type": "number",
      "format": "float",
      "description": "Min rating. Minimum value."
    },
    "minRatings": {
      "type": "integer",
      "format": "int32",
      "description": "Min ratings. Minimum value."
    },
    "minRelevancy": {
      "type": "number",
      "format": "float",
      "description": "Min relevancy. Minimum value."
    },
    "minSPR": {
      "type": "integer",
      "format": "int32",
      "description": "Min SPR. Minimum value."
    },
    "minSearch": {
      "type": "integer",
      "format": "int32",
      "description": "Min search. Minimum value."
    },
    "minSearchRank": {
      "type": "integer",
      "format": "int32",
      "description": "Min search rank. Minimum value."
    },
    "minSupplyDemandRatio": {
      "type": "number",
      "format": "float",
      "description": "Min supply demand ratio. Minimum value."
    },
    "minTitleDensity": {
      "type": "integer",
      "format": "int32",
      "description": "Min title density. Minimum value."
    },
    "minWordCount": {
      "type": "integer",
      "format": "int32",
      "description": "Min word count. Minimum value."
    },
    "order": {
      "type": "object",
      "properties": {
        "desc": {
          "type": "boolean",
          "description": "Use true for descending order or false for ascending order."
        },
        "field": {
          "type": "string",
          "description": "Field used to sort the results. Available values (Table 2.4): searchfrequencyrank, cprExact, titleDensityExact, searches"
        }
      },
      "additionalProperties": false,
      "description": "Sort definition."
    },
    "page": {
      "type": "integer",
      "format": "int32",
      "minimum": 1,
      "description": "Page number starting at 1."
    },
    "returnFields": {
      "type": "string",
      "description": "Optional comma-separated response fields. Omit it to receive the standard payload."
    },
    "size": {
      "type": "integer",
      "format": "int32",
      "minimum": 1,
      "description": "Number of results per page."
    }
  },
  "required": [
    "marketplace"
  ],
  "additionalProperties": false
}