tools

Check a domain's organic position in Google search results for a keyword (powered by DataForSEO). One lookup is one sample: Google can return a different result set for the same query minutes apart, so compare several lookups before reading a change in rank

post/tools/serp_rank

Request

  • Base URL: https://www.crawlforge.dev/api/v1
  • URL: https://www.crawlforge.dev/api/v1/tools/serp_rank
  • Auth: API key in header X-API-Key

Request body

keywordstring required

The search query to check ranking for

targetstring required

Domain or URL to locate in the results (e.g. 'example.com'). Matched by host, not exact URL: a URL is reduced to its host, and any page on that host or its subdomains counts

depthnumber

How many results to scan (10-200, default 30); deeper scans take longer. Credits stay at 5 at any depth

device'desktop' | 'mobile'

Device to emulate: desktop or mobile

language_codestring

Language code (e.g. 'en')

location_namestring

Location, e.g. 'United States' or 'London,England,United Kingdom'

location_codenumber

Numeric DataForSEO location code (overrides location_name)

Response

The tool's result; 5 credits charged (see x-credits-note and x-extra for add-ons).

successtrue required
dataobject required

The tool's result. Its shape is tool-specific and documented on the tool's docs page (x-docs-url on the operation).

credits_usedinteger required

Credits charged for this call: the operation's x-credits, plus any add-on x-credits-note or x-extra describes.

credits_remaininginteger required

The account's credit balance after this call.

processing_timeinteger required

Server-side processing time in milliseconds.

warningsstring[]

Non-fatal notes: a robots.txt override that was recorded, a format that could not be produced, a redaction that changed the payload.

Changes

No recorded changes to this operation across all 1 revision of this API.