Documentation
¶
Index ¶
- func WithNftsMarketsAssetPlatformID(assetPlatformID string) marketsOption
- func WithNftsMarketsOrder(order string) marketsOption
- func WithNftsMarketsPage(page int64) marketsOption
- func WithNftsMarketsPerPage(perPage int64) marketsOption
- func WithOrder(order string) listOption
- func WithPage(page int64) listOption
- func WithPerPage(perPage int64) listOption
- type NftsClient
- func (c *NftsClient) NftsContract(ctx context.Context, assetPlatform, contract string) (*types.NftId, error)
- func (c *NftsClient) NftsContractMarketChart(ctx context.Context, assetPlatform, contract, days string) (*types.NftMarketChart, error)
- func (c *NftsClient) NftsId(ctx context.Context, id string) (*types.NftId, error)
- func (c *NftsClient) NftsIdMarketChart(ctx context.Context, id, days string) (*types.NftMarketChart, error)
- func (c *NftsClient) NftsIdTickers(ctx context.Context, id string) (*types.NftTickers, error)
- func (c *NftsClient) NftsList(ctx context.Context, options ...listOption) ([]types.Nft, error)
- func (c *NftsClient) NftsMarkets(ctx context.Context, options ...marketsOption) ([]types.NftMarket, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithNftsMarketsAssetPlatformID ¶ added in v3.2.0
func WithNftsMarketsAssetPlatformID(assetPlatformID string) marketsOption
WithNftsMarketsAssetPlatformID filters results by asset platform.
func WithNftsMarketsOrder ¶ added in v3.2.0
func WithNftsMarketsOrder(order string) marketsOption
WithNftsMarketsOrder specifies the ordering of results. Valid values: h24_volume_native_asc, h24_volume_native_desc, h24_volume_usd_asc, h24_volume_usd_desc, market_cap_usd_asc, market_cap_usd_desc.
func WithNftsMarketsPage ¶ added in v3.2.0
func WithNftsMarketsPage(page int64) marketsOption
WithNftsMarketsPage specifies which page of results to return.
func WithNftsMarketsPerPage ¶ added in v3.2.0
func WithNftsMarketsPerPage(perPage int64) marketsOption
WithNftsMarketsPerPage specifies the number of results per page. Valid values: 1..250.
func WithOrder ¶
func WithOrder(order string) listOption
WithOrder specifies the ordering of results. Valid values: h24_volume_native_asc, h24_volume_native_desc, floor_price_native_asc, floor_price_native_desc, market_cap_native_asc, market_cap_native_desc, market_cap_usd_asc, market_cap_usd_desc, etc.
func WithPage ¶
func WithPage(page int64) listOption
WithPage specifies which page of results to return.
func WithPerPage ¶
func WithPerPage(perPage int64) listOption
WithPerPage specifies the number of results per page. Valid values: 1..250
Types ¶
type NftsClient ¶
func NewClient ¶
func NewClient(c geckohttp.HttpClient, url string) *NftsClient
func (*NftsClient) NftsContract ¶
func (c *NftsClient) NftsContract(ctx context.Context, assetPlatform, contract string) (*types.NftId, error)
NftsContract allows you to query all the NFT data (name, floor price, 24 hr volume....) based on the nft collection contract address and respective asset platform.
👍 Tips
You may also obtain the asset platform id and contract address through /nfts/list endpoint
📘 Notes
Solana NFT & Art Blocks are not supported for this endpoint, please use /nfts/{id} endpoint instead
Cache / Update Frequency: every 60 seconds for all the API plans
func (*NftsClient) NftsContractMarketChart ¶ added in v3.2.0
func (c *NftsClient) NftsContractMarketChart(ctx context.Context, assetPlatform, contract, days string) (*types.NftMarketChart, error)
NftsContractMarketChart allows you to query historical market data of an NFT collection by contract address.
This is a Pro API endpoint.
func (*NftsClient) NftsId ¶
NftsId allows you to query all the NFT data (name, floor price, 24 hr volume....) based on the nft collection id.
📘 Notes
Cache / Update Frequency: every 60 seconds for all the API plans
func (*NftsClient) NftsIdMarketChart ¶ added in v3.2.0
func (c *NftsClient) NftsIdMarketChart(ctx context.Context, id, days string) (*types.NftMarketChart, error)
NftsIdMarketChart allows you to query historical market data of an NFT collection by number of days from now.
This is a Pro API endpoint.
func (*NftsClient) NftsIdTickers ¶ added in v3.2.0
func (c *NftsClient) NftsIdTickers(ctx context.Context, id string) (*types.NftTickers, error)
NftsIdTickers allows you to query floor price and 24h volume for an NFT collection across NFT marketplaces.
This is a Pro API endpoint.
func (*NftsClient) NftsList ¶
NftsList allows you to query all supported NFTs with id, contract address, name, asset platform id and symbol on CoinGecko.
👍 Tips
You may use this endpoint to query the list of nfts for other endpoints that contain params like id (nft collection’s id) as well as asset_platform_id and contract_address
You may include values such as per_page and page to specify how many results you would like to show in the responses per page and which page of responses you would like to show
📘 Notes
The responses are paginated to 100 items
Cache / Update Frequency: every 5 minutes for all the API plans
func (*NftsClient) NftsMarkets ¶ added in v3.2.0
func (c *NftsClient) NftsMarkets(ctx context.Context, options ...marketsOption) ([]types.NftMarket, error)
NftsMarkets allows you to query supported NFT collections with floor price, market cap, volume and market data.
This is a Pro API endpoint.
Source Files
Directories