Entry: API
DR checker tool API: every parameter and field, explained
Reference for the request shape and the two fields every authenticated response carries. Action-specific rows vary, so test one call before parsing.
The service is a REST API returning JSON. CORS is open. A browser page can call it directly. Keys begin with sk_ and come from the account page after Google sign-in.
The base URL is https://rankupedia.com/api.php. Authenticate with key=sk_... in the query string or with the header Authorization: Bearer sk_..., whichever your client prefers. Four actions need neither: domain, overview, stats and suggest.
A DR checker tool is only useful if you can parse it. Hence the annotated sample below.
One call, annotated
The free overview action. Replace the domain with your own.
curl "https://rankupedia.com/api.php?action=overview&q=nytimes.com"
# authenticated listing, 100 rows per page:
curl -H "Authorization: Bearer sk_live_..." \
"https://rankupedia.com/api.php?action=refdomains&q=nytimes.com&per=100&page=1&order=desc"Anatomy of a request
Choose the action
The action value picks the operation and the price. Free actions are listed in the cost table.
Name the target
The q value is a bare domain such as nytimes.com, without a scheme or a path.
Add credentials if the action is paid
Either key in the query string or the Bearer header. Headers keep keys out of server logs and browser history.
Page and sort
page and per slice the results and sort with order arranges them. Pagination stops at 50,000 rows.
Query parameters
| Parameter | Meaning | Notes |
|---|---|---|
| action | Which operation to run | Required; see the cost table |
| q | Target domain | Example: nytimes.com |
| key | API key | Or use the Bearer header |
| page | Page number of results | Deep pagination is capped at 50,000 |
| per | Rows per page | Accepts 10 to 5000; one call is one charge, at any row count |
| sort | Column to sort by | Available columns depend on the action |
| order | asc or desc | Use together with sort |
| domains | List for bulk_dr | Max 2,000 domains each time, via GET or a POST body |
Fields present in every response
ok
A boolean. True means the call completed. False means it did not, and the HTTP status tells you why.
_credits
Appears on authenticated calls. It reports the cost of this call and your remaining balance in credits, which lets you stop a loop before the balance runs out.
The row-level field names for each action are visible in a live response. We do not reproduce them in this entry so that it cannot drift from the service.
Before deploying a client
- Check ok before reading any other field
- Log _credits on every call
- Treat the data as a monthly snapshot
- Handle 401 and 402 separately, see the troubleshooting entry
- Keep the key out of front-end code
Notes on batching
The bulk_dr action accepts up to 2,000 domains per call. Send them as a domains query value, or as a POST body when the list is too long for a URL.
compare takes up to 20 domains and intersect takes 2 to 10. Intersect answers one question: which sites link to all of the domains you name.
Because billing is per call, bigger batches are always cheaper per row. They also fail as one unit. Chunk by a size you can retry.
Actions by family
| Family | Actions | Typical use |
|---|---|---|
| Free | domain, overview, stats, suggest | Quick lookups and autocomplete |
| Scoring | bulk_dr, compare, dr_distribution | Screening lists and peer sets |
| Listing | refdomains, backlinks, anchors, toppages, anchor_cloud | Auditing one site |
| Search | search, keyword, intersect | Finding who links with a given anchor or to several rivals |
Row-level field names differ by action and are not listed here. Call the endpoint with a free action on a domain you know and read the JSON, which is the only authoritative source.