coinglass

package module

Go to main page

Versions in this module

v1

v1.1.10

Sep 4, 2026

v1.1.9

Aug 26, 2026

v1.1.7

Aug 26, 2026

v1.1.4

Aug 26, 2026

v1.1.0

Jul 12, 2026

Changes in this version

type Client

+ func (c *Client) WSClient(opts ...websocket.Option) *websocket.Client

v1.0.0

Jul 12, 2026

Changes in this version

+ const DefaultBaseDelay

+ const DefaultBaseURL

+ const DefaultMaxAttempts

+ const DefaultTimeout

+ var ErrNotFound = errors.New("coinglass: resource not found")

+ var ErrRateLimited = errors.New("coinglass: rate limit exceeded")

+ var ErrUnauthorized = errors.New("coinglass: unauthorized — check your API key")

+ func BoolPtr(b bool) *bool

+ func Float64Ptr(f float64) *float64

+ func Int64Ptr(i int64) *int64

+ func IntPtr(i int) *int

+ func StringPtr(s string) *string

+ type APIError struct

+ Code string

+ Message string

+ RawBody []byte

+ StatusCode int

+ func (e *APIError) Error() string

+ type ArbitrageItem struct

+ Exchange string

+ FundingRate float64

+ Spread float64

+ Symbol string

+ type BasisHistoryParams struct

+ EndTime *int64

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type BasisPoint struct

+ Basis float64

+ Timestamp int64

+ type Client struct

+ ETF *ETFService

+ Futures *FuturesService

+ Indicators *IndicatorsService

+ Options *OptionsService

+ Spot *SpotService

+ func NewClient(apiKey string, opts ...Option) *Client

+ func NewClientFromEnv(opts ...Option) (*Client, error)

+ type CoinMarket struct

+ FundingRate float64

+ OpenInterestUsd float64

+ Price float64

+ PriceChange1h float64

+ PriceChange24h float64

+ Symbol string

+ TurnoverNumber24h float64

+ VolumeUsd24h float64

+ type CoinbasePremiumParams struct

+ EndTime *int64

+ Limit *int

+ StartTime *int64

+ type CoinsMarketsParams struct

+ Exchanges []string

+ Limit *int

+ Symbol *string

+ type ETFFlowParams struct

+ Interval string

+ Limit *int

+ type ETFFlowPoint struct

+ NetFlow float64

+ Timestamp int64

+ TotalInflow float64

+ TotalOutflow float64

+ type ETFItem struct

+ Holdings float64

+ Name string

+ Ticker string

+ type ETFNetAssetsParams struct

+ Interval string

+ Limit *int

+ type ETFNetAssetsPoint struct

+ NetAssets float64

+ Timestamp int64

+ type ETFService struct

+ func (s *ETFService) BitcoinFlowHistory(ctx context.Context, params *ETFFlowParams) ([]ETFFlowPoint, error)

+ func (s *ETFService) BitcoinList(ctx context.Context) ([]ETFItem, error)

+ func (s *ETFService) BitcoinNetAssetsHistory(ctx context.Context, params *ETFNetAssetsParams) ([]ETFNetAssetsPoint, error)

+ func (s *ETFService) EthereumFlowHistory(ctx context.Context, params *ETFFlowParams) ([]ETFFlowPoint, error)

+ func (s *ETFService) EthereumList(ctx context.Context) ([]ETFItem, error)

+ func (s *ETFService) GrayscaleHoldings(ctx context.Context) ([]GrayscaleHolding, error)

+ type ExchangePair struct

+ Exchange string

+ Pair string

+ Symbol string

+ type FearGreedParams struct

+ Limit *int

+ type FearGreedPoint struct

+ Classification string

+ Timestamp int64

+ Value int

+ type FundingRateArbitrageParams struct

+ Interval *string

+ Limit *int

+ Symbol *string

+ type FundingRateExchange struct

+ Exchange string

+ FundingRate float64

+ Timestamp int64

+ type FundingRateExchangeListParams struct

+ EndTime *int64

