Link Scraper API

POST

Extract every internal and external link from any webpage.

Link Scraper extracts internal and external links from any webpage URL in real time. It resolves relative paths to absolute URLs, strips empty fragments, and returns anchor text with internal and external counts.

Try it — live request, no key required

Request

POSTapi.apiverve.com/v1/linkscraper

Body

urlstring

Verification

Format

No key required to try it. Get a key to use it in your app.

Example

{
  "status": "ok",
  "error": null,
  "data": {
    "url": "http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html",
    "linkCount": 16,
    "externalLinkCount": 13,
    "internalLinkCount": 3,
    "links": [
      {
        "text": "Documentation",
        "href": "http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html/index.html",
        "external": false
      },
      {
        "text": "Amazon EC2 Instance Types Guide",
        "href": "https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-types.html",
        "external": true
      },
      {
        "text": "Amazon EC2 Auto Scaling",
        "href": "https://docs.aws.amazon.com/autoscaling/",
        "external": true
      }
    ],
    "uniqueDomains": [
      "docs.aws.amazon.com",
      "aws.amazon.com"
    ],
    "maxLinksReached": false
  }
}

About the Link Scraper API

Link Scraper works by parsing the HTML content of a web page to extract all the links. It returns the links in a structured format, including the link URL, title, and more.

What people use it for

Site Architecture Audits: Crawlers inspect internal navigation paths and anchor text across catalog pages to detect orphan URLs and track link equity distribution.
Dead Link Discovery: Run published articles through the scraper to catch external links, resolve relative URLs, and forward destination targets to status checkers.
Competitor Footprint Mapping: Growth analysts feed rival blog posts into the endpoint to inventory citation targets and detect outbound partner referrals.
Web Archival Pipelines: When archiving resource directories, extract all outbound destinations and clean anchor text before caching document references.

Ways to call it

One endpoint, many ways in — REST with JSON, XML, YAML and CSV, plus GraphQL and an MCP interface for AI agents.

JSON: Default REST response
XML: Markup format
YAML: Human-readable
CSV: Tabular export
GraphQL: Query language
MCP: For AI agents

View all integrations →

Questions.

Common questions about the Link Scraper API.

Read the docs →

Is it cheap enough to scrape links for every page in my crawl?

Yes. Each scrape costs 10 credits, which works out to about $0.0015 per call or $1.50 per 1,000 pages on the Starter plan. The Free plan gives you 20 calls each month with no credit card required.

Do I get the unique domains list on the Free plan?

No. The unique external domains list and custom link extraction limits require a paid subscription. Any paid plan unlocks these premium features.

Does it convert relative links into full URLs?

Yes. The API automatically resolves root-relative paths into absolute destination URLs. It also extracts visible anchor text, calculates internal and external link counts, and strips out empty anchors and fragment links.

How do I know if a page had more links than were returned?

Check the maxLinksReached field in the response. When true, the target page contained more links than your requested limit, indicating additional links exist beyond what was returned.

Are the links fetched in real time?

Yes. Link Scraper parses the live HTML of the target URL in real time upon each request. It extracts current links and anchor text directly from the live page rather than serving cached results.

Can I use the scraped link data in my commercial tool?

Yes, as long as you are on a paid plan. Commercial use is permitted across all paid plans to power features inside your own product, provided you do not resell or redistribute the raw scraped data as-is.

Request parameters — POST /v1/linkscraper

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them. Anything not listed here is dropped rather than passed through.

Required

Parameter	Type	Example	Description
`url`Required	string	`https://en.wikipedia.org/wiki/Web_scraping`	The URL of the web page to scrape links from url

Optional

Parameter	Type	Example	Description
`maxlinks`OptionalPremium	number	`50`	Maximum number of links to scrape and return default 50
`includequery`Optional	boolean	`false`	Include query strings in the scraped links default false

Example request

curl -X POST "https://api.apiverve.com/v1/linkscraper" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html","maxlinks":20,"includequery":false}'

Authentication

Send your key in the x-api-key header. That is the only auth step — no token exchange, and no per-endpoint scope to configure.

Header	When	Value
`x-api-key`Required	Every request	Your API key. Header names are case-insensitive, so `X-API-Key` is the same header.
`Authorization`Alternate	Instead of the above	`Bearer <key>` — for clients that only expose bearer auth. Resolves to the same account and the same billing.
`content-type`Required	POST body	`application/json`

