Skip to content

TimeFrame

class cAlgo.API

DesktopCLICloud

Contains supported timeframe values.

Definition

public class TimeFrame

Namespace: cAlgo.API · Group: Period

Examples

Example 1

if (TimeFrame  < TimeFrame.Daily)
    Print("Intraday Trading");
if api.TimeFrame  < TimeFrame.Daily:
    print("Intraday Trading")

Example 2

using cAlgo.API;

namespace cAlgo
{
    // This sample indicator shows how to get a time frame from user via parameters and the get that time frame bars
    // Also you can use the pre-defined time frames
    public partial class Test : Indicator
    {
        // Getting time frame via a parameter from user

        protected override void Initialize()
        {
            Print("Name: ", UserSelectedTimeFrame.Name, " | Short Name: ", UserSelectedTimeFrame.ShortName);

            // Getting another time frame bars data, using user selected time frame
            var barsBasedOnUserSelectedTimeFrame = MarketData.GetBars(UserSelectedTimeFrame);
            // Getting another time frame bars data, using pre-defined TimeFrames
            var barsBasedOnOtherTimeFrame = MarketData.GetBars(TimeFrame.Day2);
        }

        public override void Calculate(int index)
        {
        }
    }
}
import clr
clr.AddReference("cAlgo.API")

from cAlgo.API import *

class Test():
    def initialize(self):
        api.Print(f"Name: {api.UserSelectedTimeFrame.Name} | Short Name: {api.UserSelectedTimeFrame.ShortName}")
        # Getting another time frame bars data, using user selected time frame
        barsBasedOnUserSelectedTimeFrame = api.MarketData.GetBars(api.UserSelectedTimeFrame)
        # Getting another time frame bars data, using pre-defined TimeFrames
        barsBasedOnOtherTimeFrame = api.MarketData.GetBars(TimeFrame.Day2)
{
  "AccessRights": "None",
  "TimeZone": "UTC",
  "IsOverlay": true,
  "Parameters": [
    {
      "Name": "UserSelectedTimeFrame",
      "DisplayName": "Time Frame",
      "Type": "TimeFrame",
      "DefaultValue": "Daily"
    }
  ]
}

Methods

Name Description
ParseDesktopCLICloudTimeFrame It parses a string and if it matched to a timeframe name it returns that time frame otherwise it throws FormatException
TryParseDesktopCLICloudbool It parses a string and if it matched to a timeframe name it sets it to the passed timeFrame parameter

Properties

Name Description
NameDesktopCLICloudstring Returns the name of timeframe
ShortNameDesktopCLICloudstring Returns the short name of timeframe

Fields

