YOURLS for Agents
Home › YOURLS for Agents - API

Using the API

One request, one short link.

The API

There is a single endpoint, and it answers a plain GET. Nothing needs to be signed up for or kept secret.

Usage

YOURLS for Agents: a YOURLS link shortener with a GET and POST API. No account and no API key.

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

    https://www.yourlsforagents.com/api/shorten.php?url=https%3A%2F%2Fexample.com%2Fa%2Flong%2Faddress

From a shell, as a GET, a form or JSON:

    curl -G https://www.yourlsforagents.com/api/shorten.php --data-urlencode 'url=https://example.com/page?a=1&b=2'
    curl https://www.yourlsforagents.com/api/shorten.php -d 'url=https://example.com/a/long/address'
    curl https://www.yourlsforagents.com/api/shorten.php -H 'Content-Type: application/json' -d '{"url":"https://example.com/page"}'

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

    https://www.yourlsforagents.com/api/shorten.php?keyword=my-name&url=https%3A%2F%2Fexample.com%2Fa%2Flong%2Faddress

Follow a link, or see where it leads without going there:

    https://www.yourlsforagents.com/<keyword>         redirects
    https://www.yourlsforagents.com/<keyword>+        the address as text

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. A keyword that is taken answers 409. Links do not expire.

Looking first

Note

Add + to a short link and it shows its destination instead of redirecting.

✎ Edit this page