Skip to content
Getting started

Quick start

Make your first requests in under five minutes.

1. Create an API key

Open Dashboard → API and select Create API key. Choose Read & write if you want to add websites or keywords.

2. List your websites

Confirm the key works by listing websites.

curl https://rankspire.tech/api/v1/websites \
  -H "Authorization: Bearer $RANKSPIRE_KEY"

3. Add a website

Tracking starts immediately; rankings, backlinks and AI visibility are collected in the background.

curl -X POST https://rankspire.tech/api/v1/websites \
  -H "Authorization: Bearer $RANKSPIRE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"example.com","relationship":"own","tags":["Client"]}'

4. Read Search Console performance

Fetch totals for the last 28 days, or add dimension=query for a keyword breakdown.

curl "https://rankspire.tech/api/v1/websites/cm1site9x0001/search-console?range=28d&dimension=query&limit=20" \
  -H "Authorization: Bearer $RANKSPIRE_KEY"

JavaScript example

Use any HTTP client. The API has no SDK dependency.

const res = await fetch("https://rankspire.tech/api/v1/keywords?websiteId=cm1site9x0001&position=top10", {
  headers: { Authorization: `Bearer ${process.env.RANKSPIRE_KEY}` },
});
const { data } = await res.json();