Getting started

Using the Rank Tracker API

The Whitespark Rank Tracker API is currently in beta — though we endeavour to deliver a fully-complete product you might experience some odd behaviour or have questions. If you have any issues or questions please email troy@whitespark.ca

API Authentication Copied!

The Rank Tracker API is authenticated using the X-API-Key header. All requests to the API must include this header and your unique API Key in order to return data.

To get your API key or have it regenerated, please email troy@whitespark.ca

Rate Limiting / Usage Copied!

The Local Rank Tracker was designed to be experienced using the built-in UI, not for automated ingress.

Due to this, some calls are extremely expensive in terms of computational resources, chiefly the rankings endpoint.

To that end 🚨 please self-rate-limit your API calls, especially to this endpoint.

Ideally, access this endpoint on a single thread.

API Guide Copied!

To get started, click “Reference” in the top left - from there you will be able to learn about and experiment with the API straight from your browser!