The nlink API
One resource, four calls. Create a link, list your links, read one, delete it. Everything is JSON over HTTPS.
The API is available on Pro and Business. Create a key in Dashboard → API. A key is shown once, at creation — store it somewhere you can get it back.
Base URL
https://nlink.cc/api/v1Authentication
Send your key as a bearer token. Keys start with nlk_ and are scoped to one workspace.
curl https://nlink.cc/api/v1/links \
-H "Authorization: Bearer nlk_live_xxxxxxxxxxxxxxxx"Links
POST/api/v1/links
Creates a link. destination is the only required field; leave slug out and nlink generates a six-character alias.
curl -X POST https://nlink.cc/api/v1/links \
-H "Authorization: Bearer nlk_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"destination": "https://shop.example.com/summer-sale",
"slug": "summer",
"title": "Summer sale — IG bio",
"password": "secret",
"expire_at": "2026-09-30T17:00:00Z"
}'{
"id": "0f1c9e2a-...",
"slug": "summer",
"short_url": "https://nlink.cc/summer",
"destination": "https://shop.example.com/summer-sale",
"title": "Summer sale — IG bio",
"clicks": 0,
"status": "active",
"expire_at": "2026-09-30T17:00:00.000Z",
"created_at": "2026-08-02T04:11:22.000Z"
}GET/api/v1/links
Lists links in the key's workspace, newest first. Query parameters: search, status (active | paused | expired), sort (created | clicks | alias), limit (max 100), offset.
curl "https://nlink.cc/api/v1/links?search=summer&sort=clicks&limit=20" \
-H "Authorization: Bearer nlk_live_xxx"{
"data": [ { "id": "...", "slug": "summer", "clicks": 2841, ... } ],
"total": 1,
"limit": 20,
"offset": 0
}GET/api/v1/link/{id}
Reads one link, including a click summary for the last 30 days.
DELETE/api/v1/link/{id}
Deletes the link and its click history. This cannot be undone — the alias returns to the pool and can be claimed by anyone.
curl -X DELETE https://nlink.cc/api/v1/link/0f1c9e2a-... \
-H "Authorization: Bearer nlk_live_xxx"{ "deleted": true, "id": "0f1c9e2a-..." }QR codes
Every link has a QR code at a stable URL. No key needed — the code only encodes the public short link.
https://nlink.cc/api/qr/summer.png?size=1024
https://nlink.cc/api/qr/summer.svg
https://nlink.cc/api/qr/summer.pdfPNG accepts size (128–2048 px). All formats accept dark and light as six-digit hex colours.
Errors
Errors return the matching HTTP status and a JSON body with a machine-readable code.
{ "error": "slug_taken", "message": "nlink.cc/summer is already in use." }- 401 · unauthorized — missing, unknown or revoked key
- 403 · plan_required — the API needs Pro or Business
- 404 · not_found — no link with that id in this workspace
- 409 · slug_taken — that alias already exists
- 422 · invalid_request — a field failed validation
- 429 · rate_limited — slow down and retry
Rate limits
60 requests per minute per key. Redirects themselves are never rate limited — your links stay fast no matter what the API is doing.