{
  "url": "https://telipot.com/catalog/capabilities/seo.keywords.volume",
  "id": "seo.keywords.volume",
  "description": "Search volume, cost per click and competition of a keyword",
  "platform": "seo",
  "providers": [
    {
      "slug": "semrush",
      "name": "Semrush"
    }
  ],
  "tasks": 1,
  "taskPages": [
    {
      "id": "semrush.seo.keywords.volume",
      "name": "Keyword volume, CPC and competition by phrase and country",
      "provider": {
        "slug": "semrush",
        "name": "Semrush"
      },
      "capability": "seo.keywords.volume",
      "platform": "seo",
      "kind": "data",
      "tier": "core",
      "identity": "key",
      "identityLabel": "Your plan",
      "price": {
        "native": {
          "text": "10 API units per result",
          "figure": "10 API units",
          "per": "result",
          "currency": "API units"
        },
        "confidence": "documented",
        "source": "docs",
        "sourceUrl": "https://developer.semrush.com/api/v3/seo/keyword-reports/#keyword-overview-one-database",
        "checked": "2026-10-05",
        "note": "10 API units per line returned, one line for this report. Semrush does not charge a request that returns no data. Semrush publishes no USD price per API unit.",
        "type": "per_result",
        "state": "native",
        "label": "Semrush API units",
        "detail": "10 API units / result · docs"
      },
      "providers": 1,
      "retention": "standard",
      "runsOn": "byoc",
      "live": true,
      "summary": "This report provides a keyword summary, including its volume, CPC, competition level, and the number of results in a chosen regional database.",
      "method": "GET",
      "path": "/",
      "host": "https://api.semrush.com",
      "docsUrl": "https://developer.semrush.com/api/v3/seo/keyword-reports/#keyword-overview-one-database",
      "auth": {
        "scheme": "api_key",
        "label": "api_key · in query as key",
        "short": "api_key · ?key"
      },
      "scope": "any_account",
      "principal": "organization",
      "requiredScopes": [],
      "verification": {
        "state": "none",
        "label": "Not verified yet",
        "detail": "Not checked yet. We test with a real request before we mark it."
      },
      "input": [
        {
          "name": "type",
          "location": "queryParams",
          "type": "string",
          "required": true,
          "constraints": [
            "const \"phrase_this\""
          ],
          "note": "Fixed. Selects the Keyword Overview (one database) report."
        },
        {
          "name": "phrase",
          "location": "queryParams",
          "type": "string",
          "required": true,
          "constraints": [],
          "note": "Keyword or keyword expression to investigate."
        },
        {
          "name": "database",
          "location": "queryParams",
          "type": "string",
          "required": true,
          "constraints": [],
          "note": "Two-letter regional database code, such as us, uk, ca, de or fr. Keyword reports accept the plain two-letter codes only, not the mobile- and -ext variants. The full list is under Databases in the SEO API overview."
        },
        {
          "name": "export_columns",
          "location": "queryParams",
          "type": "string",
          "required": false,
          "constraints": [
            "default \"Ph,Nq,Cp,Co,Nr\""
          ],
          "note": "Comma-separated column codes, in the order wanted. Ph Keyword, Nq Search Volume (monthly average over the last 12 months), Cp CPC in USD, Co Competition (0 to 1, 1 is highest), Nr Number of Results, Td Trends (12 monthly values), In Intents (0 Commercial, 1 Informational, 2 Navigational, 3 Transactional), Kd Keyword Difficulty Index (0 to 100, higher is harder)."
        }
      ],
      "sampleInput": {
        "type": "phrase_this",
        "phrase": "seo",
        "database": "us",
        "export_columns": "Ph,Nq,Cp,Co"
      },
      "inputSchema": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Fixed. Selects the Keyword Overview (one database) report.",
            "const": "phrase_this"
          },
          "phrase": {
            "type": "string",
            "description": "Keyword or keyword expression to investigate.",
            "examples": [
              "seo"
            ]
          },
          "database": {
            "type": "string",
            "description": "Two-letter regional database code, such as us, uk, ca, de or fr. Keyword reports accept the plain two-letter codes only, not the mobile- and -ext variants. The full list is under Databases in the SEO API overview.",
            "examples": [
              "us"
            ]
          },
          "export_columns": {
            "type": "string",
            "description": "Comma-separated column codes, in the order wanted. Ph Keyword, Nq Search Volume (monthly average over the last 12 months), Cp CPC in USD, Co Competition (0 to 1, 1 is highest), Nr Number of Results, Td Trends (12 monthly values), In Intents (0 Commercial, 1 Informational, 2 Navigational, 3 Transactional), Kd Keyword Difficulty Index (0 to 100, higher is harder).",
            "default": "Ph,Nq,Cp,Co,Nr"
          }
        },
        "required": [
          "type",
          "phrase",
          "database"
        ],
        "additionalProperties": false
      },
      "output": [
        {
          "name": "output",
          "type": "string",
          "description": "CSV text: a header line of column names, then one line per result, columns separated by semicolons, in the order of export_columns. A body that starts with ERROR is a failure, for example ERROR 50 :: NOTHING FOUND."
        }
      ],
      "outputSchema": {
        "type": "string",
        "pattern": "^(?!\\s*ERROR)",
        "description": "CSV text: a header line of column names, then one line per result, columns separated by semicolons, in the order of export_columns. A body that starts with ERROR is a failure, for example ERROR 50 :: NOTHING FOUND."
      },
      "commands": {
        "mode": "run",
        "cli": "telipot run semrush.seo.keywords.volume \\\n  --input-json '{\"type\":\"phrase_this\",\"phrase\":\"seo\",\"database\":\"us\",\"export_columns\":\"Ph,Nq,Cp,Co\"}'",
        "http": "curl https://api.telipot.com/v1/tasks/semrush.seo.keywords.volume/run \\\n  -H \"Authorization: Bearer $TELIPOT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"type\":\"phrase_this\",\"phrase\":\"seo\",\"database\":\"us\",\"export_columns\":\"Ph,Nq,Cp,Co\"}'",
        "quote": "telipot run semrush.seo.keywords.volume \\\n  --input-json '{\"type\":\"phrase_this\",\"phrase\":\"seo\",\"database\":\"us\",\"export_columns\":\"Ph,Nq,Cp,Co\"}' \\\n  --quote"
      },
      "siblings": []
    }
  ]
}
