API Docs — Shortix | Developer Reference

Base URL https://shortix.xyz/api All responses are JSON • CORS enabled

INFO

Authentication

Bearer Token & API Key

Two authentication methods: Firebase ID token for users, or static API Key for server-to-server integrations.

Required on some endpoints

POST

Shorten a URL

/api/shorten

Create a new short link with an optional custom alias. Returns the shortened URL and full metadata.

Auth required

GET

Get Link Info

/api/info/:code

Retrieve metadata for any short link by its code — original URL, click count, creation date, and more.

Public

GET

Global Stats

/api/stats

Fetch platform-wide counters: total links created, total clicks, custom links, and image conversions.

Public

PATCH

Update a Link

/api/link/:code

Update the tag, max clicks, or expiry of an existing link. Only the owner can edit their links.

Auth required

DELETE

Delete a Link

/api/link/:code

Permanently remove a short link. Token users can only delete their own links; API key users can delete any link.

Auth required

Field	Type	Required	Description
url	`string`	Yes	The original long URL. Must start with `http://` or `https://`
alias	`string`	No	Custom alias (3–32 chars, letters / numbers / hyphens / underscores). Auto-generated if omitted.

Code	Reason
400	Missing or invalid URL, or invalid alias format
401	No authentication credentials provided
409	Alias already taken — choose a different one

Code	Reason
400	No code provided in the URL path
404	No link found for the given code

Field	Type	Description
totalLinks	`number`	Total short links created on the platform
totalClicks	`number`	Total redirect clicks across all links
totalCustomLinks	`number`	Total links created with a custom alias
totalConversions	`number`	Total image conversions performed

Field	Type	Required	Description
tag	`string \| null`	Optional	New label/tag (max 32 chars). Pass `null` to remove.
maxClicks	`number \| null`	Optional	New max clicks limit. Pass `0` or `null` to remove limit.
expiresIn	`"1d"\|"7d"\|"30d"\|"90d"\|"never"`	Optional	New expiry from now, or `"never"` to remove expiry.

Code	Reason
401	No authentication credentials provided
403	Forbidden — you don't own this link
404	No link found for the given code

Shortix API Reference