rs
rus.sh

Developer Documentation

Everything you need to integrate rus.sh into your applications. Simple, powerful, well-documented.

Get API Key

Quick Start

Create your first short link in under 60 seconds

1. Get Your API Key

Sign up for a free account and get your API key from the dashboard

Create Free Account

2. Make Your First Request

curl -X POST https://api.rus.sh/v1/links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "destination": "https://example.com/long-url",
    "slug": "my-link"
  }'

3. Get the Response

{
  "id": "abc123",
  "shortUrl": "https://rus.sh/my-link",
  "destination": "https://example.com/long-url",
  "slug": "my-link",
  "createdAt": "2025-10-28T10:00:00Z",
  "clicks": 0
}

API Endpoints

RESTful API with predictable, resource-oriented URLs

POST/v1/links

Create a new short link

GET/v1/links

List all your links

GET/v1/links/:slug

Get details for a specific link

PATCH/v1/links/:slug

Update a link

DELETE/v1/links/:slug

Delete a link

GET/v1/links/:slug/analytics

Get analytics for a link

POST/v1/qr

Generate a QR code

GET/v1/domains

List your custom domains

Official SDKs & Libraries

Type-safe SDKs for your favorite programming languages

JavaScript / TypeScript

npm install @rush/sdk
JS

Python

pip install rush-sdk
PY

PHP

composer require rush/sdk
PHP

Go

go get github.com/russh/go-sdk
GO

Authentication

All API requests require authentication using your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Keep your API key secure and never share it publicly

Rate Limits

Free Plan

100 requests/hour

Pro Plan

1,000 requests/hour

Business & Premium

10,000 requests/hour

Enterprise

Custom rate limits

Webhooks

Get real-time notifications when events happen

Available Events

link.created
link.updated
link.deleted
link.clicked
qr.generated
domain.verified

Example Payload

{
  "event": "link.clicked",
  "timestamp": "2025-10-28T10:00:00Z",
  "data": {
    "slug": "my-link",
    "destination": "https://example.com",
    "referrer": "https://twitter.com",
    "country": "US",
    "device": "mobile"
  }
}

Ready to Start Building?

Get your API key and start integrating in minutes

Get Started Free