+ Exchange *string

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type FundingRateHistoryParams struct

+ EndTime *int64

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type FundingRatePoint struct

+ FundingRate float64

+ FundingRateAnnualPercent float64

+ Timestamp int64

+ type FuturesService struct

+ func (s *FuturesService) CoinsMarkets(ctx context.Context, params *CoinsMarketsParams) ([]CoinMarket, error)

+ func (s *FuturesService) FundingRateArbitrage(ctx context.Context, params *FundingRateArbitrageParams) ([]ArbitrageItem, error)

+ func (s *FuturesService) FundingRateExchangeList(ctx context.Context, params *FundingRateExchangeListParams) ([]FundingRateExchange, error)

+ func (s *FuturesService) FundingRateHistory(ctx context.Context, params *FundingRateHistoryParams) ([]FundingRatePoint, error)

+ func (s *FuturesService) FundingRateOiWeighted(ctx context.Context, params *FundingRateHistoryParams) ([]FundingRatePoint, error)

+ func (s *FuturesService) LargeOrders(ctx context.Context, params *LargeOrdersParams) ([]LargeOrder, error)

+ func (s *FuturesService) LiquidationAggregatedHistory(ctx context.Context, params *LiquidationAggregatedHistoryParams) ([]LiquidationPoint, error)

+ func (s *FuturesService) LiquidationCoinList(ctx context.Context, params *LiquidationCoinListParams) ([]LiquidationCoin, error)

+ func (s *FuturesService) LiquidationHeatmap(ctx context.Context, model int, params *LiquidationHeatmapParams) (*LiquidationHeatmap, error)

+ func (s *FuturesService) LiquidationHistory(ctx context.Context, params *LiquidationHistoryParams) ([]LiquidationPoint, error)

+ func (s *FuturesService) LiquidationMap(ctx context.Context, params *LiquidationMapParams) (*LiquidationMap, error)

+ func (s *FuturesService) LongShortRatioHistory(ctx context.Context, params *LongShortRatioParams) ([]LongShortPoint, error)

+ func (s *FuturesService) OpenInterestAggregatedHistory(ctx context.Context, params *OIHistoryParams) ([]OIHistoryPoint, error)

+ func (s *FuturesService) OpenInterestExchangeList(ctx context.Context, params *OIExchangeListParams) ([]OIExchangeItem, error)

+ func (s *FuturesService) OpenInterestHistory(ctx context.Context, params *OIHistoryParams) ([]OIHistoryPoint, error)

+ func (s *FuturesService) OrderbookHistory(ctx context.Context, params *OrderbookHistoryParams) ([]OrderbookPoint, error)

+ func (s *FuturesService) PairsMarkets(ctx context.Context, params *PairsMarketsParams) ([]PairMarket, error)

+ func (s *FuturesService) PriceChangeList(ctx context.Context) ([]PriceChangeItem, error)

+ func (s *FuturesService) SupportedCoins(ctx context.Context) ([]string, error)

+ func (s *FuturesService) SupportedExchangePairs(ctx context.Context, params *SupportedExchangePairsParams) (map[string][]ExchangePair, error)

+ func (s *FuturesService) TakerBuySellHistory(ctx context.Context, params *TakerBuySellHistoryParams) ([]TakerBuySellPoint, error)

+ func (s *FuturesService) TopLongShortRatioHistory(ctx context.Context, params *LongShortRatioParams) ([]LongShortPoint, error)

+ func (s *FuturesService) WhaleAlert(ctx context.Context, params *WhaleAlertParams) ([]WhaleAlert, error)

+ type GrayscaleHolding struct

+ Asset string

+ Holdings float64

+ Symbol string

+ ValueUsd float64

+ type IndicatorsService struct

+ func (s *IndicatorsService) BasisHistory(ctx context.Context, params *BasisHistoryParams) ([]BasisPoint, error)

+ func (s *IndicatorsService) BitcoinRainbowChart(ctx context.Context) (*RainbowChart, error)

+ func (s *IndicatorsService) CoinbasePremium(ctx context.Context, params *CoinbasePremiumParams) ([]PremiumPoint, error)

