Website Links

List the internal and external links found on a website, incl. broken links. Call the Website Links API via REST or MCP to automate SEO research.

CostEstimated 10 credits / call

Try online

POST · https://api.nexscope.ai/seo/websiteLinksMCP · nexscope_website_links

What this API does

List the internal and external links found on a website, incl. broken links. The request accepts limit, offset, task_id. Its documented result includes broken, direction, dofollow, fromUrl, targetStatusCode, text, toUrl, missingFields.field.

Website Links API use cases

Investigate Website Links

To investigate website links, a search marketer submits limit and offset to Website Links. The returned broken, direction, dofollow help investigate the requested operation.

Collect Website Links evidence

A search marketer uses Website Links with limit and offset to collect website links evidence. The returned broken, direction, dofollow help compare evidence for the requested scope.

Review Website Links results

For this workflow, a search marketer calls Website Links with limit and offset to review website links results. The result helps review the returned facts with the team.

Website Links API FAQ

What does the Website Links API return?

List the internal and external links found on a website, incl. broken links. The documented output includes broken, direction, dofollow, fromUrl, targetStatusCode, text, toUrl, missingFields.field. It corresponds to the supplied limit, offset, task_id. Optional fields can be absent; a missing value should not be interpreted as a measured zero. Example values illustrate the response shape, rather than live account results.

How many credits does the Website Links API cost?

The current documented cost is Estimated 10 credits / call. This is the same cost shown at the top of this page. If a range or estimate is displayed, the final charge depends on the request. Review your available credits and the pricing page before calling the API, and check API usage records for the actual charge.

How do I call the Website Links API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/seo/websiteLinks with your API key as a Bearer token and the JSON inputs shown in API integration. In a compatible MCP client such as Claude or Cursor, connect Nexscope and call nexscope_website_links. Use the MCP arguments shown in the MCP guide, or switch Online test to MCP to review its request before adding it to your app.

View plans and credits Connect this API with MCP

Try this API

Endpoint

https://api.nexscope.ai/seo/websiteLinks

MCP method

nexscope_website_links

Step 1 of 3 · Authenticate

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk-xxxxxxxxxxxxxxxxx

Missing or invalid API keys return an authentication error. Manage keys from .

Step 2 of 3 · Send a request

POSThttps://api.nexscope.ai/seo/websiteLinks

Run an API

Send a JSON request body using the parameters described below.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/seo/websiteLinks' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 20,
  "offset": 0,
  "task_id": ""
}'

Code example

{
  "limit": 20,
  "offset": 0,
  "task_id": ""
}

Step 3 of 3 · Inspect the result

Check the response

Read code for the request status and data for the result. Open the parameter and response reference for the full field definitions.

HTTP status codes

Code	Description
200	Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429	Execution admission rate limit; honor Retry-After when present.
503	Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-in	X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses.

View parameters & response Try online

All categories/ Website & On-Page SEO

