ScrepyDocs

Backlinks

Analyze project and added competitor backlinks, referring domains, link gaps, and lost or broken links through the REST API.

Choose the project or an added competitor

Start with backlink options to discover eligible targets, competitor IDs, sorting columns, and limits. Backlink access must be available on the project's plan. To research a new competitor, add it to the project in the dashboard first; arbitrary domains are not accepted.

Use the target query parameter for backlinks, profile overview, and referring domains. It defaults to the project's domain. The domain parameter on the source-domain detail endpoint identifies the referring domain, not the domain being researched.

curl 'https://api.screpy.com/v1/projects/PROJECT_UID/backlinks?target=example.com&limit=50' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace PROJECT_UID with an accessible project UID and example.com with an added competitor returned by options. Backlink Gap takes one competitor_id; lost and broken domain reports use the project's own domain. Source-domain link details support live, lost, and broken statuses, with lost and broken restricted to the project.

Pagination and exports

Lists default to 50 rows with a maximum of 100. Follow meta.next_cursor or links.next without changing the target, limit, sorting, or other selectors. An empty successful response means no matching rows; unavailable optional metrics remain null, and temporary failures return an error.

Table export downloads one selected page as CSV or XLSX, not the complete dataset. Continue with the X-Next-Cursor response header when you need more pages. Disavow management is a separate workflow.

See the Backlinks dashboard guide, Backlink Checker, and MCP tool reference.

Endpoints

Choose the endpoint that matches the smallest unit of data or action your integration needs. Each endpoint page documents one request so the reference remains fast and focused.

Eligible targets and supported input options

Eligible targets and supported input options. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

Backlink profile summary, history, and top breakdowns

Backlink profile summary, history, and top breakdowns. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

List backlinks

List backlinks. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

List referring domains

List referring domains. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

List backlinks from one full source domain

List backlinks from one full source domain. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

Competitor backlink gap and comparison history

Competitor backlink gap and comparison history. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

List domains with lost project backlinks

List domains with lost project backlinks. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

List domains with broken project backlinks

List domains with broken project backlinks. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

Download the current result page as CSV or XLSX

Download the current result page as CSV or XLSX. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

On this page