/ubersuggest/keywords

POST /api/ubersuggest/keywords

Price: 1 credit

Get full SEO metrics for a single keyword: search volume, difficulty, CPC, search intent and trend

How to use it

Look up the headline SEO metrics for one keyword in a given country: monthly search volume, SEO difficulty (0-100), paid difficulty, cost-per-click, competition, search intent (informational/navigational/commercial/transactional), a 12-month search-volume trend, a per-country/language global volume breakdown, and audience clickstream data (organic vs paid share, age and gender distribution, and the monthly desktop-vs-mobile search split). 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 look up (examples: "coffee maker", "running shoes"; 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)

Response

• @type string (default: "UbersuggestKeyword")
• keyword string required
• volume integer nullable
• cpc number nullable
• competition number nullable
• seo_difficulty integer nullable
• paid_difficulty integer nullable
• search_intent array (default: [])
• monthly_search_volume object (default: {})
  • * integer
• global_volume_breakdown object (default: {})
  • * integer
• language string nullable
• loc_id integer nullable
• clickstream object nullable
  • @type string (default: "UbersuggestKeywordClickstream")
  • click_rate number nullable
  • paid_searches_percentage number nullable
  • organic_searches_percentage number nullable
  • male_percentage number nullable
  • female_percentage number nullable
  • gender_unknown_percentage number nullable
  • age_under_18_percentage number nullable
  • age_18_to_24_percentage number nullable
  • age_25_to_34_percentage number nullable
  • age_35_to_44_percentage number nullable
  • age_45_to_54_percentage number nullable
  • age_55_to_64_percentage number nullable
  • age_plus_65_percentage number nullable
  • age_unknown_percentage number nullable
  • desktop_searches_percentage object (default: {})
    • * number
  • mobile_searches_percentage object (default: {})
    • * number
• 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 — Keyword not found 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.