GuidesVariables

Variables

Variables can be used to customize the text used in embeds and discord webhook text. Variables allow allow certain modifiers, that modify their appearance.

Available Variables

Here is a list of all the variables you can use.

Info

Some variables may not work in some cases

User Variables

Notation	Type	Description
`{user.id}`	`int`	The user's ID
`{user.username}`	`string`	The user's username
`{user.token}`	`string`	The user's token
`{user.administrator}`	`bool`	Whether the user is an administrator
`{user.superAdmin}`	`bool`	Whether the user is a super administrator
`{user.systemTheme}`	`string`	The user's system theme
`{user.ratelimit}`	`date`	The user's ratelimit, will return `{unknown_property}` if not ratelimited
`{user.totpSecret}`	`string`	The user's TOTP secret, will return `{unknown_property}` if none set. Unavailable in certain cirumstances

File Variables

Notation	Type	Description
`{file.id}`	`int`	The file's ID
`{file.name}`	`string`	The file's name
`{file.originalName}`	`string?`	The file's original name. Returns `{unknown_property}` if no original name exists for this file.
`{file.mimetype}`	`string`	The file's mimetype
`{file.createdAt}`	`date`	The file's creation date
`{file.expiresAt}`	`date`	The file's expiration date
`{file.maxViews}`	`int`	The file's maximum views
`{file.views}`	`int`	The file's current views
`{file.favorite}`	`bool`	Whether the file is favorited
`{file.embed}`	`bool`	Whether the file will be embedded
`{file.format}`	`string`	The file's format (RANDOM, etc)
`{file.userId}`	`int`	The file's owner's ID
`{file.size}`	`int`	The file's size in bytes. It is recommended to use the `bytes` modifier on this variable.

Url Variables

Notation	Type	Description
`{url.id}`	`int`	The URL's ID
`{url.destination}`	`string`	The URL's destination
`{url.createdAt}`	`date`	The URL's creation date
`{url.vanity}`	`string`	The URL's vanity
`{url.maxViews}`	`int`	The URL's maximum views
`{url.views}`	`int`	The URL's current views
`{url.userId}`	`int`	The URL's owner's ID

Modifiers

Modifiers are noted by a :: after a variable, for example if you wanted to make a variable uppercase, you would use {user.id::upper}.

Info

Modifiers do not work on {link} and {raw_link}

`date` modifiers

Notation	Description	Example Output
`locale`	Returns the date in the systems locale or other specified	`12/11/2022, 3:07:42 PM`
`time`	Returns the time in the systems locale or other specified	`3:07:42 PM`
`date`	Returns the date in the systems locale or other specified	`12/11/2022`
`unix`	Returns the date in unix time	`1639129662`
`iso`	Returns the date in ISO 8601 format	`2022-12-11T15:07:42.000Z`
`utc`	Returns the date in UTC	`Sun, 11 Dec 2022 23:08:57 GMT`
`year`	Returns the year	`2022`
`month`	Returns the month	`12`
`day`	Returns the day	`11`
`hour`	Returns the hour	`15`
`minute`	Returns the minute	`7`
`second`	Returns the second	`42`
`ampm`	Returns "am" or "pm" based on the time (lowercased)	`pm`
`AMPM`	Returns "AM" or "PM" based on the time (uppercased)	`PM`

Date Locales and Timezones

A recent update to Zipline finally adds the ability to specify a locale and or a timezone for the locale, time, and date modifiers.

