Link Scraper API

Overview

To use Link Scraper, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

https://api.apiverve.com/v1/linkscraper

Example

How to call the Link Scraper API in different programming languages.

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

const response = await fetch('https://api.apiverve.com/v1/linkscraper', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html",
    "maxlinks": 20,
    "includequery": false
})
});

const data = await response.json();
console.log(data);

import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

payload = {
    "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html",
    "maxlinks": 20,
    "includequery": false
}

response = requests.post('https://api.apiverve.com/v1/linkscraper', headers=headers, json=payload)

data = response.json()
print(data)

package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    payload := map[string]interface{}{
        "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html",
        "maxlinks": "20",
        "includequery": "false"
    }

    jsonPayload, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/linkscraper", bytes.NewBuffer(jsonPayload))

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

{
  "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
  }
}

Authentication

The Link Scraper API requires authentication via API key. Include your API key in the request header:

X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Link Scraper API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Link Scraper API:

Response

The Link Scraper API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <url>http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html</url>
    <linkCount>16</linkCount>
    <externalLinkCount>13</externalLinkCount>
    <internalLinkCount>3</internalLinkCount>
    <links>
      <link>
        <text>Documentation</text>
        <href>http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html/index.html</href>
        <external>false</external>
      </link>
      <link>
        <text>Amazon EC2 Instance Types Guide</text>
        <href>https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-types.html</href>
        <external>true</external>
      </link>
      <link>
        <text>Amazon EC2 Auto Scaling</text>
        <href>https://docs.aws.amazon.com/autoscaling/</href>
        <external>true</external>
      </link>
    </links>
    <uniqueDomains>
      <uniqueDomain>docs.aws.amazon.com</uniqueDomain>
      <uniqueDomain>aws.amazon.com</uniqueDomain>
    </uniqueDomains>
    <maxLinksReached>false</maxLinksReached>
  </data>
</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 Structure

All API responses follow a consistent structure with the following fields:

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Link Scraper through GraphQL to combine it with other API calls in a single request. Query only the link scraper data you need with precise field selection, and orchestrate complex data fetching workflows.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

POST https://api.apiverve.com/v1/graphql

query {
  linkscraper(
    input: {
      url: "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html"
      maxlinks: 20
      includequery: false
    }
  ) {
    url
    linkCount
    externalLinkCount
    internalLinkCount
    links
    uniqueDomains
    maxLinksReached
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Link Scraper API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Link Scraper requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Link Scraper API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Link Scraper

Official Link Scraper packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

JitPack

No-Code Integrations

Link Scraper works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Zapier

Make

Pipedream

n8n

Power Automate

Frequently Asked Questions

People who used this also used...

Based on your interest in Link Scraper, you might also like these APIs:

Website Screenshot

Web Screenshots is a simple tool for capturing screenshots of web pages. It returns an image screenshot of the web page provided.

20 credits per call

Website Images Scraper

Web Image Scraper is a simple tool for scraping images from a website. It returns the URLs of the images found on the website.

10 credits per call

SEO Data Scraper

SEO Scraper is a simple tool for scraping SEO data. It returns the meta title, meta description, and more.

5 credits per call