REST API

Base URL: https://urlik.xyz/api/. Responses are JSON of the form:

{ "status": "success", "message": "...", "return": { ... } }

Authentication (optional for basic shortening) — the X-Api-Key header. Your key is in your account. Links created with a key are attached to your account.

Endpoints

POST /api/getLink.json

Create a short link.

ParameterRequiredDescription
urlrequiredtarget URL (http/https)
aliasoptionalcustom code, 2–32 chars [a-zA-Z0-9_-]
modeoptionalredirect (default), preview, frame
expireoptionallifetime in seconds (0 = never)
passwordoptionalpassword to follow the link
curl -X POST https://urlik.xyz/api/getLink.json \
 -H "X-Api-Key: YOUR_KEY" \
 -d "url=https://example.com/very/long/path" \
 -d "mode=redirect"
{ "status":"success", "return":{
 "hex":"a1b2c3", "url":"https://urlik.xyz/a1b2c3",
 "qr":"https://urlik.xyz/qr/a1b2c3.png",
 "stats":"https://urlik.xyz/a1b2c3+", "mode":"redirect" } }

POST /api/stats.json

Stats for a link. The code parameter is the short code. Returns the click count, a daily series, sources, devices and browsers.

POST /api/links.json

List your links. Requires X-Api-Key.

POST /api/update.json

Update a link (code + fields url, mode, expire, password). Requires a key/session.

POST /api/delete.json

Delete a link (code). Requires X-Api-Key or the owner's session.

Media downloader, QR codes and temporary email

These methods require the X-Api-Key header (your key is in your account) or a call through RapidAPI.

MethodParametersDescription
GET /api/download.jsonurl*download video/photo from 1000+ sites (TikTok, YouTube, Instagram…): returns formats with ready signed download links (MP4/MP3/image)
GET /api/qr.jsondata*, format, fg, bg, ecc, sizeQR code: format = png/svg, colors fg/bg
GET /api/mailbox.jsonaddress or usernameget or create a temporary address
GET /api/messages.jsonaddresslist messages in a temporary inbox
GET /api/message.jsonaddress, idread a single message

Live ausprobieren

Erkunden und rufen Sie jeden Endpunkt direkt hier auf. Fügen Sie Ihren API-Schlüssel über die Schaltfläche Authorize ein, um authentifizierte Anfragen zu senden.

Shortener einbetten

Fügen Sie dieses Snippet auf einer beliebigen Seite ein, um einen funktionierenden URL-Shortener mit Link zu urlik.xyz zu erhalten:

<iframe src="https://urlik.xyz/embed" style="width:100%;max-width:520px;height:150px;border:0" title="URL shortener by urlik.xyz" loading="lazy"></iframe>

/embed ↗

Eine einfache REST-API für Kurzlinks

Mit der REST-API von Urlik erstellen, lesen, aktualisieren und löschen Sie Kurzlinks aus Ihrem eigenen Code und rufen Klick-Statistiken als JSON ab. Es ist eine schlichte HTTPS-API — POST-Anfrage senden, vorhersehbare JSON-Antwort erhalten — und funktioniert daher aus jeder Sprache und auf jeder Plattform.

Einfaches Kürzen benötigt keine Zugangsdaten. Um Links Ihrem Konto zuzuordnen und später zu verwalten, senden Sie Ihren Schlüssel im Header X-Api-Key, den Sie in Ihrem Konto finden. Die Antworten folgen stets derselben Struktur aus status, message und return, wie unten gezeigt.

Brauche ich einen API-Schlüssel?

Nicht für einfaches Kürzen — einen Link können Sie anonym erstellen. Ein Schlüssel, zu finden in Ihrem Konto, ordnet Links Ihnen zu und ist zum Auflisten, Aktualisieren oder Löschen erforderlich.

In welchem Format kommen die Antworten?

Jeder Endpunkt liefert JSON mit einem status, einer menschenlesbaren message und einem return-Objekt mit den Daten — das Parsen bleibt über alle Aufrufe hinweg konsistent.

Gibt es ein Rate-Limit?

Ja, Anfragen werden pro Aufrufer begrenzt, damit der Dienst schnell und fair bleibt. Authentifizierte Schlüssel erhalten ein höheres Kontingent als anonymer Traffic.

Kann ich sie aus jeder Sprache nutzen?

Ja. Es ist eine standardmäßige HTTPS-JSON-API — alles, was eine POST-Anfrage senden kann (curl, Python, PHP, JavaScript oder Go), kann sie nutzen.

Welche Suchanfragen diese Seite beantwortet