API Documentation

Complete reference for the Lynk API Platform. Base URL: https://api.lynk.run

🔑 Authentication 🔌 MCP Server 🌐 BGP ASN Lookup 🏢 Company Search 🔍 IP & Domain Intel 🔭 Web Search 🧱 Tech Scanner 📈 GEO Tracker 📁 File Sharing 📇 CRM & Outreach ⚡ Rate Limits

Code examples show the placeholder YOUR_API_KEY. Log in to use your real key here.

Authentication

Authenticate your requests using your API key. You can pass it in two ways:

Option 1: Bearer Token (recommended)

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.lynk.run/bgp/v1/asn/34309

Option 2: URL Parameter

bash

curl "https://api.lynk.run/bgp/v1/asn/34309?key=YOUR_API_KEY"

Public Access

You can also make unauthenticated requests using the public key openusage, limited to 5 requests per day per IP address.

bash

curl "https://api.lynk.run/bgp/v1/asn/34309?key=openusage"

MCP ServerOAuth 2.1

Connect Claude Desktop, Cursor, Cline, or any MCP-compatible client to Lynk via OAuth 2.1 with PKCE. Your IDE agent can then call the Intel, BGP, Scrape, and Files APIs as native tools — no API key in config files.

Server URL

https://api.lynk.run/mcp

Streamable HTTP transport. On first launch your client opens a browser tab to sign in and approve the requested scopes.

Available scopes

intel — IP & domain lookups
bgp — company → ASNs + IP prefixes
domains — domain availability checker
search — Google web-search results (JSON or Markdown)
scrape — web pages, crawls, LLM extract
files — manage your shared files
request — generic Lynk-API escape hatch
deskpro — tickets, people, KB across your Deskpro instances
netsuite — read-only SuiteQL + record lookups + File Cabinet downloads (vendor-bill PDFs) on your NetSuite accounts
salesforce — read-only SOQL/SOSL queries against your Salesforce orgs
tech — BuiltWith-backed tech-stack lookup, sites-using-a-tech, adoption trends
crm — contacts, companies, activities, templates, draft campaigns
geo — GEO Tracker projects + AI-search visibility reports
personio — read-only HR + recruiting on your Personio tenants (sensitive fields redacted)
canvas — publish + manage hosted HTML/Markdown pages and their KV store
browser — Cloud Browser: drive a server-side browser (navigate, click, type, screenshot, read pages); watch live + take over for logins/2FA
gmail — read, search, send & organise email in your connected Gmail accounts
wordpress — read & write posts, pages & media on connected WordPress sites

Setup wizard & client management

Copy-paste configs for Claude Desktop / Cursor / Cline and revoke buttons for any authorized client live at /settings/mcp.

For AI agents

Spec + tool catalog: https://api.lynk.run/mcp/llms.txt

BGP ASN Lookup API1 token

Look up BGP routing data for any ASN. Returns upstreams, peers, customers with IPv4/IPv6 breakdown, powered by CAIDA data.

Endpoint

GET /bgp/v1/asn/:asn

Parameters

Parameter	Type	Description
asn	integer	The Autonomous System Number to look up (1-4294967295)

Example Request

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.lynk.run/bgp/v1/asn/34309

Example Response

json

{
  "asn": 34309,
  "name": "LINK11",
  "description": "Link11 GmbH",
  "country": "DE",
  "upstreams": {
    "ipv4": [
      { "asn": 1299, "name": "TWELVE99", "description": "Arelion Sweden AB" },
      { "asn": 174, "name": "COGENT-174", "description": "Cogent Communications" }
    ],
    "ipv6": [
      { "asn": 6939, "name": "HURRICANE", "description": "Hurricane Electric LLC" }
    ]
  },
  "peers": { "ipv4": [...], "ipv6": [...] },
  "customers": { "ipv4": [...], "ipv6": [...] },
  "upstream_count": { "ipv4": 4, "ipv6": 4 },
  "peer_count": { "ipv4": 67, "ipv6": 67 },
  "customer_count": { "ipv4": 56, "ipv6": 56 },
  "queried_at": "2026-03-30T10:00:00Z",
  "source": "CAIDA AS Relationships",
  "provider": "local-caida"
}

BGP Company Search APIPublic

Search for a company by name, organization, or domain. Returns all matching ASNs with their IPv4 prefixes, total IP count, and BGP relationship counts (upstreams, peers, customers). No API key required.

Endpoint

GET /bgp/v1/company/search?q=:query

