polygon

func (*AggsClient) GetDailyOpenCloseAgg ¶

func (ac *AggsClient) GetDailyOpenCloseAgg(ctx context.Context, params *models.GetDailyOpenCloseAggParams, opts ...models.RequestOption) (*models.GetDailyOpenCloseAggResponse, error)

GetDailyOpenCloseAgg 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 (*AggsClient) GetGroupedDailyAggs ¶

func (ac *AggsClient) 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 (*AggsClient) GetPreviousCloseAgg ¶

func (ac *AggsClient) GetPreviousCloseAgg(ctx context.Context, params *models.GetPreviousCloseAggParams, opts ...models.RequestOption) (*models.GetPreviousCloseAggResponse, error)

GetPreviousCloseAgg 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.

func (*AggsClient) ListAggs ¶ added in v1.9.0

func (ac *AggsClient) ListAggs(ctx context.Context, params *models.ListAggsParams, options ...models.RequestOption) *iter.Iter[models.Agg]

ListAggs 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.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListAggs(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*IndicatorsClient) GetEMA ¶ added in v1.3.0

func (ic *IndicatorsClient) GetEMA(ctx context.Context, params *models.GetEMAParams, opts ...models.RequestOption) (*models.GetEMAResponse, error)

GetEMA retrieves exponential moving average data over the given time range with the specified parameters. For example, if timespan = 'day' and window = '10', a 10-period exponential moving average will be calculated using day aggregates for each period. For more details see https://polygon.io/docs/stocks/get_v1_indicators_ema__stockticker.

func (*IndicatorsClient) GetMACD ¶ added in v1.3.0

func (ic *IndicatorsClient) GetMACD(ctx context.Context, params *models.GetMACDParams, opts ...models.RequestOption) (*models.GetMACDResponse, error)

GetMACD retrieves moving average convergence divergence data over the given time range with the specified parameters. For example, if timespan = 'day', short_window = '12', long_window = '26' and signal_window = '9', the MACD will be calculated by taking the difference between a 26-period EMA and a 12-period EMA. The signal line values will be calculated by taking the 9-day ema of the difference, and the histogram values will be calculated by taking the difference between the MACD values and the signal line. For more details see https://polygon.io/docs/stocks/get_v1_indicators_macd__stockticker.

func (*IndicatorsClient) GetRSI ¶ added in v1.3.0

func (ic *IndicatorsClient) GetRSI(ctx context.Context, params *models.GetRSIParams, opts ...models.RequestOption) (*models.GetRSIResponse, error)

GetRSI retrieves relative strength index data over the given time range with the specified parameters. For example, if timespan = 'day' and window = '10', a 10-period relative strength index will be calculated using day aggregates for each period. For more details see https://polygon.io/docs/stocks/get_v1_indicators_rsi__stockticker.

func (*IndicatorsClient) GetSMA ¶ added in v1.3.0

func (ic *IndicatorsClient) GetSMA(ctx context.Context, params *models.GetSMAParams, opts ...models.RequestOption) (*models.GetSMAResponse, error)

GetSMA retrieves simple moving average data over the given time range with the specified parameters. For example, if timespan = 'day' and window = '10', a 10-period simple moving average will be calculated using day aggregates for each period. For more details see https://polygon.io/docs/stocks/get_v1_indicators_sma__stockticker.

func (*QuotesClient) GetLastForexQuote ¶

func (c *QuotesClient) GetLastForexQuote(ctx context.Context, params *models.GetLastForexQuoteParams, options ...models.RequestOption) (*models.GetLastForexQuoteResponse, error)

GetLastForexQuote retrieves the last quote (BBO) for a forex currency pair. For more details see https://polygon.io/docs/forex/get_v1_last_quote_currencies__from___to.

func (*QuotesClient) GetLastQuote ¶

func (c *QuotesClient) GetLastQuote(ctx context.Context, params *models.GetLastQuoteParams, options ...models.RequestOption) (*models.GetLastQuoteResponse, error)