POSThttps://api.nexscope.ai/seo/websiteLinks

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Open tester

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/seo/websiteLinks`
Auth	`Bearer API key`
Content-Type	`application/json`

Request parameters

Name	Type	Required	Description
`limit`	`integer`	optional	Limit value used by this API operation. Default: 20 Minimum: 1 Maximum: 100
`offset`	`integer`	optional	Offset value used by this API operation. Default: 0 Minimum: 0 Maximum: 1000
`task_id`	`string`	required	Task id value used by this API operation. Minimum length: 1 Maximum length: 64

Response example

Example response envelope from the documented SEO API contract.

{
  "code": 0,
  "cost": "-1",
  "data": {
    "callId": "synthetic-call",
    "completedAt": null,
    "coverage": {
      "missing": [
        {
          "field": "synthetic",
          "reason": "UPSTREAM_FIELD_MISSING"
        }
      ],
      "status": "PARTIAL"
    },
    "requestedAt": "123",
    "result": {
      "coverage": {
        "invalidItemCount": 1,
        "limit": 1,
        "maxCrawlPages": 9007199254740992,
        "offset": 1,
        "pagesCrawled": 9007199254740992,
        "providerTotal": 9007199254740992,
        "returnedCount": 1,
        "sampled": false,
        "stopReason": "synthetic",
        "truncated": false
      },
      "items": [
        {
          "broken": false,
          "direction": "synthetic",
          "dofollow": false,
          "fromUrl": "synthetic",
          "targetStatusCode": 9007199254740992,
          "text": "synthetic",
          "toUrl": "synthetic",
          "type": "synthetic"
        }
      ],
      "missingFields": [
        {
          "field": "synthetic",
          "reason": "synthetic"
        }
      ],
      "source": {
        "candidateId": "synthetic",
        "collectedAt": 9007199254740992,
        "observationKind": "synthetic",
        "product": "synthetic",
        "provider": "synthetic",
        "queriedAt": 9007199254740992,
        "sourceCallId": "synthetic",
        "sourcePlanVersion": "synthetic",
        "sourceSchemaVersion": "synthetic"
      },
      "warnings": [
        "synthetic"
      ]
    },
    "schemaVersion": "synthetic",
    "source": "synthetic",
    "status": "PARTIAL",
    "usage": {
      "billingStatus": "UNAPPROVED",
      "chargedCredits": "0"
    }
  },
  "msg": null,
  "time": "2026-01-01 00:00:00",
  "traceId": "synthetic-trace",
  "ts": "9007199254740993"
}

Response fields

Name	Type	Required	Description
`code`	`integer`	required	0 is a successful envelope; inspect data.status separately. Allowed: 0, 42008, 42009
`cost`	`string`	required	Elapsed processing milliseconds; not price. -1 for non-web context.
`data`	`object`	required	Data value used by this API operation.
`data.callId`	`string \| null`	optional	Call id value used by this API operation.
`data.completedAt`	`string \| integer \| null`	optional	Completed at value used by this API operation.
`data.coverage`	`object`	optional	Coverage value used by this API operation.
`data.coverage.missing`	`array`	optional	Missing value used by this API operation.
`data.coverage.missing[]`	`object`	required	Item in data coverage missing.
`data.coverage.missing[].field`	`string`	optional	Field value used by this API operation.
`data.coverage.missing[].reason`	`string`	optional	Reason value used by this API operation.
`data.coverage.status`	`string`	optional	Status value used by this API operation.
`data.requestedAt`	`string \| integer \| null`	optional	Requested at value used by this API operation.
`data.result`	`object \| null`	required	Result value used by this API operation.
`data.result.coverage`	`object`	required	Coverage value used by this API operation.
`data.result.coverage.invalidItemCount`	`integer`	required	Invalid item count value used by this API operation. Minimum: 0
`data.result.coverage.limit`	`integer`	required	Limit value used by this API operation. Minimum: 0
`data.result.coverage.maxCrawlPages`	`integer \| null`	required	Max crawl pages value used by this API operation. Minimum: 0
`data.result.coverage.offset`	`integer`	required	Offset value used by this API operation. Minimum: 0
`data.result.coverage.pagesCrawled`	`integer \| null`	required	Pages crawled value used by this API operation. Minimum: 0
`data.result.coverage.providerTotal`	`integer \| null`	required	Provider total value used by this API operation. Minimum: 0
`data.result.coverage.returnedCount`	`integer`	required	Returned count value used by this API operation. Minimum: 0
`data.result.coverage.sampled`	`boolean`	required	Sampled value used by this API operation. Constant: true
`data.result.coverage.stopReason`	`string \| null`	required	Stop reason value used by this API operation.
`data.result.coverage.truncated`	`boolean`	required	Truncated value used by this API operation.
`data.result.items`	`array`	required	Items value used by this API operation. Maximum items: 100
`data.result.items[]`	`object`	required	Item in data result items.
`data.result.items[].broken`	`boolean \| null`	required	Broken value used by this API operation.
`data.result.items[].direction`	`string \| null`	required	Direction value used by this API operation. Allowed: INTERNAL, EXTERNAL, UNKNOWN, null
`data.result.items[].dofollow`	`boolean \| null`	required	Dofollow value used by this API operation.
`data.result.items[].fromUrl`	`string`	required	From url value used by this API operation. Maximum length: 2048
`data.result.items[].targetStatusCode`	`integer \| null`	required	Target status code value used by this API operation. Minimum: 100 Maximum: 599
`data.result.items[].text`	`string \| null`	required	Text value used by this API operation. Maximum length: 4096
`data.result.items[].toUrl`	`string`	required	To url value used by this API operation. Maximum length: 2048
`data.result.items[].type`	`string \| null`	required	Type value used by this API operation. Allowed: ANCHOR, IMAGE, CANONICAL, META, ALTERNATE, REDIRECT, UNKNOWN, null
`data.result.missingFields`	`array`	required	Missing fields value used by this API operation. Maximum items: 10000
`data.result.missingFields[]`	`object`	required	Item in data result missingFields.
`data.result.missingFields[].field`	`string`	required	Field value used by this API operation.
`data.result.missingFields[].reason`	`string`	required	Reason value used by this API operation.
`data.result.source`	`object`	required	Source value used by this API operation.
`data.result.source.candidateId`	`string`	required	Candidate id value used by this API operation. Constant: MD-PW-08
`data.result.source.collectedAt`	`integer \| null`	required	Collected at value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.source.observationKind`	`string`	required	Observation kind value used by this API operation. Constant: CRAWL_SAMPLE
`data.result.source.product`	`string`	required	Product value used by this API operation. Constant: on_page
`data.result.source.provider`	`string`	required	Provider value used by this API operation. Constant: DATAFORSEO
`data.result.source.queriedAt`	`integer`	required	Queried at value used by this API operation. Minimum: 0 Maximum: 9007199254740991
`data.result.source.sourceCallId`	`string \| null`	required	Source call id value used by this API operation.
`data.result.source.sourcePlanVersion`	`string \| null`	required	Source plan version value used by this API operation.
`data.result.source.sourceSchemaVersion`	`string \| null`	required	Source schema version value used by this API operation.
`data.result.warnings`	`array`	required	Warnings value used by this API operation. Maximum items: 1000
`data.result.warnings[]`	`string`	required	Item in data result warnings.
`data.schemaVersion`	`string \| null`	optional	Schema version value used by this API operation.
`data.source`	`string \| null`	optional	Source value used by this API operation.
`data.status`	`string`	optional	Status value used by this API operation. Allowed: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED
`data.usage`	`object \| null`	optional	Usage value used by this API operation.
`data.usage.billingStatus`	`string \| null`	optional	Billing status value used by this API operation.
`data.usage.chargedCredits`	`string \| integer \| null`	optional	Charged credits value used by this API operation.
`msg`	`string \| null`	required	Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry.
`time`	`string`	required	yyyy-MM-dd HH:mm:ss
`traceId`	`string \| null`	required	Trace id value used by this API operation.
`ts`	`string`	required	Epoch milliseconds; global long serializer.

