What a domain ranks for

Embed
Preview of the card
<a href="https://seolyticize.com/docs/ref-get-ranked-keywords"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/25af4e93-2db4-4296-980b-9d3a0f499982/social-card.svg?v=3e7ae33eec8b" alt="What a domain ranks for" width="600" height="315"></a>
POSThttps://seolyticize.com/api/v1/tools/get_ranked_keywords

Every keyword a domain, subfolder or page ranks for in Google — position (and the one before), URL, estimated traffic, volume, CPC, difficulty, intent and SERP features — filtered and sorted, paginated. paid: true (or resultType paid) lists the keywords it buys ads on, with the ad; resultType ai_overview_reference lists the keywords whose AI Overview cites it, featured_snippet those where it holds the snippet. change new / up / down lists its recent ranking movements, and lost the keywords it no longer ranks for (with the position it last held). engine amazon reads the keywords an Amazon product ranks for (target its ASIN); engine app_store or google_play the keywords an app ranks for (target the numeric App Store id or the Play package name; US English only) — position, volume and the listing, without the Google-only fields, filters or change. Answers 'what does this competitor rank for', 'which keywords drive their traffic', 'what did they just start ranking for' and 'which searches find this product or app'. A paid lookup on the client's account unless anyone read the same thing recently (spend says which); quote it with estimate_cost.

Parameters

Idempotency-Keystringheader
Any unique string, up to 200 characters. A retry with the same key and body is answered from the first answer (Idempotent-Replayed: true) for a day, so it never buys or writes twice; the same key with another body is refused.

Request body

application/json
clientIdstringrequired
enginestring
google | amazon | app_store | google_play = google
targetstring
A domain (competitor.com), a subfolder (competitor.com/blog/) or a page URL. Default: the client's own domain.
= null
scopestring
auto reads a bare domain as the domain, a path ending in / as a subfolder, anything else as one URL.
auto | domain | subdomains | subfolder | url = auto
paidboolean
= false
resultTypestring
ai_overview_reference: keywords whose AI Overview cites the domain; featured_snippet; local_pack; paid (same as paid: true).
organic | paid | ai_overview_reference | featured_snippet | local_pack = organic
changestring
all | new | up | down | lost = all
minPositioninteger
= 1
maxPositioninteger
= 100
minVolumeinteger
= 0
intentstring
= null
containsstring
Only keywords containing these words.
= null
sortstring
traffic | volume | position | change = traffic
limitinteger
= 100
offsetinteger
= 0
locationCodeinteger
Default: the client's project (2840 United States).
= null
languageCodestring
Default: the client's project.
= null
maxCostMicrosinteger
Optional spending limit for this call, in micro-USD (1,000,000 = $1). A purchase that would take the call past it is refused before anything is bought. Pass the estimate from estimate_cost, or what the user agreed to spend.
dryRunboolean
True to buy nothing and get the quote instead: what the call would cost at most and what it would buy.
{
  "clientId": "string",
  "engine": "google",
  "target": null,
  "scope": "auto",
  "paid": false,
  "resultType": "organic",
  "change": "all",
  "minPosition": 1,
  "maxPosition": 100,
  "minVolume": 0,
  "intent": null,
  "contains": null,
  "sort": "traffic",
  "limit": 100,
  "offset": 0,
  "locationCode": null,
  "languageCode": null,
  "maxCostMicros": 0,
  "dryRun": true
}

Code samples

cURL
curl -X POST "https://seolyticize.com/api/v1/tools/get_ranked_keywords" \
  -H "Authorization: Bearer $SEOLYTICIZE_API_KEY" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","engine":"google","target":null,"scope":"auto","paid":false,"resultType":"organic","change":"all","minPosition":1,"maxPosition":100,"minVolume":0,"intent":null,"contains":null,"sort":"traffic","limit":100,"offset":0,"locationCode":null,"languageCode":null,"maxCostMicros":0,"dryRun":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 The tool's result under data, and its meta.
Example
{
  "data": {},
  "meta": {
    "requestId": "string",
    "costMicros": 0,
    "cached": true,
    "cachedFrom": "string",
    "dataAsOf": "string",
    "sources": [
      "string"
    ],
    "partial": true,
    "next": [
      {
        "tool": "string",
        "args": {},
        "why": "string"
      }
    ],
    "nextCursor": "string",
    "dryRun": true
  }
}
Schema
datarequired
metaobjectrequired
Beside every answer: what it cost, whether it came from cache, how fresh it is, whether it is complete, and what to call next.
Show child parameters
requestIdstringrequired
costMicrosintegerrequired
Charged by this call, micro-USD (1,000,000 = $1).
cachedbooleanrequired
True when nothing was bought.
cachedFromstring
When the oldest cached answer used was bought.
dataAsOfstring
sourcesstring[]
partialbooleanrequired
True when the data is incomplete: a running crawl, unfinished days, unread pages.
nextobject[]required
Show child parameters
toolstring
argsobject
whystring
nextCursorstring
Pass as cursor for the next page.
dryRunboolean
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
X-Request-Idstring
The id to quote about this request.
400 The body was not JSON or did not match the tool's input schema.
Example
{
  "error": "string",
  "code": "string",
  "next": "string",
  "requestId": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
codestring
A stable snake_case reason to branch on; GET /api/v1/errors lists them all.
nextstring
The call or step that fixes it, when there is one.
requestIdstring
Quote it when asking about a failure.
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
401 No key, or a key that is unknown or revoked.

Same as 400 · POST /api/v1/tools/get_ranked_keywords

Headers
WWW-Authenticatestring
403 The key's role does not permit the tool, or the key may not reach the named client.

Same as 400 · POST /api/v1/tools/get_ranked_keywords

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
404 No tool by that name.

Same as 400 · POST /api/v1/tools/get_ranked_keywords

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
409 A request with this Idempotency-Key is still running.

Same as 400 · POST /api/v1/tools/get_ranked_keywords

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
422 A well-formed request the product declined, with the reason — a duplicate name, a plan limit, nothing configured to run.

Same as 400 · POST /api/v1/tools/get_ranked_keywords

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
429 This key has used its window.

Same as 400 · POST /api/v1/tools/get_ranked_keywords

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Retry-Afterinteger
Seconds to wait before retrying.
500 The request could not be completed.

Same as 400 · POST /api/v1/tools/get_ranked_keywords

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Updated