Documentation
¶
Index ¶
- func WithEntitiesEntityType(entityType string) entitiesListOption
- func WithEntitiesPage(page int) entitiesListOption
- func WithEntitiesPerPage(perPage int) entitiesListOption
- func WithHoldingAmountChange(holdingAmountChange string) entityOption
- func WithHoldingChangePercentage(holdingChangePercentage string) entityOption
- func WithHoldingChartDays(days string) holdingChartOption
- func WithHoldingChartIncludeEmptyIntervals(includeEmptyIntervals bool) holdingChartOption
- func WithPublicTreasuryOrder(order string) publicTreasuryCoinIdOption
- func WithPublicTreasuryPage(page int) publicTreasuryCoinIdOption
- func WithPublicTreasuryPerPage(perPage int) publicTreasuryCoinIdOption
- func WithTransactionHistoryCoinIDs(coinIDs string) transactionHistoryOption
- func WithTransactionHistoryOrder(order string) transactionHistoryOption
- func WithTransactionHistoryPage(page int) transactionHistoryOption
- func WithTransactionHistoryPerPage(perPage int) transactionHistoryOption
- type PublicTreasuryClient
- func (c *PublicTreasuryClient) EntitiesList(ctx context.Context, options ...entitiesListOption) ([]types.Entity, error)
- func (c *PublicTreasuryClient) PublicTreasuryCoinId(ctx context.Context, id string, options ...publicTreasuryCoinIdOption) (*types.Treasury, error)
- func (c *PublicTreasuryClient) PublicTreasuryCoinIdByEntity(ctx context.Context, entity, coinID string, ...) (*types.Treasury, error)
- func (c *PublicTreasuryClient) PublicTreasuryEntity(ctx context.Context, entityID string, options ...entityOption) (*types.EntityTreasury, error)
- func (c *PublicTreasuryClient) PublicTreasuryHoldingChart(ctx context.Context, entityID, coinID string, options ...holdingChartOption) (*types.HoldingChart, error)
- func (c *PublicTreasuryClient) PublicTreasuryTransactionHistory(ctx context.Context, entityID string, options ...transactionHistoryOption) (*types.TransactionHistory, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithEntitiesEntityType ¶
func WithEntitiesEntityType(entityType string) entitiesListOption
WithEntitiesEntityType returns an entitiesListOption that filters entities by type. Supported values are "company" and "government".
func WithEntitiesPage ¶
func WithEntitiesPage(page int) entitiesListOption
WithEntitiesPage returns an entitiesListOption that sets the page of entities to return.
func WithEntitiesPerPage ¶
func WithEntitiesPerPage(perPage int) entitiesListOption
WithEntitiesPerPage returns an entitiesListOption that sets the number of entities returned per page.
func WithHoldingAmountChange ¶
func WithHoldingAmountChange(holdingAmountChange string) entityOption
WithHoldingAmountChange returns an entityOption that includes holding amount changes for the specified comma-separated timeframes.
func WithHoldingChangePercentage ¶
func WithHoldingChangePercentage(holdingChangePercentage string) entityOption
WithHoldingChangePercentage returns an entityOption that includes holding change percentages for the specified comma-separated timeframes.
func WithHoldingChartDays ¶
func WithHoldingChartDays(days string) holdingChartOption
WithHoldingChartDays returns a holdingChartOption that sets the number of days of historical data to include.
func WithHoldingChartIncludeEmptyIntervals ¶
func WithHoldingChartIncludeEmptyIntervals(includeEmptyIntervals bool) holdingChartOption
WithHoldingChartIncludeEmptyIntervals returns a holdingChartOption that sets whether empty intervals with no transaction data are included.
func WithPublicTreasuryOrder ¶
func WithPublicTreasuryOrder(order string) publicTreasuryCoinIdOption
WithPublicTreasuryOrder returns a publicTreasuryCoinIdOption that sets the sort order for treasury holdings. Supported values are "total_holdings_usd_desc" and "total_holdings_usd_asc".
func WithPublicTreasuryPage ¶
func WithPublicTreasuryPage(page int) publicTreasuryCoinIdOption
WithPublicTreasuryPage returns a publicTreasuryCoinIdOption that sets the page of treasury holdings to return.
func WithPublicTreasuryPerPage ¶
func WithPublicTreasuryPerPage(perPage int) publicTreasuryCoinIdOption
WithPublicTreasuryPerPage returns a publicTreasuryCoinIdOption that sets the number of treasury holdings returned per page.
func WithTransactionHistoryCoinIDs ¶
func WithTransactionHistoryCoinIDs(coinIDs string) transactionHistoryOption
WithTransactionHistoryCoinIDs returns a transactionHistoryOption that filters transactions by comma-separated coin IDs.
func WithTransactionHistoryOrder ¶
func WithTransactionHistoryOrder(order string) transactionHistoryOption
WithTransactionHistoryOrder returns a transactionHistoryOption that sets the sort order for transactions.
func WithTransactionHistoryPage ¶
func WithTransactionHistoryPage(page int) transactionHistoryOption
WithTransactionHistoryPage returns a transactionHistoryOption that sets the page of transactions to return.
func WithTransactionHistoryPerPage ¶
func WithTransactionHistoryPerPage(perPage int) transactionHistoryOption
WithTransactionHistoryPerPage returns a transactionHistoryOption that sets the number of transactions returned per page.
Types ¶
type PublicTreasuryClient ¶
func NewClient ¶
func NewClient(c geckohttp.HttpClient, url string) *PublicTreasuryClient
func (*PublicTreasuryClient) EntitiesList ¶
func (c *PublicTreasuryClient) EntitiesList(ctx context.Context, options ...entitiesListOption) ([]types.Entity, error)
EntitiesList allows you to query all supported public treasury entities with entity ID, name, symbol, and country.
func (*PublicTreasuryClient) PublicTreasuryCoinId ¶
func (c *PublicTreasuryClient) PublicTreasuryCoinId(ctx context.Context, id string, options ...publicTreasuryCoinIdOption) (*types.Treasury, error)
PublicTreasuryCoinId allows you to query public companies' cryptocurrency holdings by coin ID.
func (*PublicTreasuryClient) PublicTreasuryCoinIdByEntity ¶
func (c *PublicTreasuryClient) PublicTreasuryCoinIdByEntity(ctx context.Context, entity, coinID string, options ...publicTreasuryCoinIdOption) (*types.Treasury, error)
PublicTreasuryCoinIdByEntity allows you to query public companies' or governments' cryptocurrency holdings by coin ID. Supported entity values are "companies" and "governments".
func (*PublicTreasuryClient) PublicTreasuryEntity ¶
func (c *PublicTreasuryClient) PublicTreasuryEntity(ctx context.Context, entityID string, options ...entityOption) (*types.EntityTreasury, error)
PublicTreasuryEntity allows you to query public companies' or governments' cryptocurrency holdings by entity ID.
func (*PublicTreasuryClient) PublicTreasuryHoldingChart ¶
func (c *PublicTreasuryClient) PublicTreasuryHoldingChart(ctx context.Context, entityID, coinID string, options ...holdingChartOption) (*types.HoldingChart, error)
PublicTreasuryHoldingChart allows you to query historical cryptocurrency holdings chart data by entity ID and coin ID.
func (*PublicTreasuryClient) PublicTreasuryTransactionHistory ¶
func (c *PublicTreasuryClient) PublicTreasuryTransactionHistory(ctx context.Context, entityID string, options ...transactionHistoryOption) (*types.TransactionHistory, error)
PublicTreasuryTransactionHistory allows you to query public companies' or governments' cryptocurrency transaction history by entity ID.
Source Files
Directories