# semrush.seo.keywords.related

Related keywords with volume and CPC by phrase and country

> This report provides an extended list of related keywords, synonyms, and variations relevant to a queried term in a chosen database.

Page: https://telipot.com/catalog/tasks/semrush.seo.keywords.related · Markdown: https://telipot.com/catalog/tasks/semrush.seo.keywords.related/md · JSON: https://telipot.com/catalog/tasks/semrush.seo.keywords.related/json

| Field | Value |
| --- | --- |
| provider | [Semrush](https://telipot.com/catalog/providers/semrush) `semrush` |
| capability | [`seo.keywords.related`](https://telipot.com/catalog/capabilities/seo.keywords.related) |
| kind | data |
| tier | core |
| price | Semrush API units (40 API units / result · docs) |
| price note | 40 API units per line returned. Semrush does not charge a request that returns no data. Semrush publishes no USD price per API unit. |
| identity | Your plan |
| auth | `api_key · in query as key` |
| scope | any_account |
| principal | organization |
| required_scopes | none |
| retention | standard |
| route | `GET https://api.semrush.com/` |
| verification | Not verified yet. Not checked yet. We test with a real request before we mark it. |
| status | live |
| docs | https://developer.semrush.com/api/v3/seo/keyword-reports/#related-keywords |

## Preview the price · nothing runs

```bash
telipot run semrush.seo.keywords.related \
  --input-json '{"type":"phrase_related","phrase":"seo","database":"us","display_limit":1,"export_columns":"Ph,Nq,Cp,Co"}' \
  --quote
```

## Run it

```bash
telipot run semrush.seo.keywords.related \
  --input-json '{"type":"phrase_related","phrase":"seo","database":"us","display_limit":1,"export_columns":"Ph,Nq,Cp,Co"}'
```

```bash
curl https://api.telipot.com/v1/tasks/semrush.seo.keywords.related/run \
  -H "Authorization: Bearer $TELIPOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type":"phrase_related","phrase":"seo","database":"us","display_limit":1,"export_columns":"Ph,Nq,Cp,Co"}'
```

## Input

| Field | In | Type | Required | Constraints | Note |
| --- | --- | --- | --- | --- | --- |
| `type` | queryParams | string | yes | const "phrase_related" | Fixed. Selects the Related Keywords report. |
| `phrase` | queryParams | string | yes |  | Keyword or keyword expression to investigate. |
| `database` | queryParams | string | yes |  | 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. |
| `display_limit` | queryParams | integer | yes | 1 to 100000 | Lines returned, which is what Semrush bills. Semrush returns up to 10,000 lines when the parameter is omitted or 0, so this task requires it. Semrush returns at most 100,000 lines per call. |
| `display_offset` | queryParams | integer | no | at least 0 | Lines to skip before the report starts. Semrush counts display_limit from the first line, so set display_limit to display_offset plus the lines wanted. |
| `display_sort` | queryParams | string | no | one of "nq_asc", "nq_desc", "cp_asc", "cp_desc", "co_asc", "co_desc", "nr_asc", "nr_desc", "rr_asc", "rr_desc", "kd_asc", "kd_desc" | Sort rule, one per call, such as nq_desc for the highest volume first. |
| `display_filter` | queryParams | string | no |  | Filters written as sign\|column\|operation\|value, joined with \|. Sign + includes and - excludes. Columns: Ph, Nq, Cp, Co, Nr, Wc, Fk, Kd. Operations: Eq, Gt, Lt for numbers; Bw, Ew, Eq, Co, Wm for text. At most 25 filters. Write it in plain text; the + must reach Semrush as %2B. |
| `export_columns` | queryParams | string | no | default "Ph,Nr,Cp,Co,Nq,Td,Rr" | 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), Rr Related Relevance, Fk SERP Features, In Intents (0 Commercial, 1 Informational, 2 Navigational, 3 Transactional), Kd Keyword Difficulty Index (0 to 100, higher is harder). |

## Input schema

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Fixed. Selects the Related Keywords report.",
      "const": "phrase_related"
    },
    "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"
      ]
    },
    "display_limit": {
      "type": "integer",
      "description": "Lines returned, which is what Semrush bills. Semrush returns up to 10,000 lines when the parameter is omitted or 0, so this task requires it. Semrush returns at most 100,000 lines per call.",
      "examples": [
        10
      ],
      "minimum": 1,
      "maximum": 100000
    },
    "display_offset": {
      "type": "integer",
      "description": "Lines to skip before the report starts. Semrush counts display_limit from the first line, so set display_limit to display_offset plus the lines wanted.",
      "minimum": 0
    },
    "display_sort": {
      "type": "string",
      "description": "Sort rule, one per call, such as nq_desc for the highest volume first.",
      "enum": [
        "nq_asc",
        "nq_desc",
        "cp_asc",
        "cp_desc",
        "co_asc",
        "co_desc",
        "nr_asc",
        "nr_desc",
        "rr_asc",
        "rr_desc",
        "kd_asc",
        "kd_desc"
      ]
    },
    "display_filter": {
      "type": "string",
      "description": "Filters written as sign|column|operation|value, joined with |. Sign + includes and - excludes. Columns: Ph, Nq, Cp, Co, Nr, Wc, Fk, Kd. Operations: Eq, Gt, Lt for numbers; Bw, Ew, Eq, Co, Wm for text. At most 25 filters. Write it in plain text; the + must reach Semrush as %2B.",
      "examples": [
        "+|Nq|Lt|1000"
      ]
    },
    "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), Rr Related Relevance, Fk SERP Features, In Intents (0 Commercial, 1 Informational, 2 Navigational, 3 Transactional), Kd Keyword Difficulty Index (0 to 100, higher is harder).",
      "default": "Ph,Nr,Cp,Co,Nq,Td,Rr"
    }
  },
  "required": [
    "type",
    "phrase",
    "database",
    "display_limit"
  ],
  "additionalProperties": false
}
```

## Output schema

```json
{
  "type": "string",
  "pattern": "^(?!\\s*ERROR)",
  "description": "CSV text: a header line of column names, then one line per related keyword, 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."
}
```