Discover the URLs a page or sitemap points at in a single fetch. Point it at an XML sitemap or sitemap-index and it returns the <loc> URLs; point it at an HTML page and it returns the <a href> links — auto-detected. URLs are resolved to absolute, de-duplicated, fragment-stripped, and http(s)-only. `limit` (1-2000, default 200) caps the count; `sameHostOnly` keeps only links on the same host. Single SSRF-guarded fetch, no JavaScript, stateless — NOT a recursive crawler: to go deeper, call map again on a child sitemap or a discovered page. Returns { url, finalUrl, source: "sitemap"|"links", count, capped, urls }.
/api/url/mapPAYMENT-SIGNATURE.The map API is a pay-per-call url endpoint built for AI agents and autonomous software. Discover the URLs a page or sitemap points at in a single fetch.
There is no signup and no API key. An agent (or any HTTP client) hits the endpoint, receives an x402 "402 Payment Required" challenge, signs a sub-cent USDC payment on Base or Solana, and retries — the data comes back on the paid request. That makes it a drop-in map data source for an agent tool-use loop, an MCP host, or a backend that needs url data on demand without onboarding to yet another vendor portal.
| Name | Type | Description |
|---|---|---|
urlrequired | string | max 2048 chars · uri |
limit | integer | min 1 · max 2000 |
sameHostOnly |
# 1. Probe with no auth → 402 envelope with PaymentRequirements curl -sS 'https://2s.io/api/url/map?url=https%3A%2F%2Fexample.com&limit=200&sameHostOnly=false' # 2. Sign + retry with PAYMENT-SIGNATURE: curl -sS 'https://2s.io/api/url/map?url=https%3A%2F%2Fexample.com&limit=200&sameHostOnly=false' \ -H 'PAYMENT-SIGNATURE: <base64-json-payload>' # Or use the canonical runner (handles probe → sign → retry): # EVM_PRIVATE_KEY=0x... node --env-file=.env.local \ # --experimental-strip-types scripts/x402-pay.ts \ # 'https://2s.io/api/url/map?url=https%3A%2F%2Fexample.com&limit=200&sameHostOnly=false'
import { TwoS } from '@2sio/sdk'
const client = new TwoS({
privateKey: process.env.EVM_PRIVATE_KEY as `0x${string}`,
})
const result = await client.url.map({
"url": "https://example.com",
"limit": 200,
"sameHostOnly": false
})
console.log('endpoint:', result.endpoint)
console.log('cost:', result.costUsd, 'USDC')
console.log('tx:', result.settlement?.txHash)
console.log('data:', result.data)import os
from twosio import TwoS
client = TwoS(private_key=os.environ["EVM_PRIVATE_KEY"])
result = client.url.map(url="https://example.com", limit=200, sameHostOnly=False)
print("endpoint:", result.endpoint)
print("cost:", result.cost_usd, "USDC")
print("tx:", (result.settlement or {}).get("tx_hash"))
print("data:", result.data)// 1. Add @2sio/mcp to your MCP host config (Claude Desktop example below).
// EVM_PRIVATE_KEY funds x402 payments per call.
// claude_desktop_config.json
{
"mcpServers": {
"2sio": {
"command": "npx",
"args": ["-y", "@2sio/mcp"],
"env": { "EVM_PRIVATE_KEY": "0x..." }
}
}
}
// 2. Once the server is running, agents call this tool via standard MCP:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "url.map",
"arguments": {
"url": "https://example.com",
"limit": 200,
"sameHostOnly": false
}
}
}| Field | Type | Description |
|---|---|---|
url | string | |
finalUrl | string | |
source | string | one of: sitemap | links |
count | number | |
capped | boolean | |
urls | array |
{
"url": "example",
"finalUrl": "example",
"source": "sitemap",
"count": 1,
"capped": false,
"urls": [
"example"
]
}