Generate a PDF backlink report for a domain and email a download link to an address.

POSThttps://api.rankparse.com/v1/tools/backlink-reportFree (1 per email, 3 per IP per day)Turnstile

Powers the "email me a backlink report" form. It builds a PDF with the domain's authority, referring domain and backlink counts, registration date and popularity rank, the top 25 referring domains and 30 sample backlinks, then emails a link to download it. Like the other free tools it requires a Turnstile token in the cf-turnstile-response header. It does not use the per-tool allowance of the GET tools.

Because the result goes to the email address you supply, this is not a data API. To pull backlink data into your own tools, use Backlinks.

Body parameters

domainstringrequired

Domain to report on. An invalid value returns 400 invalid_domain.

emailstringrequired

Address to send the link to. Trimmed and lowercased; at most 254 characters. An invalid value returns 400 invalid_email.

api_keystring

Optional RankParse API key (rp_...). When it belongs to an agency workspace, the report is white-labelled with the workspace's stored brand name, color and logo, the email names the agency instead of RankParse, and the per-email and per-IP limits do not apply. Any other key changes nothing beyond the stored brand name and color.

brand_namestring

Brand name for the report header, cut to 60 characters. Overrides the stored brand name.

brand_colorstring

Accent color as a 6-digit hex value, with or without #. Overrides the stored color; anything that is not RRGGBB falls back to the default accent.

Response

successboolean

true once the report is generated and the email sent.

messagestring

A confirmation naming the domain and address.

Behavior and limits

Limits: one report per email address and 3 per IP address (IPv6 grouped by /64) per UTC day, both resetting at midnight UTC. Agency keys are exempt.
Retry on failure: when generation fails, the reservation against both limits is released so the visitor can try again.
Download link: valid for 24 hours.

Errors

HTTP	Code	When
400	`invalid_body`	The body is not JSON.
400	`invalid_domain`	`domain` is missing or invalid.
400	`invalid_email`	`email` is missing or invalid.
403	`turnstile_failed`	Missing or invalid Turnstile token.
429	`email_quota_exceeded`	A report was already sent to this address today.
429	`ip_quota_exceeded`	This IP address has requested 3 reports today.
500	`report_failed`	The report could not be generated or emailed.
503	`turnstile_unconfigured`	The service is misconfigured.

Download a backlink report

The link the email contains.

Check backlinks

The same data as JSON in the browser.

curl -X POST "https://api.rankparse.com/v1/tools/backlink-report" \
  -H "cf-turnstile-response: <token from the Turnstile widget>" \
  -H "Content-Type: application/json" \
  -d '{"domain": "stripe.com", "email": "you@example.com"}'

Response

{
  "success": true,
  "message": "Your backlink report for stripe.com is on its way to you@example.com!"
}

429 email_quota_exceeded

{
  "error": "Too Many Requests",
  "code": "email_quota_exceeded",
  "message": "One free report per email per day. Check your inbox, we already sent one!"
}

Email a backlink report

Body parametersCopy Anchor Link

ResponseCopy Anchor Link

Behavior and limitsCopy Anchor Link

ErrorsCopy Anchor Link

RelatedCopy Anchor Link

Download a backlink report

Check backlinks

Body parameters

Response

Behavior and limits

Errors

Related