GetLastQuote retrieves the last quote (NBBO) for a specified ticker. For more details see https://polygon.io/docs/stocks/get_v2_last_nbbo__stocksticker.

func (*QuotesClient) GetRealTimeCurrencyConversion ¶ added in v0.5.0

func (c *QuotesClient) GetRealTimeCurrencyConversion(ctx context.Context, params *models.GetRealTimeCurrencyConversionParams, options ...models.RequestOption) (*models.GetRealTimeCurrencyConversionResponse, error)

GetRealTimeCurrencyConversion retrieves retrieves currency conversion using the latest market conversion rates. Note that you can convert in both directions. For more details see https://polygon.io/docs/forex/get_v1_conversion__from___to.

func (*QuotesClient) ListQuotes ¶

func (c *QuotesClient) ListQuotes(ctx context.Context, params *models.ListQuotesParams, options ...models.RequestOption) *iter.Iter[models.Quote]

ListQuotes retrieves quotes for a specified ticker. For more details see https://polygon.io/docs/stocks/get_v3_quotes__stockticker.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListQuotes(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*ReferenceClient) GetExchanges ¶

func (c *ReferenceClient) GetExchanges(ctx context.Context, params *models.GetExchangesParams, options ...models.RequestOption) (*models.GetExchangesResponse, error)

GetExchanges lists all exchanges that Polygon knows about. For more details see https://polygon.io/docs/stocks/get_v3_reference_exchanges.

func (*ReferenceClient) GetMarketHolidays ¶

func (c *ReferenceClient) GetMarketHolidays(ctx context.Context, options ...models.RequestOption) (*models.GetMarketHolidaysResponse, error)

GetMarketHolidays retrieves upcoming market holidays and their open/close times. For more details see https://polygon.io/docs/stocks/get_v1_marketstatus_upcoming.

func (*ReferenceClient) GetMarketStatus ¶

func (c *ReferenceClient) GetMarketStatus(ctx context.Context, options ...models.RequestOption) (*models.GetMarketStatusResponse, error)

GetMarketStatus retrieves the current trading status of the exchanges and overall financial markets. For more details see https://polygon.io/docs/stocks/get_v1_marketstatus_now.

func (*ReferenceClient) GetOptionsContract ¶ added in v0.10.0

func (c *ReferenceClient) GetOptionsContract(ctx context.Context, params *models.GetOptionsContractParams, options ...models.RequestOption) (*models.GetOptionsContractResponse, error)

GetOptionsContract retrieves a historical options contract. For more details see https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker.

func (*ReferenceClient) GetTickerDetails ¶

func (c *ReferenceClient) GetTickerDetails(ctx context.Context, params *models.GetTickerDetailsParams, options ...models.RequestOption) (*models.GetTickerDetailsResponse, error)

GetTickerDetails retrieves details for a specified ticker. For more details see https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker.

func (*ReferenceClient) GetTickerTypes ¶

func (c *ReferenceClient) GetTickerTypes(ctx context.Context, params *models.GetTickerTypesParams, options ...models.RequestOption) (*models.GetTickerTypesResponse, error)

GetTickerTypes retrieves all the possible ticker types that can be queried. For more details see https://polygon.io/docs/stocks/get_v3_reference_tickers_types.

func (*ReferenceClient) ListConditions ¶

func (c *ReferenceClient) ListConditions(ctx context.Context, params *models.ListConditionsParams, options ...models.RequestOption) *iter.Iter[models.Condition]

ListConditions retrieves reference conditions. For more details see https://polygon.io/docs/stocks/get_v3_reference_conditions.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListConditions(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*ReferenceClient) ListDividends ¶

func (c *ReferenceClient) ListDividends(ctx context.Context, params *models.ListDividendsParams, options ...models.RequestOption) *iter.Iter[models.Dividend]

