url.onl API

Build with a clean JSON API for links & QR codes.

Programmatically create short links, generate QR codes, and read analytics. Simple auth, predictable responses, and fast endpoints.

Production ready Sandbox (coming soon) Docs API Keys

Quick start

Base URL & authentication

Base URL https://api.url.onl/v1

Authorization header

Include your secret key in every request.

Authorization: Bearer ur_sk_XXXX

Keep keys secret Rotate anytime

Example

Create a short link

curl -X POST https://api.url.onl/v1/links \
  -H "Authorization: Bearer ur_sk_XXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yourlongurl.com/blog/summer-campaign",
    "slug": "summer-24",
    "expires_at": null,
    "password": null
  }'

Need schemas, pagination, errors, and rate limits? See Docs.

View docs Upgrade for higher limits

Reference

Core endpoints

POST /v1/linksLinks

Create

Create a new short link with optional expiry, password and metadata.

GET /v1/links/{id}Links

Retrieve

Fetch full details for a single short link by ID or slug.

GET /v1/linksLinks

List

List all links with filtering and pagination.

POST /v1/qr-codesQR Codes

Create QR

Generate a QR code image for an existing link or a raw URL.

GET /v1/analytics/links/{id}Analytics

Stats

Retrieve clicks by country, device and referrer for a specific link.

Rate limits

Limits vary by plan. Use retries with backoff for bursts.

Errors

Consistent error shape with codes and messages for easy handling.

Ready to build?

Create your first key and start shipping in minutes.

Create account View pricing