┌──────────────────────────────────────────────────────────────────────┐ │ yourls.dev │ │ yourls, for developers │ │ plain text. one endpoint. │ ├──────────────────────────────────────────────────────────────────────┤ │ [ home ] [ docs ] [ help ] [ login ] │ └─────────────────────────────────────────────────────────────────────┘
┌─ make a link ────────────────────────────────────────────────────────┐
(optional)
└──────────────────────────────────────────────────────────────────────┘
┌─ usage ──────────────────────────────────────────────────────────────┐
yourls.dev: a YOURLS you can call without a signature. No account and no API key.

Make a link. The answer is the short link on one line:

    https://www.yourls.dev/yourls-api.php?action=shorturl&format=simple&url=https%3A%2F%2Fexample.com%2Fa%2Flong%2Faddress

From a shell:

    curl -G https://www.yourls.dev/yourls-api.php -d action=shorturl -d format=simple --data-urlencode 'url=https://example.com/page?a=1&b=2'
    curl https://www.yourls.dev/yourls-api.php -d action=shorturl -d format=simple -d 'url=https://example.com/a/long/address'

Pick the keyword yourself, 1 to 64 letters, digits, - or _:

    https://www.yourls.dev/yourls-api.php?action=shorturl&format=simple&keyword=my-name&url=https%3A%2F%2Fexample.com%2Fa%2Flong%2Faddress

See where a link leads:

    https://www.yourls.dev/yourls-api.php?action=expand&format=simple&shorturl=<keyword>
    https://www.yourls.dev/<keyword>+

Follow one:

    https://www.yourls.dev/<keyword>

format is json, xml, jsonp (with callback) or simple; xml when it is left out.
Percent-encode url, or put it last: an address written out as it is
runs to the end of the line, with its own ? and & in it.

The same address gives the same short link every time, unless you name
it yourself. Links do not expire.
└──────────────────────────────────────────────────────────────────────┘
┌─ parameters ─────────────────────────────────────────────────────────┐
field required what
-------- -------- ---------------------------------
url yes the address to shorten
keyword no the short name you would like
format yes html, on this form
└──────────────────────────────────────────────────────────────────────┘
┌─ notes ──────────────────────────────────────────────────────────────┐
- free. no sign-up, no account, no api key.
- links do not expire.
- the same address always gives the same short link.
- pick the short name yourself, or leave it blank.
- add + to a short link to see where it leads.
- works from scripts with a plain GET. see /help.
└──────────────────────────────────────────────────────────────────────┘
┌─ TODO ───────────────────────────────────────────────────────────────┐
- make the frames line up
└──────────────────────────────────────────────────────────────────────┘
last modified: 2016-11-04 as of 2024-03 this is still one file, and it is still plain text.