+ func (s *IndicatorsService) FearGreedHistory(ctx context.Context, params *FearGreedParams) ([]FearGreedPoint, error)

+ func (s *IndicatorsService) RSIList(ctx context.Context, params *RSIListParams) ([]RSIItem, error)

+ func (s *IndicatorsService) StablecoinMarketCap(ctx context.Context, params *StablecoinMarketCapParams) ([]StablecoinPoint, error)

+ func (s *IndicatorsService) StockToFlow(ctx context.Context) (*StockToFlow, error)

+ type LargeOrder struct

+ Exchange string

+ Price float64

+ Side string

+ Size float64

+ Symbol string

+ Timestamp int64

+ ValueUsd float64

+ type LargeOrdersParams struct

+ Exchange string

+ Interval string

+ Limit *int

+ Symbol string

+ type LiquidationAggregatedHistoryParams struct

+ EndTime *int64

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type LiquidationCoin struct

+ Exchange string

+ LiquidationUsd float64

+ Symbol string

+ Timestamp int64

+ type LiquidationCoinListParams struct

+ Limit *int

+ Symbol *string

+ type LiquidationHeatmap struct

+ Data []LiquidationHeatmapPoint

+ Model int

+ Raw json.RawMessage

+ type LiquidationHeatmapParams struct

+ Interval string

+ Limit *int

+ Symbol string

+ type LiquidationHeatmapPoint struct

+ LiquidationUsd float64

+ Price float64

+ type LiquidationHistoryParams struct

+ EndTime *int64

+ Interval string

+ Limit *int

+ Pair string

+ StartTime *int64

+ Symbol string

+ type LiquidationMap struct

+ Data json.RawMessage

+ Raw json.RawMessage

+ Symbol string

+ type LiquidationMapParams struct

+ Interval string

+ Limit *int

+ Pair string

+ Symbol string

+ type LiquidationPoint struct

+ BuyAmount float64

+ BuyQty float64

+ SellAmount float64

+ SellQty float64

+ Timestamp int64

+ type LongShortPoint struct

+ LongAccount float64

+ LongRatio float64

+ ShortAccount float64

+ ShortRatio float64

+ Timestamp int64

+ type LongShortRatioParams struct

+ EndTime *int64

+ Exchange *string

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type OIExchangeItem struct

+ Exchange string

+ OpenInterest float64

+ OpenInterestUsd float64

+ Timestamp int64

+ type OIExchangeListParams struct

+ EndTime *int64

+ Exchange *string

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type OIHistoryParams struct

+ EndTime *int64

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type OIHistoryPoint struct

+ OpenInterest float64

+ OpenInterestUsd float64

+ Timestamp int64

+ type Option func(*Client)

+ func WithBaseURL(url string) Option

+ func WithHTTPClient(client *http.Client) Option

+ func WithRetry(maxAttempts int, baseDelay time.Duration) Option

+ func WithTimeout(d time.Duration) Option

+ type OptionHistoryParams struct

+ EndTime *int64

+ Interval string

+ Limit *int

+ StartTime *int64

+ type OptionInfo struct

+ Data json.RawMessage

+ Expiry int64

+ Raw json.RawMessage

+ Underlying string

+ type OptionMaxPain struct

+ Data json.RawMessage

+ Expiry int64

+ MaxPain float64

+ Raw json.RawMessage

+ Underlying string

+ type OptionOIPoint struct

+ Exchange string

+ Timestamp int64

+ TotalOI float64

+ type OptionParams struct

+ Expiry *int64

+ Interval *string

+ Underlying string

+ type OptionVolPoint struct

+ Exchange string

+ Timestamp int64

+ TotalVol float64

+ type OptionsService struct

+ func (s *OptionsService) ExchangeOIHistory(ctx context.Context, params *OptionHistoryParams) ([]OptionOIPoint, error)

+ func (s *OptionsService) ExchangeVolHistory(ctx context.Context, params *OptionHistoryParams) ([]OptionVolPoint, error)

