Time Information

AdjustTimestamp

Adjusts an Unix timestamp.

Syntax: AdjustTimestamp([ unix ], [ addSeconds ], [ addMinutes ], [ addHours ], [ addDays ], [ addMonths ], [ addYears ])

Returns the new Unix timestamp.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Input,Number,SessionGet

addSeconds

Number

False

Input,Number,SessionGet

addMinutes

Number

False

Input,Number,SessionGet

addHours

Number

False

Input,Number,SessionGet

addDays

Number

False

Input,Number,SessionGet

addMonths

Number

False

Input,Number,SessionGet

addYears

Number

False

Input,Number,SessionGet

CloseTime

Converts a timestamps to the close timestamp of the candle.

Syntax: CloseTime(unix, interval)

Returns the close timestamp of the candle.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

True

Input,Number,SessionGet

interval

Number

True

InputInterval,Number,CurrentInterval

CreateTimestamp

Creates an Unix timestamp from the specified value.

Syntax: CreateTimestamp([ year ], [ month ], [ day ], [ hour ], [ minute ], [ second ])

Returns the Unix timestamp.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

year

Number

False

Input,Number,SessionGet

month

Number

False

Input,Number,SessionGet

day

Number

False

Input,Number,SessionGet

hour

Number

False

Input,Number,SessionGet

minute

Number

False

Input,Number,SessionGet

second

Number

False

Input,Number,SessionGet

CurrentDate

Gets the date of the month of the current time or requested time. Based on UTC.

Syntax: CurrentDate([ unix ])

Returns the date of the month value. A number from 1 to 31.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Input,Number,SessionGet

CurrentDay

Gets the day of the week of the current time or requested time. Based on UTC.

Syntax: CurrentDay([ unix ])

Returns the day of the week value. A number from 1 to 7, starting on Sunday.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Input,Number,SessionGet

CurrentHour

Gets the hour the current time or requested time. Based on UTC.

Syntax: CurrentHour([ unix ])

Returns the hour value. A number from 0 to 23.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Input,Number,SessionGet

CurrentMinute

Gets the minute the current time or requested time. Based on UTC.

Syntax: CurrentMinute([ unix ])

Returns the minute value. A number from 0 to 59.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Input,Number,SessionGet

CurrentMonth

Gets the month of the year of the current time or requested time. Based on UTC.

Syntax: CurrentMonth([ unix ])

Returns the month of the year value. A number from 1 to 12.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Input,Number,SessionGet

CurrentSecond

Gets the second the current time or requested time. Based on UTC.

Syntax: CurrentSecond([ unix ])

Returns the second value. A number from 0 to 59.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Input,Number,SessionGet

CurrentWeek

Gets the week of the year of the current time or requested time. Based on UTC.

Syntax: CurrentWeek([ unix ])

Returns the week of the year value. A number from 1 to 53.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Input,Number,SessionGet

CurrentYear

Gets the year the current time or requested time. Based on UTC.

Syntax: CurrentYear([ unix ])

Returns the year.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Input,Number,SessionGet

FormatDateTime

Formats a unix datetime number (to "YYYY-MM-DD at HH:MM" by default).

Syntax: FormatDateTime([ unix ], [ dateDelimiter ], [ dateTimeDelimiter ], [ timeDelimiter ], [ includeSeconds ], [ includeTime ], [ includeYear ])

The formatted unix datetime number.

Return type: String

Parameter NameParameter TypeRequiredSuggestions

unix

Number

False

Time

dateDelimiter

String

False

Text

dateTimeDelimiter

String

False

Text

timeDelimiter

String

False

Text

includeSeconds

Boolean

False

True,False

includeTime

Boolean

False

True,False

includeYear

Boolean

False

True,False

GetTimer

Gets the elapsed time for a timer.

Syntax: GetTimer([ key ])

Returns the elapsed time in milliseconds.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

key

String

False

Text,Input,SessionGet,Load

MinutesTillCandleClose

Calculates the number of minutes before a new candle opens.

Syntax: MinutesTillCandleClose(interval)

Returns the number of minutes before a new candle opens.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

interval

Number

True

InputInterval,Number,CurrentInterval

OpenTime

Converts a timestamps to the open timestamp of the candle

Syntax: OpenTime(unix, interval)

Returns the open timestamp of the candle.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

unix

Number

True

Input,Number,SessionGet

interval

Number

True

InputInterval,Number,CurrentInterval

StartTimer

Starts a timer.

Syntax: StartTimer([ key ])

Return type: Void

Parameter NameParameter TypeRequiredSuggestions

key

String

False

Text,Input,SessionGet,Load

StopTimer

Stops a timer.

Syntax: StopTimer([ key ])

Returns the elapsed time in milliseconds.

Return type: Number

Parameter NameParameter TypeRequiredSuggestions

key

String

False

Text,Input,SessionGet,Load

Time

Gets the current unix timestamp. Based on UTC.

Syntax: Time()

Returns the current unix timestamp.

Return type: Number

Last updated