YOURLS API

YOURLS API Manual » Usage

Related Functions

Reference

Usage

Description

A reference for the YOURLS API, with a working endpoint under it.

Parameters

One field for the address, one for an optional name. The name is yours to choose if the short one is free.

Return Values

The short link, on the created page.

Syntax

string make(string $address [, string $name])

Examples

YOURLS API: a YOURLS you can call without a signature. No account and no API key.

Make a link. The answer is JSON and the short link is in "shorturl":

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

From a shell:

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

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

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

See where a link leads:

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

Follow one:

    https://www.yourlsapi.com/<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.

User Contributed Notes

guest, 11-Mar-2006 14:02
thx works

add a note