The syntax for the 2nd modifier is locale,timezone. If you wanted to only specify a timezone you would use ,timezone (the comma before the timezone is required to let Zipline know that you don't want to specify a locale).

For example if you wanted to use the en-UK locale, but with GMT -8:00 (America/Los_Angeles) you would use {file.createdAt::locale/time/date::en-UK,America/Los_Angeles}.

If you wanted to only change the timezone, but use the default (system specified) locale you would use {file.createdAt::locale/time/date::,America/Los_Angeles}.

Useful Info

A list of locales that may or may not work can be found at www.unicode.org/cldr/charts/44/supplemental/language_territory_information.html. To use this, you would take the language code (for example en for English) then append a territory code (for example US for the United States). The final locale should look like en-US. More examples, Japan's Japanese: ja-JP, New Zealand's English: en-NZ.

A list of timezones that may or may not work can be found below:

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

Africa/Algiers

Africa/Asmera

Africa/Bamako

Africa/Bangui

Africa/Banjul

Africa/Bissau

Africa/Blantyre

Africa/Brazzaville

Africa/Bujumbura

Africa/Cairo

Africa/Casablanca

Africa/Ceuta

Africa/Conakry

Africa/Dakar

Africa/Dar_es_Salaam

Africa/Djibouti

Africa/Douala

Africa/El_Aaiun

Africa/Freetown

Africa/Gaborone

Africa/Harare

Africa/Johannesburg

Africa/Juba

Africa/Kampala

Africa/Khartoum

Africa/Kigali

Africa/Kinshasa

Africa/Lagos

Africa/Libreville

Africa/Lome

Africa/Luanda

Africa/Lubumbashi

Africa/Lusaka

Africa/Malabo

Africa/Maputo

Africa/Maseru

Africa/Mbabane

Africa/Mogadishu

Africa/Monrovia

Africa/Nairobi

Africa/Ndjamena

Africa/Niamey

Africa/Nouakchott

Africa/Ouagadougou

Africa/Porto-Novo

Africa/Sao_Tome

Africa/Tripoli

Africa/Tunis

Africa/Windhoek

America/Adak

America/Anchorage

America/Anguilla

America/Antigua

America/Araguaina

America/Argentina

America/Aruba

America/Asuncion

America/Bahia

America/Bahia_Banderas

America/Barbados

America/Belem

America/Belize

America/Blanc-Sablon

America/Boa_Vista

America/Bogota

America/Boise

America/Buenos_Aires

America/Cambridge_Bay

America/Campo_Grande

America/Cancun

America/Caracas

America/Catamarca

America/Cayenne

America/Cayman

America/Chicago

America/Chihuahua

America/Ciudad_Juarez

America/Coral_Harbour

America/Cordoba

America/Costa_Rica

America/Creston

America/Cuiaba

America/Curacao

America/Danmarkshavn

America/Dawson

America/Dawson_Creek

America/Denver

America/Detroit

America/Dominica

America/Edmonton

America/Eirunepe

America/El_Salvador

America/Fort_Nelson

America/Fortaleza

America/Glace_Bay

America/Godthab

America/Goose_Bay

America/Grand_Turk

America/Grenada

America/Guadeloupe

America/Guatemala

America/Guayaquil

America/Guyana

America/Halifax

America/Havana

America/Hermosillo

America/Indiana

America/Indianapolis

America/Inuvik

America/Iqaluit

America/Jamaica

America/Jujuy

America/Juneau

America/Kentucky

America/Kralendijk

America/La_Paz

America/Lima

America/Los_Angeles

America/Louisville

America/Lower_Princes

America/Maceio

America/Managua

America/Manaus

America/Marigot

America/Martinique

America/Matamoros

America/Mazatlan

America/Mendoza

America/Menominee

America/Merida

America/Metlakatla

America/Mexico_City

America/Miquelon

America/Moncton

America/Monterrey

America/Montevideo

America/Montserrat

America/Nassau

America/New_York

America/Nipigon

America/Nome

America/Noronha

America/North_Dakota

America/Ojinaga

America/Panama

America/Pangnirtung

America/Paramaribo

America/Phoenix

America/Port-au-Prince

America/Port_of_Spain

America/Porto_Velho

America/Puerto_Rico

America/Punta_Arenas

America/Rainy_River

America/Rankin_Inlet

America/Recife

America/Regina

America/Resolute

America/Rio_Branco

America/Santa_Isabel

America/Santarem

America/Santiago

America/Santo_Domingo

America/Sao_Paulo

America/Scoresbysund

America/Sitka

America/St_Barthelemy

America/St_Johns

America/St_Kitts

America/St_Lucia

America/St_Thomas

America/St_Vincent

America/Swift_Current

America/Tegucigalpa

America/Thule

America/Thunder_Bay

America/Tijuana

America/Toronto

America/Tortola

America/Vancouver

America/Whitehorse

America/Winnipeg

America/Yakutat

America/Yellowknife

Antarctica/Casey

Antarctica/Davis

Antarctica/DumontDUrville

Antarctica/Macquarie

Antarctica/Mawson

Antarctica/McMurdo

Antarctica/Palmer

Antarctica/Rothera

Antarctica/Syowa

Antarctica/Troll

Antarctica/Vostok

Arctic/Longyearbyen

Asia/Aden

Asia/Almaty

Asia/Amman

Asia/Anadyr

Asia/Aqtau

Asia/Aqtobe

Asia/Ashgabat

Asia/Atyrau

Asia/Baghdad

Asia/Bahrain

Asia/Baku

Asia/Bangkok

Asia/Barnaul

Asia/Beirut

Asia/Bishkek

Asia/Brunei

Asia/Calcutta

Asia/Chita

Asia/Choibalsan

Asia/Colombo

Asia/Damascus

Asia/Dhaka

Asia/Dili

Asia/Dubai

Asia/Dushanbe

Asia/Famagusta

Asia/Gaza

Asia/Hebron

Asia/Hong_Kong

Asia/Hovd

Asia/Irkutsk

Asia/Jakarta

Asia/Jayapura

Asia/Jerusalem

Asia/Kabul

Asia/Kamchatka

Asia/Karachi

Asia/Katmandu

Asia/Khandyga

Asia/Krasnoyarsk

Asia/Kuala_Lumpur

Asia/Kuching

Asia/Kuwait

Asia/Macau

Asia/Magadan

Asia/Makassar

Asia/Manila

Asia/Muscat

Asia/Nicosia

Asia/Novokuznetsk

Asia/Novosibirsk

Asia/Omsk

Asia/Oral

Asia/Phnom_Penh

Asia/Pontianak

Asia/Pyongyang

Asia/Qatar

Asia/Qostanay

Asia/Qyzylorda

Asia/Rangoon

Asia/Riyadh

Asia/Saigon

Asia/Sakhalin

Asia/Samarkand

Asia/Seoul

Asia/Shanghai

Asia/Singapore

Asia/Srednekolymsk

Asia/Taipei

Asia/Tashkent

Asia/Tbilisi

Asia/Tehran

Asia/Thimphu

Asia/Tokyo

Asia/Tomsk

Asia/Ulaanbaatar

Asia/Urumqi

Asia/Ust-Nera

Asia/Vientiane

Asia/Vladivostok

Asia/Yakutsk

Asia/Yekaterinburg

Asia/Yerevan

Atlantic/Azores

Atlantic/Bermuda

Atlantic/Canary

Atlantic/Cape_Verde

Atlantic/Faeroe

Atlantic/Madeira

Atlantic/Reykjavik

Atlantic/South_Georgia

Atlantic/St_Helena

Atlantic/Stanley

Australia/Adelaide

Australia/Brisbane

Australia/Broken_Hill

Australia/Currie

Australia/Darwin

Australia/Eucla

Australia/Hobart

Australia/Lindeman

Australia/Lord_Howe

Australia/Melbourne

Australia/Perth

Australia/Sydney

Europe/Amsterdam

Europe/Andorra

Europe/Astrakhan

Europe/Athens

Europe/Belgrade

Europe/Berlin

Europe/Bratislava

Europe/Brussels

Europe/Bucharest

Europe/Budapest

Europe/Busingen

Europe/Chisinau

Europe/Copenhagen

Europe/Dublin

Europe/Gibraltar

Europe/Guernsey

Europe/Helsinki

Europe/Isle_of_Man

Europe/Istanbul

Europe/Jersey

Europe/Kaliningrad

Europe/Kiev

Europe/Kirov

Europe/Lisbon

Europe/Ljubljana

Europe/London

Europe/Luxembourg

Europe/Madrid

Europe/Malta

Europe/Mariehamn

Europe/Minsk

Europe/Monaco

Europe/Moscow

Europe/Oslo

Europe/Paris

Europe/Podgorica

Europe/Prague

Europe/Riga

Europe/Rome

Europe/Samara

Europe/San_Marino

Europe/Sarajevo

Europe/Saratov

Europe/Simferopol

Europe/Skopje

Europe/Sofia

Europe/Stockholm

Europe/Tallinn

Europe/Tirane

Europe/Ulyanovsk

Europe/Uzhgorod

Europe/Vaduz

Europe/Vatican

Europe/Vienna

Europe/Vilnius

Europe/Volgograd

Europe/Warsaw

Europe/Zagreb

Europe/Zaporozhye

Europe/Zurich

Indian/Antananarivo

Indian/Chagos

Indian/Christmas

Indian/Cocos

Indian/Comoro

Indian/Kerguelen

Indian/Mahe

Indian/Maldives

Indian/Mauritius

Indian/Mayotte

Indian/Reunion

Pacific/Apia

Pacific/Auckland

Pacific/Bougainville

Pacific/Chatham

Pacific/Easter

Pacific/Efate

Pacific/Enderbury

Pacific/Fakaofo

Pacific/Fiji

Pacific/Funafuti

Pacific/Galapagos

Pacific/Gambier

Pacific/Guadalcanal

Pacific/Guam

Pacific/Honolulu

Pacific/Johnston

Pacific/Kiritimati

Pacific/Kosrae

Pacific/Kwajalein

Pacific/Majuro

Pacific/Marquesas

Pacific/Midway

Pacific/Nauru

Pacific/Niue

Pacific/Norfolk

Pacific/Noumea

Pacific/Pago_Pago

Pacific/Palau

Pacific/Pitcairn

Pacific/Ponape

Pacific/Port_Moresby

Pacific/Rarotonga

Pacific/Saipan

Pacific/Tahiti

Pacific/Tarawa

Pacific/Tongatapu

Pacific/Truk

Pacific/Wake

Pacific/Wallis

`string` modifiers

Notation	Description	Example Output
`upper`	Uppercases	`HELLO`
`lower`	Lowercases	`hello`
`title`	Capitalizes	`Hello`
`length`	Returns the length of the string	`5`
`reverse`	Reverses the string	`olleh`
`base64`	Encodes the string in base64	`aGVsbG8=`
`hex`	Encodes the string in hex	`68656c6c6f`

`int` modifiers

Notation	Description	Example Output
`comma`	Adds commas to the number	`1,000`
`hex`	Converts the number to hex	`3e8`
`binary`	Converts the number to binary	`1111101000`
`octal`	Converts the number to octal	`1750`
`bytes`	Converts the number to human readable byte format	`1 KB`

`bool` modifiers

Notation	Description	Example Output
`yesno`	Converts the bool to yes/no	`yes`
`onoff`	Converts the bool to on/off	`on`
`truefalse`	Converts the bool to true/false	`true`

Playground

Type in any variable below to test out the variables.

administrator (1) uploaded test.png (11.9 MB) (original name: originalNameWow.png) at 17:55 today

{
  "user": {
    "administrator": true,
    "id": 1,
    "username": "administrator",
    "token": "qwertyuiopasdfghjkzxcvbnm",
    "superAdmin": true,
    "systemTheme": "default",
    "ratelimit": "2024-03-19T17:55:08.001Z",
    "totpSecret": "1234567890",
    "domains": []
  },
  "file": {
    "id": 1,
    "mimetype": "image/png",
    "name": "test.png",
    "originalName": "originalNameWow.png",
    "createdAt": "2024-03-19T17:55:08.001Z",
    "expiresAt": "2024-03-19T18:15:08.001Z",
    "maxViews": 100,
    "views": 2,
    "favorite": true,
    "embed": true,
    "format": "RANDOM",
    "userId": 1,
    "size": 12456789
  },
  "url": {
    "id": 2,
    "destination": "https://google.com",
    "vanity": "google",
    "createdAt": "2024-03-19T17:55:08.001Z",
    "maxViews": 100,
    "views": 2,
    "userId": 1
  },
  "link": "https://example.com/u/test.png",
  "raw_link": "https://example.com/r/test.png"
}