API Documentation

Request Body

{
  "url": "https://example.com/very-long-url",
  "customCode": "my-link",      // optional, 3-20 chars
  "password": "secret123",      // optional
  "expiresAt": "2024-12-31T23:59:59Z",  // optional, ISO 8601
  "isOneTime": false            // optional, default false
}

Response

{
  "shortUrl": "https://shtr.xyz/abc1",
  "code": "abc1",
  "editToken": "tok_a1b2c3d4e5f6...",
  "qrCode": "data:image/png;base64,..."
}

Example

curl -X POST https://shtr.xyz/api/shorten \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/page"}'

Query Parameters

Response (without token)

{
  "code": "abc1",
  "clicks": 42,
  "isActive": true
}

Response (with valid token)

{
  "code": "abc1",
  "originalUrl": "https://example.com/page",
  "clicks": 42,
  "createdAt": "2024-01-15T10:30:00Z",
  "expiresAt": null,
  "isPasswordProtected": false,
  "isOneTime": false,
  "isActive": true
}

Example

curl https://shtr.xyz/api/links/abc1?token=tok_xxx

Query Parameters

Response

{
  "link": {
    "id": 1,
    "code": "abc1",
    "original_url": "https://example.com/page",
    "created_at": "2024-01-15T10:30:00Z",
    "expires_at": null,
    "password_hash": null,
    "is_one_time": false,
    "is_active": true,
    "clicks": 42
  },
  "clicksOverTime": [
    { "date": "2024-01-15", "clicks": 10 },
    { "date": "2024-01-16", "clicks": 15 }
  ],
  "topCountries": [
    { "country": "United States", "country_code": "US", "clicks": 25 },
    { "country": "Germany", "country_code": "DE", "clicks": 10 }
  ],
  "deviceBreakdown": [
    { "device_type": "desktop", "clicks": 30 },
    { "device_type": "mobile", "clicks": 12 }
  ],
  "browserBreakdown": [
    { "browser_name": "Chrome", "clicks": 28 },
    { "browser_name": "Safari", "clicks": 14 }
  ],
  "osBreakdown": [
    { "os_name": "Windows", "clicks": 20 },
    { "os_name": "macOS", "clicks": 15 }
  ],
  "topReferers": [
    { "referer": "https://twitter.com", "clicks": 15 },
    { "referer": "Direct", "clicks": 27 }
  ],
  "recentClicks": [...],
  "uniqueVisitors": 38,
  "totalClickEvents": 42
}

Example

curl https://shtr.xyz/api/links/abc1/stats?token=tok_xxx

Query Parameters

Response

{
  "clicks": [
    {
      "id": 1,
      "clicked_at": "2024-01-15T14:30:00Z",
      "ip_address": "192.168.1.1",
      "user_agent": "Mozilla/5.0...",
      "referer": "https://twitter.com/...",
      "country": "United States",
      "country_code": "US",
      "city": "New York",
      "device_type": "desktop",
      "browser_name": "Chrome",
      "os_name": "Windows",
      "is_bot": false
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 20,
  "totalPages": 3
}

Example

curl "https://shtr.xyz/api/links/abc1/clicks?token=tok_xxx&page=1&limit=20"

Query Parameters

Response

{
  "code": "abc1",
  "originalUrl": "https://example.com/page",
  "isActive": true
}

Example

curl https://shtr.xyz/api/lookup?token=tok_xxx

Query Parameters

Response

{
  "success": true
}

Example

curl -X DELETE https://shtr.xyz/api/links/abc1?token=tok_xxx

Request Body

{
  "code": "abc1",
  "password": "secret123"
}

Response

{
  "success": true
}