tbapi.api.models.period_type

 1from enum import Enum
 2
 3class PeriodType(Enum):
 4    """Defines the different period types for the bar."""
 5
 6    __None__ = 0
 7    """No period type specified."""
 8
 9    Day = 1
10    """The daily period."""
11
12    Week = 2
13    """The weekly period."""
14
15    Month = 3
16    """The monthly period."""
17
18    Year = 4
19    """The yearly period."""
20
21    Second = 5
22    """The period based on seconds."""
23
24    Minute = 6
25    """The period based on minutes."""
26
27    Level2 = 7
28    """The Level 2 period, typically used for market depth data."""
29
30    Tick = 8
31    """The tick-based period."""
32
33    Range = 9
34    """The range-based period."""
35
36    Volume = 10
37    """The volume-based period."""
38
39    Momentum = 11
40    """The momentum-based period."""
41
42    HeikinAshi = 12
43    """The Heikin Ashi period, a type of candlestick chart."""
44
45    Renko = 13
46    """The Renko period, another type of chart that ignores time."""
47
48    Kagi = 14
49    """The Kagi chart period."""
50
51    LineBreak = 15
52    """The Line Break chart period."""
53
54    PointAndFigureClose = 16
55    """The Point and Figure chart with close-based periods."""
56
57    PointAndFigureHighLow = 17
58    """The Point and Figure chart with high-low periods."""
59
60    BidAsk = 18
61    """The bid-ask period."""
62
63    Custom = 19
64    """The custom period type defined by the user."""
class PeriodType(enum.Enum):
 6class PeriodType(Enum):
 7    """Defines the different period types for the bar."""
 8
 9    __None__ = 0
10    """No period type specified."""
11
12    Day = 1
13    """The daily period."""
14
15    Week = 2
16    """The weekly period."""
17
18    Month = 3
19    """The monthly period."""
20
21    Year = 4
22    """The yearly period."""
23
24    Second = 5
25    """The period based on seconds."""
26
27    Minute = 6
28    """The period based on minutes."""
29
30    Level2 = 7
31    """The Level 2 period, typically used for market depth data."""
32
33    Tick = 8
34    """The tick-based period."""
35
36    Range = 9
37    """The range-based period."""
38
39    Volume = 10
40    """The volume-based period."""
41
42    Momentum = 11
43    """The momentum-based period."""
44
45    HeikinAshi = 12
46    """The Heikin Ashi period, a type of candlestick chart."""
47
48    Renko = 13
49    """The Renko period, another type of chart that ignores time."""
50
51    Kagi = 14
52    """The Kagi chart period."""
53
54    LineBreak = 15
55    """The Line Break chart period."""
56
57    PointAndFigureClose = 16
58    """The Point and Figure chart with close-based periods."""
59
60    PointAndFigureHighLow = 17
61    """The Point and Figure chart with high-low periods."""
62
63    BidAsk = 18
64    """The bid-ask period."""
65
66    Custom = 19
67    """The custom period type defined by the user."""

Defines the different period types for the bar.

Day = <PeriodType.Day: 1>

The daily period.

Week = <PeriodType.Week: 2>

The weekly period.

Month = <PeriodType.Month: 3>

The monthly period.

Year = <PeriodType.Year: 4>

The yearly period.

Second = <PeriodType.Second: 5>

The period based on seconds.

Minute = <PeriodType.Minute: 6>

The period based on minutes.

Level2 = <PeriodType.Level2: 7>

The Level 2 period, typically used for market depth data.

Tick = <PeriodType.Tick: 8>

The tick-based period.

Range = <PeriodType.Range: 9>

The range-based period.

Volume = <PeriodType.Volume: 10>

The volume-based period.

Momentum = <PeriodType.Momentum: 11>

The momentum-based period.

HeikinAshi = <PeriodType.HeikinAshi: 12>

The Heikin Ashi period, a type of candlestick chart.

Renko = <PeriodType.Renko: 13>

The Renko period, another type of chart that ignores time.

Kagi = <PeriodType.Kagi: 14>

The Kagi chart period.

LineBreak = <PeriodType.LineBreak: 15>

The Line Break chart period.

PointAndFigureClose = <PeriodType.PointAndFigureClose: 16>

The Point and Figure chart with close-based periods.

PointAndFigureHighLow = <PeriodType.PointAndFigureHighLow: 17>

The Point and Figure chart with high-low periods.

BidAsk = <PeriodType.BidAsk: 18>

The bid-ask period.

Custom = <PeriodType.Custom: 19>

The custom period type defined by the user.