Parameters

Parameter	Type	Description
q	string	Company name, organization, or domain (min 2 chars)
limit	integer	Max results to return (default 10, max 20)

Example Request

bash

curl "https://api.lynk.run/bgp/v1/company/search?q=Deutsche+Telekom"

Example Response

json

{
  "query": "Deutsche Telekom",
  "results": [
    {
      "asn": 3320,
      "name": "DTAG",
      "org": "Deutsche Telekom AG",
      "domain": "telekom.de",
      "country": "DE",
      "prefixes": [
        { "start": "62.156.0.0", "end": "62.156.255.255", "country": "DE", "size": 65536 }
      ],
      "prefix_count": 847,
      "total_ips": 12583424,
      "relationships": { "upstreams": 5, "peers": 312, "customers": 1480 }
    }
  ],
  "total_asns": 3,
  "total_ips": 13107200,
  "total_prefixes": 952,
  "iptoasn_loaded": true,
  "queried_at": "2026-03-30T12:00:00Z"
}

Rate Limits

10 requests per minute per IP. No API key required.

IP & Domain Intelligence APIAuth Required

Comprehensive IP and domain intelligence. Aggregates 15+ data sources: geo-location (7 providers), ASN, privacy detection, 73 DNSBL blacklists, WHOIS, SSL certificates, DNS records, and mail provider detection.

Endpoints

GET /ip/v1/lookup/:targetGET /ip/v1/lookup/me

Parameters

Parameter	Type	Description
target	string	IPv4/IPv6 address or domain name (or `me` for own IP)
mode	string	`lite` (~10-50ms, local MMDB only) or `full` (~1-5s, all sources incl. DNSBL, WHOIS, SSL). Default: full

Example: IP Lookup

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.lynk.run/ip/v1/lookup/8.8.8.8"

Example: Domain Lookup

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.lynk.run/ip/v1/lookup/github.com"

Example Response (IP)

json

{
  "query": "8.8.8.8",
  "type": "ip",
  "ip": "8.8.8.8",
  "ip_version": "IPv4",
  "bogon": false,
  "rdns": "dns.google",
  "sources": {
    "provider_a": {
      "geo": { "city": null, "country": "US", "country_name": "United States" },
      "network": { "asn": 15169, "org": "GOOGLE", "network": "8.8.8.0/24" }
    },
    "provider_b": { "..." : "..." },
    "provider_c": { "..." : "..." }
  },
  "privacy": {
    "vpn": false, "proxy": false, "tor": false,
    "hosting": true, "cloud_provider": "GCP"
  },
  "risk": {
    "ip_blacklisted": false,
    "ip_blacklist_count": 0,
    "ip_blacklists": []
  }
}

Example Response (Domain)

json

{
  "query": "github.com",
  "type": "domain",
  "ip": "140.82.121.3",
  "resolved_ips": { "a": ["140.82.121.3"], "aaaa": [] },
  "dns": { "mx": [...], "ns": [...], "txt": [...] },
  "mail": { "provider": "Google Workspace", "mx_records": [...] },
  "whois": { "registrar": "MarkMonitor", "created": "2007-10-09" },
  "ssl": { "issuer": "DigiCert", "days_remaining": 215, "sans": [...] },
  "risk": {
    "ip_blacklisted": false,
    "domain_blacklisted": false,
    "mx_blacklisted": false
  }
}

Rate Limits

30 lookups per minute per IP.

Use with Claude.aiSkill

Drop the lynk-domain-intel Skill into Claude.ai and it will use this API automatically — single lookups (“who registered example.com?”) and bulk (“give me the registrar + mail provider for these 20 domains”) both work out of the box.

Download Skill

Skill ships without an API key (public rate limit applies). Log in to bake your key in. Install: claude.ai → Settings → Capabilities → Skills → Upload skill.

Web Search API1 token / 10 results

Google web-search results via serper.dev: organic results plus answer box, knowledge graph, “people also ask” and related searches when present. Returns JSON by default, or an LLM-friendly Markdown document when you pass format=markdown — drop the response straight into a prompt. Try the playground at /search.

GET — single query (curl-friendly)

curl 'https://api.lynk.run/search/v1/web?q=claude+code&num=10' \
-H 'Authorization: Bearer YOUR_API_KEY'

POST — batch (max 10 queries)

curl https://api.lynk.run/search/v1/web \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "queries": ["lynk run", "serper.dev"], "gl": "de", "hl": "de", "num": 30, "format": "json" }'

