Build with the LynURL API
A RESTful API for programmatic link creation, management, and analytics. REST examples and TypeScript and Python SDK source previews. Real-time webhooks for event-driven workflows.
const response = await fetch('https://short.lynurl.com/api/v1/shorten', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': 'your-api-key',
},
body: JSON.stringify({ url: 'https://example.com/long-url' }),
});
if (!response.ok) throw new Error('Link creation failed');
const link = await response.json();
console.log(link.short_url);Developer-friendly by design
Everything you need to integrate link management into your stack.
RESTful API
Full REST API for link creation, management, and analytics. Clean, predictable endpoints with JSON responses.
SDK Source Previews
Explore TypeScript and Python source previews. Public package releases are pending; use REST for production integrations.
Comprehensive Docs
Detailed documentation with code examples and guides. Interactive API reference with request/response samples.
Webhook Integrations
Get notified of events via webhooks for automation. Real-time HTTP callbacks for link events and clicks.
How it works
Get up and running with the API in minutes.
Get your API key
Create an API key from your dashboard. Manage multiple keys with different permissions and scopes.
Use REST endpoints
Send HTTP requests with your API key. REST examples are ready to use, and SDK source previews are documented separately.
Create links programmatically
Create short links, read analytics, and set up webhooks. Full API reference and examples available.
API capabilities
Available on the Pro plan and above.
Frequently asked questions
Common questions about the LynURL API.
Ready to integrate LynURL?
API access included on the Pro plan at $9/month. Webhooks available on Premium. Get your API key in seconds.
Explore more features
The API is just one part of the LynURL platform.