calendar

Documentation

Overview

Package calendar provides market calendar, with which you can check if the market is open at specific point of time. Though the package is generalized to support different market calendars, only the NASDAQ is implemented at this moment. You can create your own calendar if you provide the calendar json string. See nasdaq.go for the format.

Index

• Variables
• type Calendar
  • func New(calendarJSON string) *Calendar
  • func (calendar *Calendar) EpochIsMarketOpen(epoch int64) bool
  • func (calendar *Calendar) EpochMarketClose(epoch int64) *time.Time
  • func (calendar *Calendar) IsMarketDay(t time.Time) bool
  • func (calendar *Calendar) IsMarketOpen(t time.Time) bool
  • func (calendar *Calendar) MarketClose(t time.Time) (mktClose *time.Time)
  • func (calendar *Calendar) Tz() *time.Location
• type MarketState
• type Time
  • func ParseTime(tstr string) Time

Variables

var Nasdaq = New(NasdaqJson)

Nasdaq implements market calendar for the NASDAQ.

var NasdaqJson = `` /* 10869-byte string literal not displayed */

Types

type Calendar

type Calendar struct {
	// contains filtered or unexported fields
}

func New

func New(calendarJSON string) *Calendar

func (*Calendar) EpochIsMarketOpen

func (calendar *Calendar) EpochIsMarketOpen(epoch int64) bool

EpochIsMarketOpen returns true if epoch in calendar's timezone is in the market hours

func (*Calendar) EpochMarketClose

func (calendar *Calendar) EpochMarketClose(epoch int64) *time.Time

EpochMarketClose determines the market close time of the day that the supplied epoch timestamp occurs on. Returns nil if it is not a market day.

func (*Calendar) IsMarketDay

func (calendar *Calendar) IsMarketDay(t time.Time) bool

IsMarketDay check if today is a trading day or not.

func (*Calendar) IsMarketOpen

func (calendar *Calendar) IsMarketOpen(t time.Time) bool

IsMarketOpen returns true if t is in the market hours

func (*Calendar) MarketClose

func (calendar *Calendar) MarketClose(t time.Time) (mktClose *time.Time)

MarketClose determines the market close time of the day that the supplied timestamp occurs on. Returns nil if it is not a market day.

func (*Calendar) Tz

func (calendar *Calendar) Tz() *time.Location

type MarketState

type MarketState int

const (
	Closed MarketState = iota
	EarlyClose
)

type Time

type Time struct {
	// contains filtered or unexported fields
}

func ParseTime

func ParseTime(tstr string) Time