Domain

Read a cached domain snapshot

get/domains/{domain}

Request

  • Base URL: https://vaneform.com/api/v1
  • URL: https://vaneform.com/api/v1/domains/{domain}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

domainstring required
Example:google.com

A public host such as google.com. A leading www. is removed and the host is lowercased. The receipt uses that host.

Query parameters

includestring
Example:scale,registry,profile,popularity

Comma-separated families. Default is scale,registry,profile,popularity. Add baidu for cached Baidu rank. Add search for the Pro keyword rankings cache.

Response

Cached snapshot or an honest missing status.

domainstring required
status'ready' | 'partial' | 'missing' | 'error' required
refresh_policy'cache_only' required
report_urlstring uri

Changes

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