b59.link

Sign in to b59.link to own what you create (and for 300 requests/minute on the REST API). Pass api_key to get a session key straight away. Or pass email to have a 6-digit code emailed, then call again with email and otp to get a session key (new emails are signed up and also get their api_key). Send the session key as the HTTP header 'Authorization: Bearer <session_key>'.

{
  "type": "object",
  "properties": {
    "api_key": {
      "type": "string",
      "description": "The account's 256-character API key."
    },
    "email": {
      "type": "string",
      "description": "Email to send a one-time code to."
    },
    "otp": {
      "type": "string",
      "description": "The 6-digit code from the email."
    }
  }
}

Shorten a long URL and get a memorable b59.link short URL. Optionally specify a custom slug. Returns the short URL and a stats URL.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The URL to shorten."
    },
    "slug": {
      "type": "string",
      "description": "Optional custom slug (letters, digits, hyphens, underscores, max 100 chars). A random slug is used if omitted."
    }
  },
  "required": [
    "url"
  ]
}

Generate a trackable QR code for a URL. Creates a b59.link short URL at the same time so scans are counted. Returns the short URL, a stats URL, and the QR code as a base64-encoded PNG.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The URL to generate a QR code for."
    }
  },
  "required": [
    "url"
  ]
}

Create a free page-view tracker for a website. Returns the tag image URL and ready-to-paste snippets for the site's pages, plus the stats URL where views, visitors, pages and referrers are shown. When signed in, the tracker belongs to the account; otherwise keep the manage_token to claim it later.

{
  "type": "object",
  "properties": {
    "site_url": {
      "type": "string",
      "description": "The site's address, e.g. example.com. Views are only counted on this domain and its subdomains."
    },
    "name": {
      "type": "string",
      "description": "Optional display name for the tracker."
    }
  },
  "required": [
    "site_url"
  ]
}

Get the stats page URL for anything b59.link tracks: a slug or short URL, the destination URL of a short link or QR code, a tracker id or tag URL, or any page URL / domain that has a tracker tag. Stats themselves are viewed on b59.link; this returns where.

{
  "type": "object",
  "properties": {
    "identifier": {
      "type": "string",
      "description": "Slug, short URL, page URL, domain, tracker id or tag URL."
    }
  },
  "required": [
    "identifier"
  ]
}

Check whether a URL already has a b59.link short URL. Handles variations: http/https, www prefix, trailing slash. Returns the existing short URL and QR code if found.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The URL to look up."
    }
  },
  "required": [
    "url"
  ]
}

Make a QR code image for any text (URL, Wi-Fi string, phone, email, plain text) without creating a short link. Supports colors, size and SVG. Returns the image plus a permanent image URL that can be embedded with <img src>. Use generate_qr instead when scans should be counted.

{
  "type": "object",
  "properties": {
    "data": {
      "type": "string",
      "description": "Text to encode (max 1500 chars)."
    },
    "size": {
      "type": "integer",
      "description": "Width/height in pixels, 64-1200 (default 300)."
    },
    "fg": {
      "type": "string",
      "description": "Foreground hex color, e.g. 000000."
    },
    "bg": {
      "type": "string",
      "description": "Background hex color, e.g. ffffff."
    },
    "format": {
      "type": "string",
      "enum": [
        "png",
        "svg"
      ],
      "description": "Image format (default png)."
    }
  },
  "required": [
    "data"
  ]
}