Quickstart

Create an account

Sign up at rankparse.com/signup with GitHub, Google or an emailed sign-in link. Your workspace starts with 100 free credits, enough for 100 domain authority lookups or about 50 backlink reports.

Create an API key

Open Dashboard, Keys at rankparse.com/dashboard/keys, click New key, name it and click Create. Copy the key now. It is shown once and starts with rp_.

Store it in an environment variable so it stays out of your code:

export RANKPARSE_API_KEY="rp_your_key"

Make your first request

domain-authority costs 1 credit and returns an authority score, referring domain count and domain age for any domain.

curl "https://api.rankparse.com/v1/domain-authority?domain=github.com" \
  -H "X-API-Key: $RANKPARSE_API_KEY"

import os
import requests

resp = requests.get(
    "https://api.rankparse.com/v1/domain-authority",
    params={"domain": "github.com"},
    headers={"X-API-Key": os.environ["RANKPARSE_API_KEY"]},
    timeout=60,
)
resp.raise_for_status()
body = resp.json()

print(body["data"]["score"])
print(body["credits_remaining"])

const resp = await fetch(
  "https://api.rankparse.com/v1/domain-authority?domain=github.com",
  { headers: { "X-API-Key": process.env.RANKPARSE_API_KEY } },
);
if (!resp.ok) throw new Error(`HTTP ${resp.status}: ${await resp.text()}`);

const body = await resp.json();
console.log(body.data.score);
console.log(body.credits_remaining);

Pass domains as bare hostnames such as github.com, not full URLs.

Read the response

Every billable endpoint wraps its result in the same envelope. The values here are illustrative:

{
  "data": {
    "score": 94,
    "referring_domains": 1203455,
    "total_host_count": 2300112,
    "registered_at": "2007-10-09T18:20:50Z",
    "registrar": "MarkMonitor Inc.",
    "popularity_rank": 31,
    "health_score": 96,
    "risk_flags": []
  },
  "domain": "github.com",
  "credits_used": 1,
  "credits_remaining": 99
}

Row-based endpoints such as backlinks also return total and limit, and some return partial: true when part of an answer timed out. See Response format for every field.

Handle errors

Check the HTTP status and branch on the code in the error body:

{
  "error": "Payment Required",
  "code": "insufficient_credits",
  "message": "Add credits at https://rankparse.com/pricing"
}

The most common first-run problems:

The full list is in Errors.