Accepted processing response

code 0 confirms acceptance. Use data.callId to query the same request; processing is not completion.

Name	Type	Required	Description
`code`	`integer`	required	0 is a successful envelope; inspect data.status separately. Constant: 0
`cost`	`string`	required	Elapsed processing milliseconds; not price. -1 for non-web context.
`data`	`object`	required	Data value used by this API operation.
`data.callId`	`string \| null`	required	Call id value used by this API operation.
`data.reason`	`string`	required	Reason value used by this API operation. Constant: IN_PROGRESS
`data.retryable`	`boolean`	optional	Retryable value used by this API operation.
`data.status`	`string`	required	Status value used by this API operation. Constant: PROCESSING
`data.taskId`	`string \| null`	optional	Task id value used by this API operation.
`msg`	`string \| null`	required	Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry.
`time`	`string`	required	yyyy-MM-dd HH:mm:ss
`traceId`	`string \| null`	required	Trace id value used by this API operation.
`ts`	`string`	required	Epoch milliseconds; global long serializer.

Error response

Name	Type	Required	Description
`code`	`integer`	required	0 is a successful envelope; inspect data.status separately.
`cost`	`string`	required	Elapsed processing milliseconds; not price. -1 for non-web context.
`data`	`object`	required	Data value used by this API operation.
`data.callId`	`string \| null`	required	Call id value used by this API operation.
`data.reason`	`string \| null`	required	Reason value used by this API operation.
`data.retryable`	`boolean`	optional	Retryable value used by this API operation.
`data.status`	`string \| null`	required	Status value used by this API operation.
`data.taskId`	`string \| null`	optional	Task id value used by this API operation.
`msg`	`string \| null`	required	Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry.
`time`	`string`	required	yyyy-MM-dd HH:mm:ss
`traceId`	`string \| null`	required	Trace id value used by this API operation.
`ts`	`string`	required	Epoch milliseconds; global long serializer.

Retrieve a processing result

A response withPROCESSING and a callIdmeans the result is still being prepared. Use the result query below with the returned identifier. This lookup reads the stored result and does not spend credits.

curl -X GET https://api.nexscope.ai/seo/websiteLinks/calls/{callId} \
  -H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx"

Responses

Code	Description
200	Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429	Execution admission rate limit; honor Retry-After when present.
503	Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-in	X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses.

Data source, freshness, and limitations

Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.

Step 1 of 2 · Connect your MCP client

MCP

V2 recommended

Connect remote agents through the standard MCP 2025-11-25 Streamable HTTP endpoint. Use OAuth 2.1 Authorization Code with PKCE, or an API key for compatibility.

POST https://api.nexscope.ai/mcp
MCP-Protocol-Version: 2025-11-25
Content-Type: application/json

