TimeFrame

TimeFrameUnit

enum alpaca.data.timeframe.TimeFrameUnit(value)

Quantity of time used as unit

Member Type:

str

Valid values are as follows:

Minute: str = <TimeFrameUnit.Minute: 'Min'>
Hour: str = <TimeFrameUnit.Hour: 'Hour'>
Day: str = <TimeFrameUnit.Day: 'Day'>
Week: str = <TimeFrameUnit.Week: 'Week'>
Month: str = <TimeFrameUnit.Month: 'Month'>

TimeFrame

class alpaca.data.timeframe.TimeFrame(amount: int, unit: TimeFrameUnit)

A time interval specified in multiples of defined units (minute, day, etc)

Pass a TimeFrameUnit and a positive integer amount, or use a preset directly:

TimeFrame(amount=5, unit=TimeFrameUnit.Minute)
TimeFrame.Hour

Presets such as TimeFrame.Hour are already TimeFrame instances. Pass the preset as the timeframe. Do not wrap one as unit.

amount_value

The number of multiples of the TimeFrameUnit interval

Type:

int

unit_value

The base unit of time interval that is used to measure the TimeFrame

Type:

TimeFrameUnit

Raises:
  • ValueError – Raised if the amount_value and unit_value are not consistent with each other

  • TypeError – Raised if unit is not a TimeFrameUnit

Day = <alpaca.data.timeframe.TimeFrame object>
Hour = <alpaca.data.timeframe.TimeFrame object>
Minute = <alpaca.data.timeframe.TimeFrame object>
Month = <alpaca.data.timeframe.TimeFrame object>
Week = <alpaca.data.timeframe.TimeFrame object>