Name Description
DailyDesktopCLICloudTimeFrame Daily / D1
Day2DesktopCLICloudTimeFrame Day2 / D2
Day3DesktopCLICloudTimeFrame Day3 / D3
HeikinDailyDesktopCLICloudTimeFrame HeikinDaily / HD1
HeikinDay2DesktopCLICloudTimeFrame HeikinDay2 / HD2
HeikinDay3DesktopCLICloudTimeFrame HeikinDay3 / HD3
HeikinHourDesktopCLICloudTimeFrame HeikinHour / Hh1
HeikinHour12DesktopCLICloudTimeFrame HeikinHour12 / Hh12
HeikinHour2DesktopCLICloudTimeFrame HeikinHour2 / Hh2
HeikinHour3DesktopCLICloudTimeFrame HeikinHour3 / Hh3
HeikinHour4DesktopCLICloudTimeFrame HeikinHour4 / Hh4
HeikinHour6DesktopCLICloudTimeFrame HeikinHour6 / Hh6
HeikinHour8DesktopCLICloudTimeFrame HeikinHour8 / Hh8
HeikinMinuteDesktopCLICloudTimeFrame HeikinMinute / Hm1
HeikinMinute10DesktopCLICloudTimeFrame HeikinMinute10 / Hm10
HeikinMinute15DesktopCLICloudTimeFrame HeikinMinute15 / Hm15
HeikinMinute2DesktopCLICloudTimeFrame HeikinMinute2 / Hm2
HeikinMinute20DesktopCLICloudTimeFrame HeikinMinute20 / Hm20
HeikinMinute3DesktopCLICloudTimeFrame HeikinMinute3 / Hm3
HeikinMinute30DesktopCLICloudTimeFrame HeikinMinute30 / Hm30
HeikinMinute4DesktopCLICloudTimeFrame HeikinMinute4 / Hm4
HeikinMinute45DesktopCLICloudTimeFrame HeikinMinute45 / Hm45
HeikinMinute5DesktopCLICloudTimeFrame HeikinMinute5 / Hm5
HeikinMinute6DesktopCLICloudTimeFrame HeikinMinute6 / Hm6
HeikinMinute7DesktopCLICloudTimeFrame HeikinMinute7 / Hm7
HeikinMinute8DesktopCLICloudTimeFrame HeikinMinute8 / Hm8
HeikinMinute9DesktopCLICloudTimeFrame HeikinMinute9 / Hm9
HeikinMonthlyDesktopCLICloudTimeFrame HeikinMonthly / HMonth1
HeikinWeeklyDesktopCLICloudTimeFrame HeikinWeekly / HW1
HourDesktopCLICloudTimeFrame Hour / h1
Hour12DesktopCLICloudTimeFrame Hour12 / h12
Hour2DesktopCLICloudTimeFrame Hour2 / h2
Hour3DesktopCLICloudTimeFrame Hour3 / h3
Hour4DesktopCLICloudTimeFrame Hour4 / h4
Hour6DesktopCLICloudTimeFrame Hour6 / h6
Hour8DesktopCLICloudTimeFrame Hour8 / h8
MinuteDesktopCLICloudTimeFrame Minute / m1
Minute10DesktopCLICloudTimeFrame Minute10 / m10
Minute15DesktopCLICloudTimeFrame Minute15 / m15
Minute2DesktopCLICloudTimeFrame Minute2 / m2
Minute20DesktopCLICloudTimeFrame Minute20 / m20
Minute3DesktopCLICloudTimeFrame Minute3 / m3
Minute30DesktopCLICloudTimeFrame Minute30 / m30
Minute4DesktopCLICloudTimeFrame Minute4 / m4
Minute45DesktopCLICloudTimeFrame Minute45 / m45
Minute5DesktopCLICloudTimeFrame Minute5 / m5
Minute6DesktopCLICloudTimeFrame Minute6 / m6
Minute7DesktopCLICloudTimeFrame Minute7 / m7
Minute8DesktopCLICloudTimeFrame Minute8 / m8
Minute9DesktopCLICloudTimeFrame Minute9 / m9
MonthlyDesktopCLICloudTimeFrame Monthly / Month1
Range1DesktopCLICloudTimeFrame Range1 / Ra1
Range10DesktopCLICloudTimeFrame Range10 / Ra10
Range100DesktopCLICloudTimeFrame Range100 / Ra100
Range1000DesktopCLICloudTimeFrame Range1000 / Ra1000
Range10000DesktopCLICloudTimeFrame Range10000 / Ra10000
Range150DesktopCLICloudTimeFrame Range150 / Ra150
Range2DesktopCLICloudTimeFrame Range2 / Ra2
Range20DesktopCLICloudTimeFrame Range20 / Ra20
Range200DesktopCLICloudTimeFrame Range200 / Ra200
Range2000DesktopCLICloudTimeFrame Range2000 / Ra2000
Range3DesktopCLICloudTimeFrame Range3 / Ra3
Range30DesktopCLICloudTimeFrame Range30 / Ra30
Range300DesktopCLICloudTimeFrame Range300 / Ra300
Range4DesktopCLICloudTimeFrame Range4 / Ra4
Range5DesktopCLICloudTimeFrame Range5 / Ra5
Range50DesktopCLICloudTimeFrame Range50 / Ra50
Range500DesktopCLICloudTimeFrame Range500 / Ra500
Range5000DesktopCLICloudTimeFrame Range5000 / Ra5000
Range7500DesktopCLICloudTimeFrame Range7500 / Ra7500
Range8DesktopCLICloudTimeFrame Range8 / Ra8
Range80DesktopCLICloudTimeFrame Range80 / Ra80
Range800DesktopCLICloudTimeFrame Range800 / Ra800
Renko1DesktopCLICloudTimeFrame Renko1 / Re1
Renko10DesktopCLICloudTimeFrame Renko10 / Re10
Renko100DesktopCLICloudTimeFrame Renko100 / Re100
Renko1000DesktopCLICloudTimeFrame Renko1000 / Re1000
Renko15DesktopCLICloudTimeFrame Renko15 / Re15
Renko150DesktopCLICloudTimeFrame Renko150 / Re150
Renko2DesktopCLICloudTimeFrame Renko2 / Re2
Renko20DesktopCLICloudTimeFrame Renko20 / Re20
Renko200DesktopCLICloudTimeFrame Renko200 / Re200
Renko2000DesktopCLICloudTimeFrame Renko2000 / Re2000
Renko25DesktopCLICloudTimeFrame Renko25 / Re25
Renko3DesktopCLICloudTimeFrame Renko3 / Re3
Renko30DesktopCLICloudTimeFrame Renko30 / Re30
Renko300DesktopCLICloudTimeFrame Renko300 / Re300
Renko35DesktopCLICloudTimeFrame Renko35 / Re35
Renko4DesktopCLICloudTimeFrame Renko4 / Re4
Renko40DesktopCLICloudTimeFrame Renko40 / Re40
Renko45DesktopCLICloudTimeFrame Renko45 / Re45
Renko5DesktopCLICloudTimeFrame Renko5 / Re5
Renko50DesktopCLICloudTimeFrame Renko50 / Re50
Renko500DesktopCLICloudTimeFrame Renko500 / Re500
Renko6DesktopCLICloudTimeFrame Renko6 / Re6
Renko7DesktopCLICloudTimeFrame Renko7 / Re7
Renko8DesktopCLICloudTimeFrame Renko8 / Re8
Renko800DesktopCLICloudTimeFrame Renko800 / Re800
Renko9DesktopCLICloudTimeFrame Renko9 / Re9
TickDesktopCLICloudTimeFrame Tick / t1
Tick10DesktopCLICloudTimeFrame Tick10 / t10
Tick100DesktopCLICloudTimeFrame Tick100 / t100
Tick1000DesktopCLICloudTimeFrame Tick1000 / t1000
Tick15DesktopCLICloudTimeFrame Tick15 / t15
Tick150DesktopCLICloudTimeFrame Tick150 / t150
Tick2DesktopCLICloudTimeFrame Tick2 / t2
Tick20DesktopCLICloudTimeFrame Tick20 / t20
Tick200DesktopCLICloudTimeFrame Tick200 / t200
Tick25DesktopCLICloudTimeFrame Tick25 / t25
Tick250DesktopCLICloudTimeFrame Tick250 / t250
Tick3DesktopCLICloudTimeFrame Tick3 / t3
Tick30DesktopCLICloudTimeFrame Tick30 / t30
Tick300DesktopCLICloudTimeFrame Tick300 / t300
Tick4DesktopCLICloudTimeFrame Tick4 / t4
Tick40DesktopCLICloudTimeFrame Tick40 / t40
Tick5DesktopCLICloudTimeFrame Tick5 / t5
Tick50DesktopCLICloudTimeFrame Tick50 / t50
Tick500DesktopCLICloudTimeFrame Tick500 / t500
Tick6DesktopCLICloudTimeFrame Tick6 / t6
Tick60DesktopCLICloudTimeFrame Tick60 / t60
Tick7DesktopCLICloudTimeFrame Tick7 / t7
Tick750DesktopCLICloudTimeFrame Tick750 / t750
Tick8DesktopCLICloudTimeFrame Tick8 / t8
Tick80DesktopCLICloudTimeFrame Tick80 / t80
Tick9DesktopCLICloudTimeFrame Tick9 / t9
Tick90DesktopCLICloudTimeFrame Tick90 / t90
WeeklyDesktopCLICloudTimeFrame Weekly / W1