DataKeywordSuggestionsList

Retrieve a list of related keyword suggestions for a given input keyword.

JSON-RPC Method Name

data.keyword.suggestions.list

Request Parameters

serp_query

object

The SERP query object describes a keyword or search phrase in combination with several options to specify how the query is run (i.e. how a SERP should be retrieved for this keyword if necessary).

options

object

Options to further filter or refine which keyword suggestions are returned. Strategy will default to default if not provided.

page

object

Control how much data is returned by providing a specific page number (n) and limit to the number of results in a given page.

Response Values

suggestions

array

keyword

string

The keyword that is suggested. Assume the same locale, engine, device, and vicinity as the provided SERP query input.

relevance

number

A score for how relevant the suggestion is to the provided SERP query.

serp_query

object

Represents a SERP query object.

options

object

page

object

Control how much data is returned by providing a specific page number (n) and limit to the number of results in a given page.

Sample Requests

Sample Response

1{
2  "serp_query": {
3    "keyword": "domain authority",
4    "locale": "en-US",
5    "device": "desktop",
6    "engine": "google"
7  },
8  "page": {
9    "n": 0,
10    "limit": 50
11  },
12  "options": {
13    "strategy": "default"
14  },
15  "suggestions": [
16    {
17      "keyword": "domain authority",
18      "relevance": 1
19    },
20    {
21      "keyword": "domain authority checker",
22      "relevance": 0.9877959194006802
23    },
24    {
25      "keyword": "domain authority checker moz",
26      "relevance": 0.9870885222670346
27    }
28  ]
29}

Quota Usage

Uses one row per returned result.

api.limits.data.rows

Example Code

curl -X POST https://api.moz.com/jsonrpc \
-H "x-moz-token: <YOUR_MOZ_TOKEN>" \
-H "Content-Type: application/json" \
-d '
{
  "jsonrpc": "2.0",
  "id": "8f292d31-a098-4ca1-b40c-59faad7ea474",
  "method": "data.keyword.suggestions.list",
  "params": {
    "data": {
      "serp_query": {
        "keyword": "domain authority",
        "locale": "en-US",
        "device": "desktop",
        "engine": "google"
      }
    }
  }
}'