Markdown output (LLM-friendly)

Pass format=markdown (query string or JSON body) — the response Content-Type is text/markdown and the body is a rendered document with answer box / organic results / PAA / related searches.

curl 'https://api.lynk.run/search/v1/web?q=lynk+run&format=markdown' \
-H 'Authorization: Bearer YOUR_API_KEY'

Pricing — proportional to `num`

Just tell us how many results you want — we paginate Google internally. Cost is 1 token per 10 results, rounded up. If Google runs out before reaching your num, you only pay for the pages we actually fetched.

num	tokens (worst case)	note
10 (default)	1	single Google page
20	2
50	5
100	10
200 (max)	20	Google's practical ceiling

Defaults & limits

gl=de (country) · hl=de (language) · num=10
num 1–200; over 200 → 400 Bad Request
Max 10 queries per POST batch
Unauthenticated: 20 / minute / IP, no token cost
answer_box, knowledge_graph, people_also_ask and related_searches are only present when Google returns them
Response shape: { query, gl, hl, num (returned), requested, fetched_at, organic[], ... }

Tech Scanner API5 tokens / lookup

BuiltWith-backed tech-stack lookup. Three endpoints under /tech/v1/*: lookup (domain → stack), sites (sites using a given tech, paginated), trends (adoption coverage). Heavily cached (30d / 7d / 24h) so repeated lookups stay affordable. Playground at /tech.

GET — single domain

curl 'https://api.lynk.run/tech/v1/lookup/shopify.com' \
-H 'Authorization: Bearer YOUR_API_KEY'

POST — batch (max 50 domains)

curl https://api.lynk.run/tech/v1/lookup \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "domains": ["shopify.com", "stripe.com", "vercel.com"] }'

Sites using a Technology

curl 'https://api.lynk.run/tech/v1/sites/Shopify?pages=2' \
-H 'Authorization: Bearer YOUR_API_KEY'

Each page is one billable unit (10 tokens). pages auto-fetches multiple BuiltWith Lists pages in one request (max 5). The response carries every site stitched together plus next_offset for further pagination.

Adoption Trends (cheapest tier)

curl 'https://api.lynk.run/tech/v1/trends/WordPress' \
-H 'Authorization: Bearer YOUR_API_KEY'

Returns BuiltWith's coverage stats (top 10k / 100k / 1M / all live / dropped). 1 token per call — BuiltWith's Trends endpoint is free upstream.

Pricing

Endpoint	Cost	Cache TTL
/tech/v1/lookup	5 tokens / domain	30 days
/tech/v1/sites	10 tokens / page	7 days
/tech/v1/trends	1 token / call	24 hours

Defaults & limits

Max 50 domains per /lookup request, max 5 pages per /sites request
Unauthenticated: 20 / minute / IP
Pass format=markdown on any endpoint for an LLM-friendly rendered document
found: false in a lookup means BuiltWith has no record — not every domain has been crawled
Without a configured admin BuiltWith key, every endpoint returns 503
Cache hits cost the same as live calls — the cache is internal margin, not a user discount

📈GEO TrackerDashboard + MCP

Tracke wie deine Marke in AI-Suchmaschinen (ChatGPT, Claude, Gemini, Perplexity, Google AI Overview) erscheint — der AI-Search-Pendant zum klassischen SEO-Rank-Tracking. Statt "Platz 1 bei Google" misst GEO Mention-Rate, Citation-Share und Share-of-Voice vs. Wettbewerber über Zeit.

Workflow:

Domain eingeben → wir crawlen bis zu 20 Seiten und lassen Claude Sonnet ~30 realistische User-Anfragen vorschlagen
Brand-Aliases, Konkurrenten, Prompt-Set und Modell-Auswahl editieren
Manuell laufen lassen oder Cron (täglich / wöchentlich / monatlich) aktivieren
Reports: Mention-Rate-Zeitreihe pro Modell, Share-of-Voice, Top-Citation-Domains

Modelle (Standard-Set, in Projekt-Einstellungen erweiterbar mit jedem OpenRouter-Modell):

GPT-4o · Claude Sonnet 4 · Gemini 2.5 Pro · Perplexity Sonar (via OpenRouter — liefert Citations)
serper/ai-overview — Google AI Overview (via Serper-SERP-API)

Pricing: 1 Lynk-Token pro 100 API-Calls. Bei 5 Modellen × 30 Prompts × 3 Wiederholungen × 2 Calls (Response + Extractor) = 9 Tokens pro Run. Vor Aktivierung zeigt das UI eine genaue Vorschau in Tokens + USD-Schätzung.

REST-Endpoints (alle hinter Dashboard-Auth):

GET /api/geo/projects · POST /api/geo/projects · PATCH/DELETE /api/geo/projects/:id
POST /api/geo/discover · GET /api/geo/models
GET /api/geo/projects/:id/prompts · POST .../prompts · PATCH /api/geo/prompts/:id
POST /api/geo/projects/:id/run · GET /api/geo/runs/:id · GET .../runs
GET /api/geo/projects/:id/report · /competitors · /citations
GET /api/geo/prompts/:id/responses?run_id=

MCP-Scope geo (4 Tools):

geo_list_projects — alle eigenen Projekte mit KPIs
geo_list_prompts — Prompts eines Projekts
geo_get_project_report — Mention-Rate + Share-of-Voice + Top-Citations in einem Aufruf
geo_run_project — manuellen Run triggern (PAYG-billed)

AI-Agents können beobachten + triggern, aber NICHT konfigurieren — Projekte/Prompts/Cron sind Dashboard-only.

File Sharing APIAuth Required

Upload files (up to 500 MB), get shareable download links, and optionally protect them with a password or send the link via email. Download links are public and don't require authentication.

Upload a File

POST /api/files

Form Fields (multipart/form-data)

Field	Type	Required	Description
file	file	Yes	The file to upload (max 500 MB)
password	string	No	Password to protect the download link
email	string	No	Email address to send the download link to
expires_in_days	string	No	Number of days until expiry, or "evergreen" for permanent (default: evergreen)

Example: Upload with curl

bash

curl -X POST https://api.lynk.run/api/files \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@report.pdf" \
  -F "password=secret123" \
  -F "email=recipient@example.com" \
  -F "expires_in_days=30"

Response

json

{
  "success": true,
  "id": "a1b2c3d4e5f6...",
  "url": "https://lynk.run/dl/a1b2c3d4e5f6..."
}

List Your Files

GET /api/files

Example

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.lynk.run/api/files

Response

json

[
  {
    "id": "a1b2c3d4e5f6...",
    "original_name": "report.pdf",
    "size": 2457600,
    "mime_type": "application/pdf",
    "has_password": true,
    "download_count": 5,
    "created_at": "2026-03-22 10:30:00",
    "expires_at": "2026-04-21 10:30:00",
    "download_url": "https://lynk.run/dl/a1b2c3d4e5f6..."
  }
]

Delete a File

DELETE /api/files/:id

Example

bash

curl -X DELETE -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.lynk.run/api/files/a1b2c3d4e5f6...

Download (Public)

GET https://lynk.run/dl/:id

Download links are public — no API key required. If the file is password-protected, a password form is shown in the browser. For programmatic access, POST the password:

bash

# Password-protected download via curl
curl -X POST https://lynk.run/dl/a1b2c3d4e5f6... \
  -d "password=secret123" \
  -o report.pdf

CRM & OutreachDashboard + MCP

A light CRM with contacts, companies, mail-merge campaigns (with one automatic follow-up) and a Tinder-style daily call list. Manage it in the CRM dashboard — invite other Lynk users to collaborate on a shared workspace.

Outbound email is sent through your own Resend key or SMTP server (or opened in your own mail client), never through Lynk's domain.

The crm MCP scope lets an AI agent research prospects and populate contacts, companies, templates and draft campaigns — sending always stays a manual action in the dashboard. See the MCP tool reference.

Rate Limits & Error Codes

Endpoint	Rate Limit	Auth Required
/bgp/v1/asn/:asn	5/day (public) or unlimited (API key)	Optional
/bgp/v1/company/search	10/min per IP	No
/bgp/v1/search	30/min per IP	No
/ip/v1/lookup/:target	30/min per IP	Yes
/api/files	Standard	Yes

Error Codes

Code	Description
200	Success
401	Invalid or missing API key
402	Insufficient tokens
404	Resource not found (e.g. unknown ASN)
429	Rate limit exceeded

API Documentation

GET — single query (curl-friendly)

POST — batch (max 10 queries)

Markdown output (LLM-friendly)

Pricing — proportional to num

Defaults & limits

GET — single domain

POST — batch (max 50 domains)

Sites using a Technology

Adoption Trends (cheapest tier)

Pricing

Defaults & limits

Pricing — proportional to `num`