ListDividends retrieves reference dividends. For more details see https://polygon.io/docs/stocks/get_v3_reference_dividends.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListDividends(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*ReferenceClient) ListOptionsContracts ¶ added in v0.10.0

func (c *ReferenceClient) ListOptionsContracts(ctx context.Context, params *models.ListOptionsContractsParams, options ...models.RequestOption) *iter.Iter[models.OptionsContract]

ListOptionsContracts lists historical options contracts. For more details see https://polygon.io/docs/options/get_v3_reference_options_contracts.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListOptionsContracts(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*ReferenceClient) ListSplits ¶

func (c *ReferenceClient) ListSplits(ctx context.Context, params *models.ListSplitsParams, options ...models.RequestOption) *iter.Iter[models.Split]

ListSplits retrieves reference splits. For more details see https://polygon.io/docs/stocks/get_v3_reference_splits.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListSplits(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*ReferenceClient) ListTickerNews ¶ added in v0.4.0

func (c *ReferenceClient) ListTickerNews(ctx context.Context, params *models.ListTickerNewsParams, options ...models.RequestOption) *iter.Iter[models.TickerNews]

ListTickerNews retrieves news articles for a specified ticker. For more details see https://polygon.io/docs/stocks/get_v2_reference_news.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListTickerNews(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*ReferenceClient) ListTickers ¶

func (c *ReferenceClient) ListTickers(ctx context.Context, params *models.ListTickersParams, options ...models.RequestOption) *iter.Iter[models.Ticker]

ListTickers retrieves reference tickers. For more details see https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListTickers(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*SnapshotClient) GetAllTickersSnapshot ¶

func (ac *SnapshotClient) GetAllTickersSnapshot(ctx context.Context, params *models.GetAllTickersSnapshotParams, opts ...models.RequestOption) (*models.GetAllTickersSnapshotResponse, error)

GetAllTickersSnapshot gets the current minute, day, and previous day's aggregate, as well as the last trade and quote for all symbols of a specified market type.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.

For more details see https://polygon.io/docs/stocks/get_v2_snapshot_locale_us_markets_stocks_tickers.

func (*SnapshotClient) GetCryptoFullBookSnapshot ¶

func (ac *SnapshotClient) GetCryptoFullBookSnapshot(ctx context.Context, params *models.GetCryptoFullBookSnapshotParams, opts ...models.RequestOption) (*models.GetCryptoFullBookSnapshotResponse, error)

GetCryptoFullBookSnapshot gets the current level 2 book of a single cryptocurrency ticker. This is the combined book from all of the exchanges.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.

For more details see https://polygon.io/docs/crypto/get_v2_snapshot_locale_global_markets_crypto_tickers__ticker__book.

func (*SnapshotClient) GetGainersLosersSnapshot ¶

func (ac *SnapshotClient) GetGainersLosersSnapshot(ctx context.Context, params *models.GetGainersLosersSnapshotParams, opts ...models.RequestOption) (*models.GetGainersLosersSnapshotResponse, error)

GetGainersLosersSnapshot gets the current top 20 gainers or losers of the day in a specific market type.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day's close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day's close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.

For more details see https://polygon.io/docs/stocks/get_v2_snapshot_locale_us_markets_stocks__direction.

func (*SnapshotClient) GetIndicesSnapshot ¶ added in v1.11.0

func (ac *SnapshotClient) GetIndicesSnapshot(ctx context.Context, params *models.GetIndicesSnapshotParams, opts ...models.RequestOption) (*models.GetIndicesSnapshotResponse, error)

func (*SnapshotClient) GetOptionContractSnapshot ¶

func (ac *SnapshotClient) GetOptionContractSnapshot(ctx context.Context, params *models.GetOptionContractSnapshotParams, opts ...models.RequestOption) (*models.GetOptionContractSnapshotResponse, error)