401 is the only auth verdict

A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.

Response — POST /v1/linkscraper

Every APIVerve endpoint returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape.

Sample response

{
  "status": "ok",
  "error": null,
  "data": {
    "url": "http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html",
    "linkCount": 16,
    "externalLinkCount": 13,
    "internalLinkCount": 3,
    "links": [
      {
        "text": "Documentation",
        "href": "http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html/index.html",
        "external": false
      },
      {
        "text": "Amazon EC2 Instance Types Guide",
        "href": "https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-types.html",
        "external": true
      },
      {
        "text": "Amazon EC2 Auto Scaling",
        "href": "https://docs.aws.amazon.com/autoscaling/",
        "external": true
      }
    ],
    "uniqueDomains": [
      "docs.aws.amazon.com",
      "aws.amazon.com"
    ],
    "maxLinksReached": false
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Field	Type	Example	Description
`url`	string	`"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html"`	The scraped page's URL, normalized to a bare http:// origin with any tabs, newlines and carriage returns stripped
`linkCount`	number	`16`	Total number of links returned, after filtering out empty anchors and page-fragment links
`externalLinkCount`	number	`13`	Number of returned links that point to a different domain than the scraped page
`internalLinkCount`	number	`3`	Number of returned links that point to the same domain as the scraped page
`links`	array[3]		Every link found on the page, up to the requested limit
`text`	string	`"Documentation"`	The link's visible anchor text, with tabs, newlines and carriage returns removed
`href`	string	`"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html/index.html"`	The link's destination URL, resolved to an absolute URL when the source was root-relative
`external`	boolean	`false`	Whether the link points to a different domain than the scraped page
`uniqueDomains`Premium	array	`[docs.aws.amazon.com, ...]`	List of unique external domains found
`maxLinksReached`	boolean	`false`	Whether the number of links found met or exceeded the maximum link limit, meaning more links may exist beyond what was returned

Response headers

Every response carries your balance, so your own code always knows where it stands without polling anything. All four are exposed to browsers through CORS.

Header	What it carries
`x-api-remaining-credits`	Credits left in the current cycle
`x-api-credits-used`	Credits spent in the current cycle
`x-api-max-credits`	The allowance for the cycle
`x-api-version`	Version of the endpoint that answered

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change.

Status	Meaning	What to do
`400`	Input was rejected	Read `error`; it names the parameter that has to change.
`401`	Key missing or invalid	Check the header name and the key value.
`403`	Key valid, but not permitted here	A key restriction or an IP allow-list — never a bad key.
`429`	Rate limited, or out of credits	Read `error` to tell them apart, then back off or top up.

What a call costs — 10 credits per call

Credits are shared across every APIVerve API — one balance, one key, one bill. Failed requests never count against it, so a rejected input costs nothing.

Plan	Per month	Credits	Link Scraper calls	Per 1,000 calls
Free	Free	200	20	Free
Starter	$29.99	200,000	20,000	$1.50
Pro	$99.99	1,000,000	100,000	$1.00
Mega	$299.99	4,000,000	400,000	$0.75

Calls are what the credits buy at this API's rate — spend them here, on any of the other APIs, or across both. Nothing is reserved per endpoint.

Compare all pricing tiers →

Call it from cURL — POST /v1/linkscraper

No SDK to install — this is a plain HTTPS call to /v1/linkscraper with your key in the x-api-key header. Swap in a real key and it runs as-is.

cURL

1
2

curl "https://api.apiverve.com/v1/linkscraper" \
  -H "x-api-key: YOUR_API_KEY"

Resources

GitHubapiverve/linkscraper-apiSource, issues and the examples this page is built from.ReferenceLink Scraper API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/linkscrapernpm apiverve-linkscraperPyPI APIVerve.API.LinkScraperNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Node.js — POST /v1/linkscraper

Install the Node.js SDK, then call the Link Scraper API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — npm

npm install @apiverve/linkscraper

Node.js

const res = await fetch("https://api.apiverve.com/v1/linkscraper", {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const { data } = await res.json();
console.log(data);

Resources

npm@apiverve/linkscraperThe published Node.js client, versioned and signed.GitHubapiverve/linkscraper-apiSource, issues and the examples this page is built from.ReferenceLink Scraper API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

apiverve-linkscraperPyPI APIVerve.API.LinkScraperNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Python — POST /v1/linkscraper

Install the Python SDK, then call the Link Scraper API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — PyPI

pip install apiverve-linkscraper

Python

import requests

res = requests.get(
    "https://api.apiverve.com/v1/linkscraper",
    headers={"x-api-key": "YOUR_API_KEY"},
)
print(res.json()["data"])

Resources

PyPIapiverve-linkscraperThe published Python client, versioned and signed.GitHubapiverve/linkscraper-apiSource, issues and the examples this page is built from.ReferenceLink Scraper API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/linkscrapernpm APIVerve.API.LinkScraperNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from C# / .NET — POST /v1/linkscraper

Install the C# / .NET SDK, then call the Link Scraper API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — NuGet

dotnet add package APIVerve.API.LinkScraper

C# / .NET

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");

var json = await client.GetStringAsync("https://api.apiverve.com/v1/linkscraper");
Console.WriteLine(json);

Resources

NuGetAPIVerve.API.LinkScraperThe published C# / .NET client, versioned and signed.GitHubapiverve/linkscraper-apiSource, issues and the examples this page is built from.ReferenceLink Scraper API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/linkscrapernpm apiverve-linkscraperPyPI

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Go — POST /v1/linkscraper

No SDK to install — this is a plain HTTPS call to /v1/linkscraper with your key in the x-api-key header. Swap in a real key and it runs as-is.

req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/linkscraper", nil)
req.Header.Set("x-api-key", "YOUR_API_KEY")

res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))

Resources

Also published for

@apiverve/linkscrapernpm apiverve-linkscraperPyPI APIVerve.API.LinkScraperNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from PHP — POST /v1/linkscraper

No SDK to install — this is a plain HTTPS call to /v1/linkscraper with your key in the x-api-key header. Swap in a real key and it runs as-is.

PHP

$ch = curl_init("https://api.apiverve.com/v1/linkscraper");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-api-key: YOUR_API_KEY"]);

$response = curl_exec($ch);
echo $response;

Resources

Also published for

@apiverve/linkscrapernpm apiverve-linkscraperPyPI APIVerve.API.LinkScraperNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Ruby — POST /v1/linkscraper

No SDK to install — this is a plain HTTPS call to /v1/linkscraper with your key in the x-api-key header. Swap in a real key and it runs as-is.

Ruby

require "net/http"

uri = URI("https://api.apiverve.com/v1/linkscraper")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

Resources

Also published for

@apiverve/linkscrapernpm apiverve-linkscraperPyPI APIVerve.API.LinkScraperNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

All articles →

Extract Clean Content from Any WebpageTurn messy web pages into clean Markdown. Perfect for content migration, archiving, AI training data, and building read-later tools.Read

Automating Visual Testing With ScreenshotsCatch visual bugs before users do. Here's how to add screenshot-based testing to your workflow.Read

Take Your App Multilingual (No Rewrite)Add language support to an existing app without rearchitecting. Practical strategies for translation, detection, and localization.Read

Link Scraper API

Try it — live request, no key required

About the Link Scraper API

What people use it for

Ways to call it

Other ways to use Link Scraper

Questions.

Request parameters — POST /v1/linkscraper

Required

Optional

Authentication

Response — POST /v1/linkscraper

Response fields

Response headers

Errors

What a call costs — 10 credits per call

Call it from cURL — POST /v1/linkscraper

Resources

Also published for

Call it from Node.js — POST /v1/linkscraper

Resources

Also published for

Call it from Python — POST /v1/linkscraper

Resources

Also published for

Call it from C# / .NET — POST /v1/linkscraper

Resources

Also published for

Call it from Go — POST /v1/linkscraper

Resources

Also published for

Call it from PHP — POST /v1/linkscraper

Resources

Also published for

Call it from Ruby — POST /v1/linkscraper

Resources

Also published for

Zero-code embed — one snippet, no backend

Changelog — Link Scraper API

Data Scraping

Related articles

Ready to build with Link Scraper? Start with 200 free credits — one key unlocks all 300+ APIs.

Explore the catalog