an open YOURLS

Project Description

Project page for an open YOURLS instance.

Try it: make a short link


Good to Know

Free. No sign-up, no account, no API key. Links do not expire. The same address always gives the same short link. You can pick the short name yourself. Add + to a short link to see where it leads. Works from scripts with a plain GET.

Usage

Open YOURLS: 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.openyourls.com/yourls-api.php?action=shorturl&format=json&url=https%3A%2F%2Fexample.com%2Fa%2Flong%2Faddress

From a shell:

    curl -G https://www.openyourls.com/yourls-api.php -d action=shorturl -d format=json --data-urlencode 'url=https://example.com/page?a=1&b=2'
    curl https://www.openyourls.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.openyourls.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.openyourls.com/yourls-api.php?action=expand&format=json&shorturl=<keyword>
    https://www.openyourls.com/<keyword>+

Follow one:

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

Project Details

LicenseGPL
Operating SystemOS Independent
Programming LanguagePHP

Latest File Release

This project has not released any files.

News

2004-05-03
Initial code is up. Documentation to follow.

Summary | Docs | Help | Login | Tracker
Open YOURLS is a project page. Descriptions and files are the project's own.