/ubersuggest/keywords/search

POST /api/ubersuggest/keywords/search

Price: 1 credit

Discover related keyword ideas for a seed keyword with full SEO metrics, filters and sorting

How to use it

Expand a seed keyword into a ranked list of related keyword ideas, each with monthly search volume, cost-per-click, competition, SEO difficulty, paid difficulty and search intent. Supports filtering by intent, volume range, SEO difficulty range, CPC range, competition range and paid-difficulty range, plus include/exclude term filters, and sorting by volume, CPC, SEO difficulty or paid difficulty. Resolve the loc_id with the locations search endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Seed keyword to expand into related keyword ideas (examples: "coffee maker", "seo"; minLength: 1)
• lang string — Keyword language (default: "en"; one of: "en", "es", "de", "fr", "it", "pt", "nl", "pl", "ru", "ja", "hi")
• loc_id integer — Location id (resolve via the locations search endpoint, e.g. 2840 for the United States) (default: 2840; examples: 2840; min: 1)
• sort_by string — Result ordering (default: "-searchVolume"; one of: "-searchVolume", "searchVolume", "-cpc", "cpc", "-sd", "sd", "-pd", "pd")
• search_intent array — Keep only keywords whose intent is in this set (default: []; one of: 1, 2, 3, 4)
• volume_min integer nullable — Minimum monthly search volume (min: 0)
• volume_max integer nullable — Maximum monthly search volume (min: 0)
• seo_difficulty_min integer nullable — Minimum SEO difficulty (0-100) (min: 0; max: 100)
• seo_difficulty_max integer nullable — Maximum SEO difficulty (0-100) (min: 0; max: 100)
• cpc_min number nullable — Minimum cost-per-click (min: 0)
• cpc_max number nullable — Maximum cost-per-click (min: 0)
• competition_min number nullable — Minimum paid competition (0-1) (min: 0; max: 1)
• competition_max number nullable — Maximum paid competition (0-1) (min: 0; max: 1)
• pd_min integer nullable — Minimum paid difficulty (0-100) (min: 0; max: 100)
• pd_max integer nullable — Maximum paid difficulty (0-100) (min: 0; max: 100)
• include array — Keep only keywords containing all of these terms (default: [])
• exclude array — Drop keywords containing any of these terms (default: [])
• count integer required — Max number of keyword ideas to return (min: 1)

Response

• @type string (default: "UbersuggestKeywordIdea")
• keyword string required
• volume integer nullable
• cpc number nullable
• competition number nullable
• seo_difficulty integer nullable
• paid_difficulty integer nullable
• search_intent array (default: [])
• updated_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.