URL Shortener API for Developers
Integrate short link creation into your apps and workflows with our REST API. Full documentation included.
Simple REST API
Create, update, and manage short links programmatically. Our REST API is straightforward with clear documentation and code examples.
- RESTful endpoints for CRUD operations
- JSON request and response format
- Comprehensive API documentation
API Key Authentication
Authenticate with API keys for server-to-server integration. Generate and manage keys from your dashboard.
- Generate API keys from your dashboard
- Secure server-to-server authentication
- Built-in rate limiting for fair usage
Custom Domain Integration
Use your own domain for API-created short links. Custom domain branding for a seamless user experience.
- All API-created links use your custom domain
- Configure domains via dashboard or API
- DNS setup guides included in documentation
How to Integrate the URL Shortener API
From API key to your first short link — in four steps.
Generate an API Key
Go to your dashboard settings and create an API key. This is your Bearer token for all API requests.
Send a POST Request
Hit the /api/v1/short-url endpoint with your long URL and an optional custom slug in the JSON body.
Receive the Short Link
The API returns a JSON response with the short URL, creation timestamp, and link ID for future reference.
Retrieve Click Analytics
Use the analytics endpoints to fetch click counts, timestamps, device data, and geographic info per link.
Best Practices for Developers
Treat Links as Configuration
Keep the short link stable and let the destination be the thing that changes. That is the whole point of an indirection layer.
Generate Links in CI
The REST API means release links can be created by your pipeline instead of by hand before every launch.
Scope Your API Keys
Issue a separate key per integration. Rotating one then never means auditing every script you have ever written.
Self-Host if You Must
The stack is MIT-licensed and public. If your compliance rules will not allow a third-party redirect, run your own.
URL Shortener for Other Teams
See how non-technical teams use short links in their work.
Frequently Asked Questions
Bearer token authentication. Generate an API key from your dashboard and include it in the Authorization header: Authorization: Bearer YOUR_API_KEY.
Start Building with Our API
REST API for short links with full documentation. Integrate URL shortening into your apps today.