REST API v1

Build anything
on top of your links

A clean, predictable REST API for URL shortening, QR codes, analytics, and bio pages. Integrate in minutes. Scale to millions.

API access included on Pro & Business plans.

# POST /v1/links — Shorten a URL
curl -X POST https://api.htttp.in/v1/links \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/very/long/url",
    "alias": "my-campaign",
    "expires_at": "2026-12-31",
    "tags": ["marketing", "q4"]
  }'

# 201 Created
{
  "data": {
    "id": "01HXYZ...",
    "short_url": "https://htttp.in/my-campaign",
    "clicks": 0,
    "created_at": "2026-04-20T10:32:00Z"
  }
}
import HTTTP.IN from '@shortlink/sdk'

const client = new HTTTP.IN({ apiKey: process.env.SHORTLINK_API_KEY })

const link = await client.links.create({
  url:       'https://example.com/very/long/url',
  alias:     'my-campaign',
  expiresAt: '2026-12-31',
  tags:      ['marketing', 'q4'],
})

console.log(link.shortUrl) // https://htttp.in/my-campaign
import shortlink

client = shortlink.Client(api_key="YOUR_API_TOKEN")

link = client.links.create(
    url="https://example.com/very/long/url",
    alias="my-campaign",
    expires_at="2026-12-31",
    tags=["marketing", "q4"],
)

print(link.short_url)  # https://htttp.in/my-campaign
use ShortLink\Client;

$client = new Client(['api_key' => $_ENV['SHORTLINK_API_KEY']]);

$link = $client->links->create([
    'url'        => 'https://example.com/very/long/url',
    'alias'      => 'my-campaign',
    'expires_at' => '2026-12-31',
    'tags'       => ['marketing', 'q4'],
]);

echo $link->short_url; // https://htttp.in/my-campaign
Capabilities

Everything you need in an API

Consistent JSON responses, standard HTTP verbs, clear error codes, and full OpenAPI coverage.

RESTful Design

Standard HTTP verbs (GET, POST, PATCH, DELETE), resource-oriented URLs, and JSON everywhere. Predictable and consistent.

Scoped API Tokens

Generate named tokens with read, write, or admin scopes. Revoke individual tokens without affecting others.

Rate Limiting

Fair rate limits per plan with X-RateLimit headers on every response. Burst requests handled gracefully.

Signed Webhooks

Real-time HTTP POST events on clicks, expiry, and click limits. Every payload signed with HMAC-SHA256.

Full Resource Coverage

Links, QR codes, bio pages, tags, domains, teams, and analytics — every dashboard feature has an API endpoint.

OpenAPI 3.1 Spec

Import into Postman, Insomnia, or any tool. Auto-generate typed clients in TypeScript, Python, Go, and more.

Core endpoints

A taste of what's available. Full reference in the docs →

POST /v1/links
GET /v1/links
GET /v1/links/{id}
PATCH /v1/links/{id}
DELETE /v1/links/{id}
GET /v1/links/{id}/analytics
POST /v1/qr-codes
GET /v1/workspaces/me

Rate limits by plan

Rate limit headers are included in every API response so you always know where you stand.

Plan Requests / min Requests / day Webhooks
Free No
Pro 1,000 100,000 Yes (5 max)
Business 10,000 Unlimited Yes (unlimited)

Official SDKs

Or use the OpenAPI spec to generate a client in any language.

Node.js
npm install @shortlink/sdk
Python
pip install shortlink
PHP
composer require shortlink/sdk
Go
go get github.com/shortlink/go

Frequently asked questions

Does the API support QR code generation?

Many URL APIs support automatic QR code generation for campaigns, product packaging, events, and offline marketing.

What is a URL shortener API?

A URL shortener API allows developers to create, manage, and track short links programmatically within websites, apps, and software systems.

Is there a REST API for URL shortening?

Yes, RESTful APIs allow developers to shorten URLs, manage links, fetch analytics, and automate workflows securely.

Can businesses use API for marketing automation?

Yes, HTTTP API helps automate link creation, campaign tracking, and marketing workflows.

How to integrate URL shortening API with CRM?

Integrate the API with CRM platforms to create trackable links and monitor customer engagement.

Does the API provide real-time reporting?

Yes, HTTTP API offers real-time click tracking, analytics, and campaign insights.

What are the benefits of using a URL API?

URL APIs provide automation, analytics, branded links, QR codes, and better campaign tracking.

Is HTTTP API suitable for enterprise businesses?

Yes, HTTTP API supports scalable, secure, and enterprise-level integrations for large businesses.

Start building today

Get your API token from the dashboard. API access is included on Pro and Business plans.