Getting Started | Plung

API Documentation

Getting Started (3-Minute Quickstart)

Follow this quickstart to authenticate with the Plung REST API and shorten your first link in under 3 minutes.

Obtain your API Key

Sign up for a free developer account at the console. All accounts, including the Free tier (2,000 requests/month), can generate API keys instantly:

Create API Key in Console

Create your first shortened link

Submit a standard POST /v2/shorten request. Replace your_api_key_here with your secret key. This minimal request works on every plan, including Free:

bash

curl -X POST https://api.plung.co/v2/shorten \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key_here" \
  -d '{"url": "https://example.com"}'

Inspect the response

The API returns an HTTP 201 Created status with the generated link details:

json

{
  "shortUrl": "https://plu.ng/uswh1hc",
  "shortCode": "uswh1hc",
  "url": "https://google.com",
  "createdAt": "2026-09-29T13:37:00.738Z"
}

Your shortened link is immediately active and cached across global edge points. Anyone visiting shortUrl will be redirected with sub-50ms latency.

Advanced Features: Custom vanity aliases (alias), link expiration (expiresIn), and click caps (maxClicks) are unlocked on Hobby+ plans. Password protection (password) and Batch shortening (/v2/shorten/batch) are available on Indie+ plans.

PreviousIntroduction NextAuthentication