Documentation

How linkz.lol works

Everything you need to shorten links, build a bio page, and use the API.

Getting StartedFeaturesAPI ReferenceFAQ
01

Getting Started

Shorten your first link — no account needed

Head to the homepage and paste any URL into the input. Hit Shorten and you'll instantly get a short link at linkz.lol/abc123.

Anonymous links count toward a shared rate limit (5 per hour per IP). Create a free account to get 10 personal links that never expire.

Create a free account

  1. Go to /register and enter your name, email, and a password.
  2. Check your inbox for a verification email and click Verify Email.
  3. You're in — your dashboard is at /dashboard.

Custom slugs (paid)

On the free plan, slugs are random (e.g. abc123). Upgrade to Lifetime ($19) to pick your own — e.g. linkz.lol/my-brand. Custom slugs must be 3–60 characters, letters/numbers/hyphens only.

02

Features

Link analytics

Every link tracks click count automatically. Paid accounts get the full breakdown:

  • Click chart — 7-day, 30-day, 90-day, or all-time
  • Top referrers (where clicks came from)
  • Browser breakdown (Chrome, Safari, Firefox…)
  • Country & city data
  • Export to CSV

Find analytics at Dashboard → click the chart icon on any link.

QR codes

Every short link has a free QR code. Open the QR generator or click the QR icon next to any link in your dashboard. Download as PNG or SVG — no watermark, no account needed.

Link-in-bio page

Paid accounts get a customizable bio page at linkz.lol/u/username. Add a photo, bio text, and up to unlimited links arranged in any order.

  • Drag-to-reorder links
  • Custom domain support — point a CNAME to linkz.lol
  • Live preview while editing

Edit at Dashboard → Bio Page.

Collections

Group your links into collections (e.g. "Marketing", "Personal") from the dashboard. Collections are for your own organization — they don't affect public URLs.

Password-protected links

Set a password on any link from the dashboard. Visitors will be prompted to enter it before being redirected. Useful for sharing drafts or private content.

Link expiry

Set an expiration date on any link. After that date, the link returns a 404. Useful for time-limited promotions or event RSVPs.

03

API Reference

Authentication

All API requests require a Bearer token in the Authorization header. Generate an API key at Dashboard → API Keys.

Authorization: Bearer lz_your_api_key_here

Keys can be revoked at any time from the dashboard. Keep them secret — they have full access to your account's links.

POST /api/v1/shorten — Create a short link

Create a new short link.

POST https://linkz.lol/api/v1/shorten
Authorization: Bearer lz_...
Content-Type: application/json

{
  "url": "https://example.com/very/long/path",
  "slug": "my-slug"   // optional, paid plan only
}

Response:

{
  "shortUrl": "https://linkz.lol/my-slug",
  "slug": "my-slug",
  "url": "https://example.com/very/long/path"
}

Rate limit: 30 requests / hour per API key.

GET /api/links — List your links

Returns all links for your account.

GET https://linkz.lol/api/links
Authorization: Bearer lz_...

Response:

[
  {
    "id": "clx...",
    "slug": "my-slug",
    "url": "https://example.com",
    "clicks": 42,
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
]

DELETE /api/links/:slug — Delete a link

DELETE https://linkz.lol/api/links/my-slug
Authorization: Bearer lz_...

Returns 204 No Content on success.

Error codes

CodeMeaning
400Bad request — missing or invalid fields
401Missing or invalid API key
403Action not allowed on your plan
404Link not found
409Slug already taken
429Rate limit exceeded — try again later
500Server error — contact support
04

FAQ

How many links can I create?

Free accounts get 10 links. Lifetime accounts get unlimited links.

Do links ever expire?

No, free links live forever unless you manually delete them or set an expiry date. The free plan's 10-link cap means once you hit the limit, you'll need to delete old ones before creating new ones.

Is it really a one-time payment?

Yes. $19 once, lifetime access to all paid features. No monthly fees, no subscriptions.

Can I use my own domain?

Yes — paid accounts can connect a custom domain to their bio page. Point a CNAME record to linkz.lol and set your domain in Dashboard → Bio Page → Settings.

What's the refund policy?

If you're not happy within 7 days of purchase, email [email protected] and we'll refund you. No questions asked.

Are there ads?

The free plan shows ads. Paid accounts never see ads.

How does click tracking work?

When someone clicks your short link, we log the timestamp, country, city, browser, device type, and referrer. We don't store personally identifiable information about your visitors.

Can I have multiple API keys?

Yes — create up to 5 API keys from Dashboard → API Keys. You can name and revoke them individually.

What URL formats are supported?

Any valid URL with http:// or https://. We don't shorten other linkz.lol links.

Still have questions?

We're here to help

Email us and we'll get back to you within 24 hours.

[email protected]