GetOptionContractSnapshot gets the snapshot of an option contract for a stock equity. For more details see https://polygon.io/docs/options/get_v3_snapshot_options__underlyingasset___optioncontract.

func (*SnapshotClient) GetTickerSnapshot ¶

func (ac *SnapshotClient) GetTickerSnapshot(ctx context.Context, params *models.GetTickerSnapshotParams, opts ...models.RequestOption) (*models.GetTickerSnapshotResponse, error)

GetTickerSnapshot gets the current minute, day, and previous day's aggregate, as well as the last trade and quote for a single traded symbol of a specified market type.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.

For more details see https://polygon.io/docs/stocks/get_v2_snapshot_locale_us_markets_stocks_tickers__stocksticker.

func (*SnapshotClient) ListOptionsChainSnapshot ¶ added in v1.7.0

func (ac *SnapshotClient) ListOptionsChainSnapshot(ctx context.Context, params *models.ListOptionsChainParams, options ...models.RequestOption) *iter.Iter[models.OptionContractSnapshot]

ListOptionsChainSnapshot retrieves the snapshot of all options contracts for an underlying ticker. For more details see https://polygon.io/docs/options/get_v3_snapshot_options__underlyingasset.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListOptionsChainSnapshot(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*SummariesClient) GetSummaries ¶ added in v1.6.0

func (ic *SummariesClient) GetSummaries(ctx context.Context, params *models.GetSummaryParams, opts ...models.RequestOption) (*models.GetSummaryResponse, error)

GetSummaries retrieves summaries for the ticker list with the given params. For more details see https://polygon.io/docs/stocks/get_v1_summaries.

func (*TradesClient) GetLastCryptoTrade ¶

func (c *TradesClient) GetLastCryptoTrade(ctx context.Context, params *models.GetLastCryptoTradeParams, options ...models.RequestOption) (*models.GetLastCryptoTradeResponse, error)

GetLastCryptoTrade retrieves the last trade for a crypto pair. For more details see https://polygon.io/docs/crypto/get_v1_last_crypto__from___to.

func (*TradesClient) GetLastTrade ¶

func (c *TradesClient) GetLastTrade(ctx context.Context, params *models.GetLastTradeParams, options ...models.RequestOption) (*models.GetLastTradeResponse, error)

GetLastTrade retrieves the last trade for a specified ticker. For more details see https://polygon.io/docs/stocks/get_v2_last_trade__stocksticker.

func (*TradesClient) ListTrades ¶

func (c *TradesClient) ListTrades(ctx context.Context, params *models.ListTradesParams, options ...models.RequestOption) *iter.Iter[models.Trade]

ListTrades retrieves trades for a specified ticker. For more details see https://polygon.io/docs/stocks/get_v3_trades__stockticker.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListTrades(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}

func (*VXClient) GetTickerEvents ¶ added in v1.8.0

func (c *VXClient) GetTickerEvents(ctx context.Context, params *models.GetTickerEventsParams, options ...models.RequestOption) (*models.GetTickerEventsResponse, error)

GetTickerEvents retrieves a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. // For more details see https://polygon.io/docs/stocks/get_vx_reference_tickers__id__events.

func (*VXClient) ListStockFinancials ¶ added in v0.7.0

func (c *VXClient) ListStockFinancials(ctx context.Context, params *models.ListStockFinancialsParams, options ...models.RequestOption) *iter.Iter[models.StockFinancial]

ListStockFinancials retrieves historical financial data for a stock ticker. The financials data is extracted from XBRL from company SEC filings using the methodology outlined here: http://xbrl.squarespace.com/understanding-sec-xbrl-financi/.

Note: this method utilizes an experimental API and could experience breaking changes or deprecation.

This method returns an iterator that should be used to access the results via this pattern:

iter := c.ListStockFinancials(context.TODO(), params, opts...)
for iter.Next() {
	log.Print(iter.Item()) // do something with the current value
}
if iter.Err() != nil {
	return iter.Err()
}