Documentation
¶
Index ¶
- type Client
- func (ac *Client) GetAggs(ctx context.Context, params *models.GetAggsParams, ...) (*models.GetAggsResponse, error)
- func (ac *Client) GetDailyOpenCloseAgg(ctx context.Context, params *models.GetDailyOpenCloseAggParams, ...) (*models.GetDailyOpenCloseAggResponse, error)
- func (ac *Client) GetGroupedDailyAggs(ctx context.Context, params *models.GetGroupedDailyAggsParams, ...) (*models.GetGroupedDailyAggsResponse, error)
- func (ac *Client) GetPreviousCloseAgg(ctx context.Context, params *models.GetPreviousCloseAggParams, ...) (*models.GetPreviousCloseAggResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client defines a REST client for the Polygon aggs API.
func (*Client) GetAggs ¶
func (ac *Client) GetAggs(ctx context.Context, params *models.GetAggsParams, opts ...models.RequestOption) (*models.GetAggsResponse, error)
GetAggs retrieves aggregate bars for a specified ticker over a given date range in custom time window sizes. For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. For more details see https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__range__multiplier___timespan___from___to.
func (*Client) GetDailyOpenCloseAgg ¶
func (ac *Client) GetDailyOpenCloseAgg(ctx context.Context, params *models.GetDailyOpenCloseAggParams, opts ...models.RequestOption) (*models.GetDailyOpenCloseAggResponse, error)
GetDailyOpenClose retrieves the open, close and afterhours prices of a specific symbol on a certain date. For more details see https://polygon.io/docs/stocks/get_v1_open-close__stocksticker___date.
func (*Client) GetGroupedDailyAggs ¶
func (ac *Client) GetGroupedDailyAggs(ctx context.Context, params *models.GetGroupedDailyAggsParams, opts ...models.RequestOption) (*models.GetGroupedDailyAggsResponse, error)
GetGroupedDailyAggs retrieves the daily open, high, low, and close (OHLC) for the specified market type. For more details see https://polygon.io/docs/stocks/get_v2_aggs_grouped_locale_us_market_stocks__date.
func (*Client) GetPreviousCloseAgg ¶
func (ac *Client) GetPreviousCloseAgg(ctx context.Context, params *models.GetPreviousCloseAggParams, opts ...models.RequestOption) (*models.GetPreviousCloseAggResponse, error)
GetPreviousClose retrieves the previous day's open, high, low, and close (OHLC) for the specified ticker. For more details see https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__prev.