market

Documentation

Index

• Constants
• type MarketClient
  • func (a *MarketClient) GetChartData(ctx context.Context, params *models.GetChartDataParams, ...) (*models.GetChartDataResponse, error)
  • func (a *MarketClient) GetInstrument(ctx context.Context, params *models.GetInstrumentParams, ...) (*models.GetInstrumentResponse, error)
  • func (a *MarketClient) GetMarketData(ctx context.Context, params *models.GetMarketDataParams, ...) (*models.GetMarketDataResponse, error)
  • func (a *MarketClient) Search(ctx context.Context, params *models.SearchParams, ...) (*models.SearchResponse, error)

Constants

const (
	GetInstrumentPath = "/_api/market-guide/{instrument}/{id}"
	SearchPath        = "/_mobile/market/search/{instrument}"
	GetMarketDataPath = "/_cqbe/trading/marketdata/{orderbookID}"
	GetChartDataPath  = "/_api/price-chart/stock/{orderbookID}?timePeriod={timePeriod}&resolution={resolution}"
)

const (
	ChartDataTimePeriodOneToday    = "today"
	ChartDataTimePeriodOneWeek     = "one_week"
	ChartDataTimePeriodOneMonth    = "one_month"
	ChartDataTimePeriodThreeMonths = "three_months"
	ChartDataTimePeriodSixMonths   = "six_months"
	ChartDataTimePeriodThisYear    = "this_year"
	ChartDataTimePeriodOneYear     = "one_year"
	ChartDataTimePeriodThreeYears  = "three_years"
	ChartDataTimePeriodFiveYears   = "five_years"
	ChartDataTimePeriodInfinity    = "infinity"
)

const (
	ChartDataResolutionMinute    = "minute"
	ChartDataResolutionTwoMin    = "two_minutes"
	ChartDataResolutionTenMin    = "ten_minutes"
	ChartDataResolutionThirtyMin = "thirty_minutes"
	ChartDataResolutionHour      = "hour"
	ChartDataResolutionDay       = "day"
	ChartDataResolutionWeek      = "week"
)

Types

type MarketClient

type MarketClient struct {
	*client.Client
}

func (*MarketClient) GetChartData

func (a *MarketClient) GetChartData(ctx context.Context, params *models.GetChartDataParams, options ...models.RequestOption) (*models.GetChartDataResponse, error)

func (*MarketClient) GetInstrument

func (a *MarketClient) GetInstrument(ctx context.Context, params *models.GetInstrumentParams, options ...models.RequestOption) (*models.GetInstrumentResponse, error)

GetInstrument gets metadata information about a specific instrument

func (*MarketClient) GetMarketData

func (a *MarketClient) GetMarketData(ctx context.Context, params *models.GetMarketDataParams, options ...models.RequestOption) (*models.GetMarketDataResponse, error)

GetMarketData gets the latest market for specific order-book

func (*MarketClient) Search

func (a *MarketClient) Search(ctx context.Context, params *models.SearchParams, options ...models.RequestOption) (*models.SearchResponse, error)

Search for metadata information about tickers, fund or other instruments