API Documentation

Welcome to the sssss.ss API. Our RESTful API allows you to programmatically manage your digital identity, create short links, and retrieve analytics data.

Base URL: https://sssss.ss/api/v1

Authentication

Authenticate your requests by including your API key in the Authorization header. Generate API keys in your Developer Settings.

cURL Example

curl https://sssss.ss/api/v1/me \
  -H "Authorization: Bearer sk_live_..."

Rate Limits

The sssss.ss API implements rate limiting in accordance with the IETF standard. This ensures fair usage and protects the service from abuse.

Rate Limits by Plan

Plan	Rate Limit
Free	60 requests per minute
Pro	600 requests per minute

Response Headers

Header	Description
X-RateLimit-Limit	Maximum requests per minute
X-RateLimit-Remaining	Requests remaining in current window
X-RateLimit-Reset	UTC epoch timestamp when the window resets
Retry-After	Seconds to wait before retrying (only on 429)

429 Too Many Requests: If you exceed the rate limit, you'll receive a 429 response. Wait for the time specified in Retry-After before making another request.

Try It Out

Test API endpoints directly in your browser. Enter your API key and select an endpoint to get started.

API Tester

API Key

Key is stored in session only — clears when you close this tab

Endpoint

GET/v1/me

Retrieve the authenticated user's profile information.

Response

{
  "id": "UJUs3U1nDtjQawSoVTfjh5kP8qSdmi2o",
  "name": "Kira",
  "email": "kira@sssss.ss",
  "plan": "pro",
  "createdAt": "2025-12-25T14:42:11.000Z"
}

GET/v1/usage

Get current billing period usage and limits.

Response


{
  "data": {
    "plan": "free",
    "period": {
      "from": "2025-12-01",
      "to": "2025-12-31"
    },
    "links": {
      "used": 3,
      "limit": 100,
      "remaining": 97
    },
    "clicks": {
      "tracked": 45,
      "limit": 1000,
      "remaining": 955
    },
    "emails": {
      "received": 0,
      "storageBytes": 0,
      "storageLimitBytes": 104857600,
      "storageRemaining": 104857600
    }
  }
}

GET/v1/ids

List all identities owned by the authenticated user.

Response

{
  "data": [
    {
      "id": "sid_yIpMks0l7ZSJVoIv_9gBs",
      "name": "myid",
      "status": "active",
      "autoRenew": false,
      "createdAt": "2025-12-25T14:54:51.000Z",
      "expiresAt": "2026-12-25T14:54:51.000Z",
      "linkCount": 0,
      "subscription": null
    }
  ]
}

GET/v1/ids/:name

Get detailed information about a specific identity.

cURL

curl https://sssss.ss/api/v1/ids/myid \
  -H "Authorization: Bearer sk_live_..."

Response

{
  "data": {
    "id": "sid_9l1K7Wi87t4S7srdP-fYe",
    "name": "myid",
    "status": "active",
    "autoRenew": true,
    "createdAt": "2025-12-25T15:40:20.000Z",
    "expiresAt": "2026-12-25T15:40:20.000Z",
    "linkCount": 0,
    "subscription": null
  }
}

GET/v1/ids/:name/links

List all short links for an identity.

Query Parameters

Param	Default	Description
limit	20	Max results (1-100)

cURL

curl https://sssss.ss/api/v1/ids/myid/links?limit=10 \
  -H "Authorization: Bearer sk_live_..."

Response

{
  "data": [
    {
      "id": "link_PDvWO-Y5cQsElpy1tWI2U",
      "code": "fAnfPci3",
      "targetUrl": "https://github.com",
      "fullUrl": "https://myid.sssss.ss/fAnfPci3",
      "title": "Github Home",
      "clickCount": 4,
      "status": "active",
      "createdAt": "2025-12-25T15:38:43.000Z",
      "expiresAt": null
    }
  ]
}

POST/v1/ids/:name/links

Create a new short link.

Request Body

Field	Required	Description
targetUrl	Yes	Destination URL
code	No	Custom short code (auto-generated if omitted)
title	No	Link title for reference

cURL

curl -X POST https://sssss.ss/api/v1/ids/myid/links \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"targetUrl": "https://example.com", "code": "example"}'

Response

{
  "success": true,
  "data": {
    "id": "link_elFbDT07KgdyLOI33RS1M",
    "fullUrl": "https://myid.sssss.ss/MLXM4L",
    "targetUrl": "https://github.com",
    "code": "MLXM4L"
  }
}

GET/v1/links/:id/stats

Get click statistics for a specific link.

Query Parameters

Param	Default	Description
from	30 days ago	Start date (YYYY-MM-DD)
to	today	End date (YYYY-MM-DD)

Response

{
  "data": {
    "linkId": "link_PDvWO-Y5cQsElpy1tWI2U",
    "code": "fAnfPci3",
    "targetUrl": "https://github.com",
    "totalClicks": 4,
    "periodClicks": 4,
    "uniqueClicks": 2,
    "period": {
      "from": "2025-12-21",
      "to": "2025-12-28",
      "interval": "day"
    },
    "breakdown": {
      "byDate": [
        {
          "date": "2025-12-21",
          "clicks": 1
        },
        {
          "date": "2025-12-25",
          "clicks": 1
        }
      ],
      "byCountry": [
        {
          "country": "JP",
          "clicks": 2
        }
      ],
      "byDevice": [
        {
          "device": "desktop",
          "clicks": 2
        }
      ]
    }
  }
}

YOURLS Compatible APICompatible

For compatibility with tools that support YOURLS (iOS Shortcuts, Raycast, Alfred, etc.), we provide a YOURLS-compatible endpoint.

Endpoint: https://sssss.ss/api/v1/yourls

Available Actions

Action	Description
shorturl	Create a short link
expand	Get original URL from short code
url-stats	Get click count for a link
version	Get API version

Create Short Link

curl "https://sssss.ss/api/v1/yourls?action=shorturl&signature=YOUR_API_KEY&url=https://example.com&keyword=custom&format=json"

Response

{
  "status": "success",
  "code": "success:urllink",
  "message": "https://example.com added to database",
  "url": {
    "keyword": "custom",
    "url": "https://example.com",
    "title": "",
    "date": "2024-12-24 12:00:00"
  },
  "shorturl": "https://myid.sssss.ss/custom"
}

💡 TipUse format=simple to get just the short URL as plain text, which is useful for shell scripts.