Authentication

OAuth clients request the mcp:tools scope. The endpoint's 401 response advertises protected-resource metadata for authorization discovery.

Step 2 of 2 · Call the tool

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_website_links",
    "arguments": {
      "limit": 20,
      "offset": 0,
      "task_id": ""
    }
  }
}

Legacy MCP v1

Existing API-key clients can continue using the compatibility endpoint. New integrations should use MCP v2.

GET / POST /mcp/legacy

What can you do with this API?

Data explained and practical use cases

AI Guide

Question

What data can Website Links provide, and how might I use it?

AI answer

Website Links returns link records from a website crawl. Given a crawl task ID, its completed result can show where a link appears, where it points, and what the crawl observed about it.

Data category	Documented fields	What the values mean
Link path	`data.result.items[].fromUrl`, `data.result.items[].toUrl`	The page containing the link and its destination.
Internal or external	`data.result.items[].direction`	Whether the link is classified as `INTERNAL`, `EXTERNAL`, or `UNKNOWN`.
Broken destination	`data.result.items[].broken`, `data.result.items[].targetStatusCode`	A broken-link flag and the destination's observed HTTP status, when available.
Link presentation	`data.result.items[].text`, `data.result.items[].type`	Link text and whether the record is an anchor, image, canonical, meta, alternate, redirect, or unknown type.
Follow attribute	`data.result.items[].dofollow`	Whether the link is marked as followable, when known.
Sample limits	`data.result.coverage.returnedCount`, `data.result.coverage.truncated`, `data.result.missingFields[].reason`	How many records were returned, whether the sample was cut short, and reasons for missing values.

Locate source pages that point to broken destinations so an editor can inspect those links.
- Prompt example: “I am reviewing an ecommerce website. Could you locate source pages that point to broken destinations so an editor can inspect those links? Show matching records and source links where the API provides them; ask me for any required identifier or filter.”
Review external links found in the crawl and their destination status codes.
- Prompt example: “I am reviewing an ecommerce website. Could you review external links found in the crawl and their destination status codes? Show the relevant returned evidence and tell me what input you need from me.”
Inspect anchor text and destination pairs for misleading or unclear navigation.
- Prompt example: “I am reviewing an ecommerce website. Could you inspect anchor text and destination pairs for misleading or unclear navigation? Show the relevant returned evidence and tell me what input you need from me.”
Examine canonical or redirect-type link records separately from ordinary anchors.
- Prompt example: “I am reviewing an ecommerce website. Could you examine canonical or redirect-type link records separately from ordinary anchors? Show the relevant returned evidence and tell me what input you need from me.”

These are sampled crawl observations, not a guaranteed inventory of every site link. A null broken flag or status code does not establish that a destination works.

Online test

Execute the current API with your API key and JSON payload. Online tests use this site's configured API environment; the Endpoint and copyable examples use the public integration address.

Uses your signed-in Nexscope session

SEO API Lab

Website Links

List the internal and external links found on a website, incl. broken links. Call the Website Links API via REST or MCP to automate SEO research.

Live request

Estimated 10 credits / callAPI usage records

Limit

Value sent as the “limit” request parameter.

1–100

Offset

Value sent as the “offset” request parameter.

0–1000

Task id

Value sent as the “task_id” request parameter.

Up to 64 characters

Live calls may use Data credits.

Processing result

If a request is still processing, use the returned identifier to retrieve its stored result. The tester recognizes the identifier automatically, and result queries do not spend credits.

Live response

Results

Your live result will appear here.

Complete the request fields above and run the API. No sample response is substituted.

Test with an API key or MCP

Estimated 10 credits / callAPI usage records

Try it

Send a real request with the same contract shown in the reference.

Endpoint

/seo/websiteLinks

Processing result endpoint

https://api.nexscope.ai/seo/websiteLinks/calls/{resultId}

MCP method

nexscope_website_links

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/seo/websiteLinks \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "limit": 20, "offset": 0, "task_id": "" }'

Response

No response yet. Run the request to see the response here.

Processing result

Use the identifier returned by Run request. The tester selects the correct result query automatically, and result queries do not spend credits.

Result identifier

Result response

No task result yet. Query the task to see the generated output here.

Related APIs

Page SEO Evidence

Collect on-page SEO data for a URL, incl. tags, headings and content.

Page Structured Data

Extract the structured data (schema markup) found on a page.

Page Screenshot

Capture a full-page screenshot of any URL for audits and visual checks.

Website Audit Summary

Get an SEO audit summary of a website, with issues found during a crawl.