+ func (s *OptionsService) Info(ctx context.Context, params *OptionParams) (*OptionInfo, error)

+ func (s *OptionsService) MaxPain(ctx context.Context, params *OptionParams) (*OptionMaxPain, error)

+ type OrderbookHistoryParams struct

+ EndTime *int64

+ Exchange string

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type OrderbookPoint struct

+ AskAmount float64

+ AskQty float64

+ BidAmount float64

+ BidQty float64

+ Price float64

+ Timestamp int64

+ type PairMarket struct

+ Exchange string

+ OpenInterestUsd float64

+ Pair string

+ Price float64

+ PriceChange24h float64

+ Symbol string

+ VolumeUsd24h float64

+ type PairsMarketsParams struct

+ Exchange *string

+ Limit *int

+ Symbol *string

+ type PremiumPoint struct

+ Premium float64

+ Timestamp int64

+ type PriceChangeItem struct

+ Change1h float64

+ Change24h float64

+ Change7d float64

+ Symbol string

+ type PricePoint struct

+ Close float64

+ High float64

+ Low float64

+ Open float64

+ Timestamp int64

+ Volume float64

+ type RSIItem struct

+ Interval string

+ RSI float64

+ Symbol string

+ Timestamp int64

+ type RSIListParams struct

+ Interval *string

+ Limit *int

+ Symbol *string

+ type RainbowChart struct

+ Data json.RawMessage

+ Raw json.RawMessage

+ type SpotCoinMarket struct

+ Price float64

+ PriceChange24h float64

+ Symbol string

+ VolumeUsd24h float64

+ type SpotCoinsMarketsParams struct

+ Exchange *string

+ Limit *int

+ Symbol *string

+ type SpotOrderbookHistoryParams struct

+ EndTime *int64

+ Exchange string

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type SpotPairMarket struct

+ Exchange string

+ Pair string

+ Price float64

+ PriceChange24h float64

+ Symbol string

+ VolumeUsd24h float64

+ type SpotPairsMarketsParams struct

+ Exchange *string

+ Limit *int

+ Symbol *string

+ type SpotPriceHistoryParams struct

+ EndTime *int64

+ Interval string

+ Limit *int

+ StartTime *int64

+ Symbol string

+ type SpotService struct

+ func (s *SpotService) CoinsMarkets(ctx context.Context, params *SpotCoinsMarketsParams) ([]SpotCoinMarket, error)

+ func (s *SpotService) OrderbookHistory(ctx context.Context, params *SpotOrderbookHistoryParams) ([]OrderbookPoint, error)

+ func (s *SpotService) PairsMarkets(ctx context.Context, params *SpotPairsMarketsParams) ([]SpotPairMarket, error)

+ func (s *SpotService) PriceHistory(ctx context.Context, params *SpotPriceHistoryParams) ([]PricePoint, error)

+ func (s *SpotService) SupportedCoins(ctx context.Context) ([]string, error)

+ func (s *SpotService) TakerBuySellHistory(ctx context.Context, params *SpotTakerBuySellHistoryParams) ([]TakerBuySellPoint, error)

+ type SpotTakerBuySellHistoryParams struct

+ Exchange string

+ Interval string

+ Limit *int

+ Symbol string

+ type StablecoinMarketCapParams struct

+ EndTime *int64

+ Limit *int

+ StartTime *int64

+ type StablecoinPoint struct

+ MarketCap float64

+ Timestamp int64

+ type StockToFlow struct

+ Data json.RawMessage

+ Raw json.RawMessage

+ type SupportedExchangePairsParams struct

+ Exchange *string

+ type TakerBuySellHistoryParams struct

+ Exchange string

+ Interval string

+ Limit *int

+ Symbol string

+ type TakerBuySellPoint struct

+ BuyVolume float64

+ SellVolume float64

+ Timestamp int64

+ type WhaleAlert struct

+ Link string

+ Price float64

+ Side string

+ Size float64

+ Symbol string

+ Time int64

+ type WhaleAlertParams struct

+ Interval *string

+ Limit *int

+ Symbol *string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL