Developer API

Build with the LynURL API

A RESTful API for programmatic link creation, management, and analytics. Official SDKs for TypeScript, Python, and Go. Real-time webhooks for event-driven workflows.

api-example.ts
const lynurl = new LynURL({ apiKey: 'your-api-key' });

const link = await lynurl.links.create({
  url: 'https://example.com/long-url',
  alias: 'my-link',
  tags: ['marketing', 'q1'],
});

console.log(link.shortUrl);
// → https://short.lynurl.com/my-link

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.

Official SDKs

TypeScript, Python, and Go SDKs with type-safe interfaces. Full type definitions and comprehensive docs.

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.

1

Get your API key

Create an API key from your dashboard. Manage multiple keys with different permissions and scopes.

2

Install the SDK or use REST endpoints

Install the SDK for your language, or use raw HTTP requests. TypeScript, Python, and Go supported.

3

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.

Link CRUD operations
Bulk link creation
Analytics retrieval
Custom domain management
QR code generation
Team management API
Rate limiting with generous quotas
Webhook event subscriptions

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.