API reference / REST v1
Backlinks
Link profiles, referring domains, intersections, and outreach opportunities.
All paths below are relative to https://www.agentseo.dev/api/v1. Send your key in x-api-key. Set AGENTSEO_API_KEY in your environment before running the examples. IDs and results are illustrative.
Async result handling · Errors and limits · OpenAPI contract
POST/backlinks/summary
Summarize backlink authority, referring domains, spam risk, broken backlinks, and link distribution signals for a domain, subdomain, or URL. Returns authority tier, risk level, recommended action type, agent_workflow, and markdown_summary. Requests cost 5 credits.
| Name | Type | Description |
|---|---|---|
targetRequired | string | Domain, subdomain, or absolute page URL to analyze. |
include_subdomains | boolean | Include subdomain backlinks for domain targets (default: true) |
include_indirect_links | boolean | Include indirect backlinks in the summary (default: true) |
exclude_internal_backlinks | boolean | Exclude internal backlinks from external authority analysis (default: true) |
backlinks_status_type | enum | live, all, or lost (default: live) |
dofollow_only | boolean | Filter the request to dofollow backlinks only (default: false) |
internal_list_limit | integer | Maximum items in internal distribution arrays, 1-100 (default: 10) |
rank_scale | enum | one_hundred or one_thousand (default: one_hundred) |
curl -X POST https://www.agentseo.dev/api/v1/backlinks/summary?sync=true \
-H "x-api-key: $AGENTSEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target":"agentseo.dev", "include_subdomains":true, "include_indirect_links":true, "exclude_internal_backlinks":true, "backlinks_status_type":"live", "dofollow_only":false, "internal_list_limit":10, "rank_scale":"one_hundred"}'POST/backlinks/list
Return a bounded list of actionable backlinks for a domain, subdomain, or URL. Each backlink is classified for authority protection, broken-target repair, lost-link reclaim, quality review, or outreach reference. Requests cost 5 credits per 100 requested backlinks, minimum 5.
| Name | Type | Description |
|---|---|---|
targetRequired | string | Domain, subdomain, or absolute page URL to analyze. |
mode | enum | as_is, one_per_domain, or one_per_anchor (default: one_per_domain) |
limit | integer | Backlinks to return, 1-100 (default: 25) |
offset | integer | Offset for pagination up to 20,000 (default: 0) |
backlinks_status_type | enum | live, all, or lost (default: live) |
dofollow_only | boolean | Return dofollow backlinks only (default: false) |
broken_only | boolean | Return broken backlinks only (default: false) |
min_rank | integer | Optional minimum backlink rank, 0-100 |
sort_by | enum | rank, page_rank, first_seen, or lost_date (default: rank) |
curl -X POST https://www.agentseo.dev/api/v1/backlinks/list?sync=true \
-H "x-api-key: $AGENTSEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target":"agentseo.dev", "mode":"one_per_domain", "limit":25, "backlinks_status_type":"live", "dofollow_only":false, "broken_only":false, "sort_by":"rank", "rank_scale":"one_hundred"}'POST/backlinks/anchors
Analyze backlink anchor text groups for a domain, subdomain, or URL. Returns anchor intent, risk and repair signals, priority, agent_workflow, and markdown_summary. Requests cost 5 credits per 100 requested anchor groups, minimum 5.
| Name | Type | Description |
|---|---|---|
targetRequired | string | Domain, subdomain, or absolute page URL to analyze. |
limit | integer | Anchor groups to return, 1-100 (default: 25) |
offset | integer | Offset for pagination up to 20,000 (default: 0) |
backlinks_status_type | enum | live, all, or lost (default: live) |
anchor_filter | string | Optional substring filter for anchor text |
min_backlinks | integer | Optional minimum backlink count for an anchor group |
min_referring_domains | integer | Optional minimum referring-domain count for an anchor group |
sort_by | enum | backlinks, rank, referring_domains, spam_score, or broken_backlinks (default: backlinks) |
curl -X POST https://www.agentseo.dev/api/v1/backlinks/anchors?sync=true \
-H "x-api-key: $AGENTSEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target":"agentseo.dev", "limit":25, "backlinks_status_type":"live", "sort_by":"backlinks", "rank_scale":"one_hundred"}'POST/backlinks/referring-domains
Analyze referring domains for a domain, subdomain, or URL. Returns domain rank, backlink and referring-page counts, spam and broken-link signals, action priority, agent_workflow, and markdown_summary. Requests cost 5 credits per 100 requested referring domains, minimum 5.
| Name | Type | Description |
|---|---|---|
targetRequired | string | Domain, subdomain, or absolute page URL to analyze. |
limit | integer | Referring domains to return, 1-100 (default: 25) |
offset | integer | Offset for pagination up to 20,000 (default: 0) |
backlinks_status_type | enum | live, all, or lost (default: live) |
domain_filter | string | Optional substring filter for referring domains |
min_backlinks | integer | Optional minimum backlink count for a referring domain |
min_referring_pages | integer | Optional minimum referring-page count for a referring domain |
min_rank | integer | Optional minimum domain rank |
sort_by | enum | rank, backlinks, referring_pages, spam_score, broken_backlinks, first_seen, or lost_date (default: rank) |
curl -X POST https://www.agentseo.dev/api/v1/backlinks/referring-domains?sync=true \
-H "x-api-key: $AGENTSEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target":"agentseo.dev", "limit":25, "backlinks_status_type":"live", "sort_by":"rank", "rank_scale":"one_hundred"}'POST/backlinks/domain-pages
Analyze backlink-bearing pages for a domain or subdomain. Returns page URL, title, status, backlink and referring-domain counts, broken-link signals, page action priority, agent_workflow, and markdown_summary. Requests cost 5 credits per 100 requested pages, minimum 5.
| Name | Type | Description |
|---|---|---|
targetRequired | string | Domain or subdomain to analyze. |
limit | integer | Pages to return, 1-100 (default: 25) |
offset | integer | Offset for pagination up to 20,000 (default: 0) |
backlinks_status_type | enum | live, all, or lost (default: live) |
page_filter | string | Optional substring filter for page URLs |
title_filter | string | Optional substring filter for page titles |
status_code | integer | Optional HTTP status code filter |
min_backlinks | integer | Optional minimum backlink count for a page |
min_referring_domains | integer | Optional minimum referring-domain count for a page |
sort_by | enum | backlinks, referring_domains, rank, spam_score, broken_backlinks, first_visited, words_count, or external_links (default: backlinks) |
curl -X POST https://www.agentseo.dev/api/v1/backlinks/domain-pages?sync=true \
-H "x-api-key: $AGENTSEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target":"agentseo.dev", "limit":25, "backlinks_status_type":"live", "sort_by":"backlinks", "rank_scale":"one_hundred"}'POST/backlinks/competitors
Discover backlink-profile competitors for a target domain, subdomain, or page URL. Returns competitor domain, authority rank, backlink intersections, overlap score, priority, agent_workflow, and markdown_summary. Requests cost 5 credits per 100 requested competitors, minimum 5.
| Name | Type | Description |
|---|---|---|
targetRequired | string | Domain, subdomain, or absolute page URL to analyze. |
limit | integer | Competitors to return, 1-100 (default: 25) |
offset | integer | Offset for pagination up to 20,000 (default: 0) |
min_rank | integer | Optional minimum competitor authority rank |
min_intersections | integer | Optional minimum shared backlink intersections |
main_domain | boolean | Return competitors at main-domain level when supported (default: true) |
exclude_large_domains | boolean | Exclude very large generic domains from competitor discovery (default: true) |
sort_by | enum | opportunity, rank, or intersections (default: opportunity) |
curl -X POST https://www.agentseo.dev/api/v1/backlinks/competitors?sync=true \
-H "x-api-key: $AGENTSEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target":"agentseo.dev", "limit":25, "min_intersections":3, "sort_by":"opportunity"}'POST/backlinks/new-lost-timeseries
Track new and lost backlinks/referring domains over time. Returns movement points, totals, net changes, loss rate, strongest gain/loss periods, momentum classification, agent_workflow, and markdown_summary. Requests cost 5 credits.
| Name | Type | Description |
|---|---|---|
targetRequired | string | Domain to analyze, without protocol or www. |
date_from | string | Start date in yyyy-mm-dd format. Historical data is available from 2019-01-30. |
date_to | string | End date in yyyy-mm-dd format. Defaults to current provider data if omitted. |
group_range | enum | day, week, month, or year (default: month) |
include_subdomains | boolean | Include target subdomains in backlink movement (default: true) |
curl -X POST https://www.agentseo.dev/api/v1/backlinks/new-lost-timeseries?sync=true \
-H "x-api-key: $AGENTSEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target":"agentseo.dev", "date_from":"2026-01-01", "date_to":"2026-06-30", "group_range":"month"}'POST/backlinks/page-intersection
Find source pages that link to competitor targets but not excluded/user targets. Returns prioritized link-gap opportunities, linked targets, quality signals, agent_workflow, and markdown_summary. Requests cost 5 credits per 100 requested source pages, minimum 5.
| Name | Type | Description |
|---|---|---|
targetsRequired | string[] | Competitor domains, subdomains, or absolute URLs to find shared source pages for. Maximum 5. |
exclude_targets | string[] | Domains, subdomains, or absolute URLs to exclude, usually your own domain. Maximum 5. |
limit | integer | Source pages to return, 1-100 (default: 25). |
backlinks_status_type | enum | live, all, or lost (default: live) |
dofollow_only | boolean | Only return dofollow source links when true. |
intersection_mode | enum | partial or all (default: partial). Use all for broader scans that may take longer. |
max_spam_score | integer | Optional maximum source spam score, 0-100. |
sort_by | enum | rank, domain_rank, page_rank, first_seen, or last_seen (default: rank) |
curl -X POST https://www.agentseo.dev/api/v1/backlinks/page-intersection?sync=true \
-H "x-api-key: $AGENTSEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"targets":["hubspot.com","salesforce.com"], "exclude_targets":["agentseo.dev"], "limit":25, "intersection_mode":"partial", "sort_by":"rank"}'POST/backlinks/opportunity-finder
Turn supplied backlink prospects, competitor link-gap exports, and owned linkable assets into prioritized safe outreach, reclaim, repair, and digital PR actions. Requests cost 2 credits and do not call a paid backlink provider directly.
| Name | Type | Description |
|---|---|---|
targetRequired | string | Target domain, brand, or site. |
prospectsRequired | object[] | Backlink prospect/source rows. Each needs source_domain; add source_url, title, source_type, linked_competitors, topics, rank/domain_rank/page_rank, spam_score, dofollow, broken_link, or lost_link for stronger scoring. |
owned_assets | object[] | Owned pages or assets that could earn links. Include url, title, page_type, topics, and linkable_reason. |
campaign_goal | enum | mixed, link_gap, broken_link_building, digital_pr, resource_page, reclaim_lost_links, or protect_authority. |
max_spam_score | integer | Maximum spam score allowed for outreach candidates, 0-100 (default: 35). |
min_priority | enum | low, medium, or high (default: medium). |
curl -X POST https://www.agentseo.dev/api/v1/backlinks/opportunity-finder?sync=true \
-H "x-api-key: $AGENTSEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target":"agentseo.dev","campaign_goal":"link_gap","prospects":[{"source_domain":"example.org","source_url":"https://example.org/best-seo-tools","title":"Best SEO Tools","source_type":"resource_page","linked_competitors":["semrush.com","ahrefs.com"],"topics":["seo tools","seo api"],"domain_rank":72,"page_rank":58,"spam_score":3,"dofollow":true}],"owned_assets":[{"url":"https://www.agentseo.dev/docs/api-reference","title":"AgentSEO API Reference","page_type":"guide","topics":["seo api","seo tools"],"linkable_reason":"Detailed API reference for builders comparing SEO tooling."}]}'