Difference between revisions of "API Timeframes constants"

From NakedMarkets
Jump to navigation Jump to search
Line 9: Line 9:
! Constant name !! Value !! Value in minutes
! Constant name !! Value !! Value in minutes
|-
|-
| '''PERIOD_CURRENT''' || Current Timeframe ||  0
| '''Timeframe.PERIOD_CURRENT''' || Current Timeframe ||  0
|-
|-
| '''PERIOD_M1''' || Timeframe M1 || 1
| '''Timeframe.PERIOD_M1''' || Timeframe M1 || 1
|-
|-
| '''PERIOD_M5''' || Timeframe M5 || 5
| '''Timeframe.PERIOD_M5''' || Timeframe M5 || 5
|-
|-
| '''PERIOD_M15''' || Timeframe M15 || 15
| '''Timeframe.PERIOD_M15''' || Timeframe M15 || 15
|-
|-
| '''PERIOD_M30''' || Timeframe M30 || 30
| '''Timeframe.PERIOD_M30''' || Timeframe M30 || 30
|-
|-
| '''PERIOD_H1''' || Timeframe H1 || 60
| '''Timeframe.PERIOD_H1''' || Timeframe H1 || 60
|-
|-
| '''PERIOD_H4''' || Timeframe H4 || 240
| '''Timeframe.PERIOD_H4''' || Timeframe H4 || 240
|-
|-
| '''PERIOD_D1''' || Timeframe D1 || 1440
| '''Timeframe.PERIOD_D1''' || Timeframe D1 || 1440
|-
|-
| '''PERIOD_W1''' || Timeframe W1 || 10080
| '''Timeframe.PERIOD_W1''' || Timeframe W1 || 10080
|-
|-
| '''PERIOD_MN1''' || Timeframe MN1 || 43200
| '''Timeframe.PERIOD_MN1''' || Timeframe MN1 || 43200
|}
|}
=== Examples ===
C# code snippet :
<code>
        public override void OnCalculate(int index)
        {
            // Avoid the use of Timeframe equal and higher than D1
            if (index != 0 || Period() >= (int)Timeframe.PERIOD_D1)
                return;
            [...]
        }
</code>

Revision as of 04:23, 5 January 2023

Summary

The Timeframes constants are used to define the different timeframes.
It represents the Timeframe value in minutes.

Definition

Constant name Value Value in minutes
Timeframe.PERIOD_CURRENT Current Timeframe 0
Timeframe.PERIOD_M1 Timeframe M1 1
Timeframe.PERIOD_M5 Timeframe M5 5
Timeframe.PERIOD_M15 Timeframe M15 15
Timeframe.PERIOD_M30 Timeframe M30 30
Timeframe.PERIOD_H1 Timeframe H1 60
Timeframe.PERIOD_H4 Timeframe H4 240
Timeframe.PERIOD_D1 Timeframe D1 1440
Timeframe.PERIOD_W1 Timeframe W1 10080
Timeframe.PERIOD_MN1 Timeframe MN1 43200

Examples

C# code snippet :

       public override void OnCalculate(int index)
       {
           // Avoid the use of Timeframe equal and higher than D1
           if (index != 0 || Period() >= (int)Timeframe.PERIOD_D1)
               return;
           [...]
       }