coingecko

package
v0.0.0-...-dc33a9e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 18, 2021 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var CoinsPriceChangePercentageValues = &CoinsPriceChangePercentage{
	PriceChangePercentage1H:   "1h",
	PriceChangePercentage24H:  "24h",
	PriceChangePercentage7D:   "7d",
	PriceChangePercentage14D:  "14d",
	PriceChangePercentage30D:  "30d",
	PriceChangePercentage200D: "200d",
	PriceChangePercentage1Y:   "1y",
}
View Source 
var CoinsQueryOrderValues = &CoinsQueryOrder{
	GeckoAsc:      "gecko_asc",
	GeckoDesc:     "gecko_desc",
	IDAsc:         "id_asc",
	IDDesc:        "id_desc",
	MarketCapAsc:  "market_cap_asc",
	MarketCapDesc: "market_cap_desc",
	VolumeAsc:     "volume_asc",
	VolumeDesc:    "volume_desc",
}

Functions

func CheckResponse 

func CheckResponse(r *http.Response) error

CheckResponse checks the API response for errors, and returns them if present. A response is considered an error if it has a status code outside the 200 range. The caller is responsible to analyze the response body.

Types

type Client 

type Client struct {

	// Base URL for API requests
	BaseURL *url.URL

	// Services used for talking to the Utilities in the CoinGecko API.
	Util *UtilService

	// Services used for talking to the Exchange Rates endpoint in the CoinGecko API.
	ExchangeRate *ExchangeRateService

	// Services used for talking to the Coins endpoint in the CoinGecko API.
	Coins *CoinsService
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(httpClient *http.Client) *Client

func (*Client) Do 

func (c *Client) Do(req *http.Request, v interface{}) (*http.Response, error)

Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occured

func (*Client) NewRequestWithContext 

func (c *Client) NewRequestWithContext(ctx context.Context, method, urlStr string, body interface{}) (*http.Request, error)

NewRequestWithContext creates an API request A relative URL can be provided in urlStr, in which case it is resolved relative to the baseURL of the Client. If specified, the value pointed to by body is JSON encoded and included as the request body.

type CodeAdditionsDeletion 

type CodeAdditionsDeletion struct {
	Additions int32 `json:"additions"`
	Deletions int32 `json:"deletions"`
}

type Coin 

type Coin struct {
	ID                           string              `json:"id"`
	Symbol                       string              `json:"symbol"`
	Name                         string              `json:"name"`
	AssetPlatformID              string              `json:"asset_platform_id"`
	Platforms                    map[string]string   `json:"platforms"`
	BlockTimeInMinutes           int32               `json:"block_time_in_minutes"`
	HashingAlgorithm             string              `json:"hashing_algorithm"`
	Categories                   []string            `json:"categories"`
	PublicNotice                 string              `json:"public_notice"`
	AdditonalNotices             []string            `json:"additional_notices"`
	Localization                 Localization        `json:"localization"`
	Description                  Description         `json:"description"`
	Links                        *Links              `json:"links"`
	Image                        *Image              `json:"image"`
	CountryOrigin                string              `json:"country_origin"`
	GenesisDate                  string              `json:"genesis_date"`
	ContractAddress              string              `json:"contract_address"`
	SentimentVotesUpPercentage   float32             `json:"sentiment_votes_up_percentage"`
	SentimentVotesDownPercentage float32             `json:"sentimate_votes_down_percentage"`
	MarketCapRank                uint16              `json:"market_cap_rank"`
	CoinGeckoRank                uint16              `json:"coingecko_rank"`
	CoinGeckoScore               float32             `json:"coingecko_score"`
	DeveloperScore               float32             `json:"developer_score"`
	CommunityScore               float32             `json:"community_score"`
	LiquidityScore               float32             `json:"liquidity_score"`
	PublicInterestScore          float32             `json:"public_interest_score"`
	MarketData                   *MarketData         `json:"market_data"`
	CommunityData                *CommunityData      `json:"community_data"`
	DeveloperData                *DeveloperData      `json:"developer_data"`
	PublicInterestStats          *PublicInterestStat `json:"public_interest_stats"`
	StatusUpdates                *[]StatusUpdate     `json:"status_updates"`
	LastUpdated                  string              `json:"last_updated"`
	Tickers                      *[]Ticker           `json:"tickers"`
}

type CoinsMarket 

type CoinsMarket struct {
	ID                                  string   `json:"id"`
	Symbol                              string   `json:"symbol"`
	Name                                string   `json:"name"`
	CoinImage                           string   `json:"image"`
	CurrentPrice                        float64  `json:"current_price"`
	MarketCap                           float64  `json:"market_cap"`
	MarketCapRank                       uint16   `json:"market_cap_rank"`
	FullyDilutedValuation               float64  `json:"fully_diluted_valuation"`
	TotalVolume                         float64  `json:"total_volume"`
	High24H                             float64  `json:"high_24h"`
	Low24H                              float64  `json:"low_24h"`
	PriceChange24H                      float64  `json:"price_change_24h"`
	PriceChangePercentage24H            float64  `json:"price_change_percentage_24h"`
	MarketCapChange24H                  float64  `json:"market_cap_change_24h"`
	MarketCapChangePercentage24H        float64  `json:"market_cap_change_percentage_24h"`
	CirculatingSupply                   float64  `json:"circulating_supply"`
	TotalSupply                         float64  `json:"total_supply"`
	MaxSupply                           float64  `json:"max_supply"`
	ATH                                 float64  `json:"ath"`
	ATHChangePercentage                 float64  `json:"ath_change_percentage"`
	ATHDate                             string   `json:"ath_date"`
	ATL                                 float64  `json:"atl"`
	ATLChangePercentage                 float64  `json:"atl_change_percentage"`
	ATLDate                             string   `json:"atl_date"`
	ROI                                 *ROI     `json:"roi,omitempty"`
	LastUpdated                         string   `json:"last_updated"`
	PriceChangePercentage1HInCurrency   *float64 `json:"price_change_percentage_1h_in_currency,omitempty"`
	PriceChangePercentage24HInCurrency  *float64 `json:"price_change_percentage_24h_in_currency,omitempty"`
	PriceChangePercentage7DInCurrency   *float64 `json:"price_change_percentage_7d_in_currency,omitempty"`
	PriceChangePercentage14DInCurrency  *float64 `json:"price_change_percentage_14d_in_currency,omitempty"`
	PriceChangePercentage24DInCurrency  *float64 `json:"price_change_percentage_24d_in_currency,omitempty"`
	PriceChangePercentage30DInCurrency  *float64 `json:"price_change_percentage_30d_in_currency,omitempty"`
	PriceChangePercentage200dInCurrency *float64 `json:"price_change_percentage_200d_in_currency,omitempty"`
	PriceChangePercentage1yInCurrency   *float64 `json:"price_change_percentage_1y_in_currency,omitempty"`
}

CoinsMarketStruct is the coins market result

type CoinsMarketData 

type CoinsMarketData []CoinsMarket

CoinsMarket represents the coins market in CoinGecko

type CoinsPriceChangePercentage 

type CoinsPriceChangePercentage struct {
	PriceChangePercentage1H   string
	PriceChangePercentage24H  string
	PriceChangePercentage7D   string
	PriceChangePercentage14D  string
	PriceChangePercentage30D  string
	PriceChangePercentage200D string
	PriceChangePercentage1Y   string
}

type CoinsQueryOptions 

type CoinsQueryOptions struct {
	Category              string   `url:"category,omitempty"`
	CoinIDs               []string `url:"ids,omitempty"`
	Localization          string   `url:"localization,omitempty"`
	Tickers               bool     `url:"tickers,omitempty"`
	MarketData            bool     `url:"market_data,omitempty"`
	CommunityData         bool     `url:"community_data,omitempty"`
	DeveloperData         bool     `url:"developer_data,omitempty"`
	Sparkline             bool     `url:"sparkline,omitempty"`
	Order                 string   `url:"order,omitempty"`
	PerPage               uint16   `url:"per_page,omitempty"`
	Page                  uint16   `url:"page,omitempty"`
	PriceChangePercentage string   `url:"price_change_percentage,omitempty"`
}

type CoinsQueryOrder 

type CoinsQueryOrder struct {
	GeckoAsc      string
	GeckoDesc     string
	IDAsc         string
	IDDesc        string
	MarketCapAsc  string
	MarketCapDesc string
	VolumeAsc     string
	VolumeDesc    string
}

type CoinsService 

type CoinsService struct {
	// contains filtered or unexported fields
}

CoinsService handles Coin endpoints for CoinGecko API

func (*CoinsService) GetCoin 

func (s *CoinsService) GetCoin(ID string, options *CoinsQueryOptions) (*Coin, *http.Response, error)

GetCoin wraps GetCoinWithContext using the background context

func (*CoinsService) GetCoinWithContext 

func (s *CoinsService) GetCoinWithContext(ctx context.Context, coinID string, options *CoinsQueryOptions) (*Coin, *http.Response, error)

Get current data (name, price, market, … including exchange tickers) for a coin. https://api.coingecko.com/api/v3/coins/{id}

func (*CoinsService) GetMarkets 

func (s *CoinsService) GetMarkets(currency string, options *CoinsQueryOptions) (*CoinsMarketData, *http.Response, error)

GetExchangeRates wraps GetMarketsWithContext using the background context

func (*CoinsService) GetMarketsWithContext 

func (s *CoinsService) GetMarketsWithContext(ctx context.Context, vsCurrency string, options *CoinsQueryOptions) (*CoinsMarketData, *http.Response, error)

GetMarkets gets List all supported coins price, market cap, volume, and market related data https://api.coingecko.com/api/v3/coins/markets

type CommunityData 

type CommunityData struct {
	FacebookLikes            *uint    `json:"facebook_likes"`
	TwitterFollowers         *uint    `json:"twitter_followers"`
	RedditAveragePosts48H    *float64 `json:"reddit_average_posts_48h"`
	RedditAverageComments48H *float64 `json:"reddit_average_comments_48h"`
	RedditSubscribers        *uint    `json:"reddit_subscribers"`
	RedditAccountsActive48H  *uint    `json:"reddit_accounts_active_48h"`
	TelegramChannelUserCount *uint    `json:"telegram_channel_user_count"`
}

type CurrencyPrice 

type CurrencyPrice map[string]float64

type Description 

type Description map[string]string

type DeveloperData 

type DeveloperData struct {
	Forks                          *uint                 `json:"forks"`
	Stars                          *uint                 `json:"stars"`
	Subscribers                    *uint                 `json:"subscribers"`
	TotalIssues                    *uint                 `json:"total_issues"`
	ClosedIssues                   *uint                 `json:"closed_issues"`
	PullRequestsMerged             *uint                 `json:"pull_requests_merged"`
	PullRequestContributors        *uint                 `json:"pull_request_contributors"`
	CodeAdditionsDeletions4Weeks   CodeAdditionsDeletion `json:"code_additions_deletions_4_weeks"`
	CommitsCount4Weeks             *uint                 `json:"commit_count_4_weeks"`
	Last4WeeksCommitActivitySeries []int                 `json:"last_4_weeks_commit_activity_series"`
}

type ExchangeRateService 

type ExchangeRateService struct {
	// contains filtered or unexported fields
}

ExchangeRateService handles Exchange Rates for CoinGecko API

func (*ExchangeRateService) GetExchangeRates 

func (s *ExchangeRateService) GetExchangeRates() (*ExchangeRates, *http.Response, error)

GetExchangeRates wraps GetExchangeRatesWithContext using the background context

func (*ExchangeRateService) GetExchangeRatesWithContext 

func (s *ExchangeRateService) GetExchangeRatesWithContext(ctx context.Context) (*ExchangeRates, *http.Response, error)

GetExchangeRatesWithContext gets the BTC-to-Currency exchange rates in CoinGecko https://api.coingecko.com/api/v3/exchange_rates

type ExchangeRates 

type ExchangeRates struct {
	Rates Rates
}

ExchangeRates represents the exchange rates in CoinGecko

type Image 

type Image struct {
	Thumb string `json:"thumb"`
	Small string `json:"small"`
	Large string `json:"large"`
}
type Links struct {
	HomePage                   []string  `json:"homepage"`
	BlockChainSite             []string  `json:"blockchain_site"`
	OfficialForumURL           []string  `json:"official_forum_url"`
	ChatURL                    []string  `json:"chat_url"`
	AnnouncementURL            []string  `json:"announcement_url"`
	TwitterScreenName          string    `json:"twitter_screen_name"`
	FacebookUsername           string    `json:"facebook_username"`
	BitcointalkThreadIdentifer int       `json:"bitcointalk_thread_identifier"`
	SubredditURL               string    `json:"subreddit_url"`
	TelegramChannelIdentifier  string    `json:"telegram_channel_identifier"`
	ReposURL                   *ReposURL `json:"repos_url"`
}

type Localization 

type Localization map[string]string

type MarketData 

type MarketData struct {
	CurrentPrice                           CurrencyPrice     `json:"current_price"`
	ROI                                    *ROI              `json:"roi"`
	ATH                                    CurrencyPrice     `json:"ath"`
	ATHChangePercentage                    CurrencyPrice     `json:"ath_change_percentage"`
	ATHDate                                map[string]string `json:"ath_date"`
	ATL                                    CurrencyPrice     `json:"atl"`
	ATLChangePercentage                    CurrencyPrice     `json:"atl_change_percentage"`
	ATLDate                                map[string]string `json:"atl_date"`
	MarketCap                              CurrencyPrice     `json:"market_cap"`
	MarketCapRank                          int16             `json:"market_cap_rank"`
	FullyDilutedValuation                  CurrencyPrice     `json:"fully_diluted_valuation"`
	TotalVolume                            CurrencyPrice     `json:"total_volume"`
	High24H                                CurrencyPrice     `json:"high_24h"`
	Low24H                                 CurrencyPrice     `json:"low_24h"`
	PriceChange24H                         float64           `json:"price_change_24h"`
	PriceChangePercentage24H               float64           `json:"price_change_percentage_24h"`
	PriceChangePercentage7D                float64           `json:"price_change_percentage_7d"`
	PriceChangePercentage14D               float64           `json:"price_change_percentage_14d"`
	PriceChangePercentage30D               float64           `json:"price_change_percentage_30d"`
	PriceChangePercentage60D               float64           `json:"price_change_percentage_60d"`
	PriceChangePercentage200D              float64           `json:"price_change_percentage_200d"`
	PriceChangePercentage1Y                float64           `json:"price_change_percentage_1y"`
	MarketCapChange24H                     float64           `json:"market_cap_change_24h"`
	MarketCapChangePercentage24H           float64           `json:"market_cap_change_percentage_24h"`
	PriceChange24HInCurrency               CurrencyPrice     `json:"price_change_24h_in_currency"`
	PriceChangePercentage1HInCurrency      CurrencyPrice     `json:"price_change_percentage_1h_in_currency"`
	PriceChangePercentage24HInCurrency     CurrencyPrice     `json:"price_change_percentage_24h_in_currency"`
	PriceChangePercentage7DInCurrency      CurrencyPrice     `json:"price_change_percentage_7d_in_currency"`
	PriceChangePercentage14DInCurrency     CurrencyPrice     `json:"price_change_percentage_14d_in_currency"`
	PriceChangePercentage30DInCurrency     CurrencyPrice     `json:"price_change_percentage_30d_in_currency"`
	PriceChangePercentage60DInCurrency     CurrencyPrice     `json:"price_change_percentage_60d_in_currency"`
	PriceChangePercentage200DInCurrency    CurrencyPrice     `json:"price_change_percentage_200d_in_currency"`
	PriceChangePercentage1YInCurrency      CurrencyPrice     `json:"price_change_percentage_1y_in_currency"`
	MarketCapChange24HInCurrency           CurrencyPrice     `json:"market_cap_change_24h_in_currency"`
	MarketCapChangePercentage24HInCurrency CurrencyPrice     `json:"market_cap_change_percentage_24h_in_currency"`
	TotalSupply                            *float64          `json:"total_supply"`
	CirculatingSupply                      float64           `json:"circulating_supply"`
	Sparkline                              *Sparkline        `json:"sparkline_7d"`
	LastUpdated                            string            `json:"last_updated"`
}

type Ping 

type Ping struct {
	GeckoSays string `json:"gecko_says"`
}

Ping represents a ping in CoinGecko

type PublicInterestStat 

type PublicInterestStat struct {
	AlexaRank   uint `json:"alexa_rank"`
	BingMatches uint `json:"bing_matches"`
}

type ROI 

type ROI struct {
	Times      float64 `json:"times"`
	Currency   string  `json:"currency"`
	Percentage float64 `json:"percentage"`
}

ROI is the roi result

type Rates 

type Rates map[string]RatesStruct

Rates is the rates result

type RatesStruct 

type RatesStruct struct {
	Name  string  `json:"name"`
	Unit  string  `json:"unit"`
	Value float64 `json:"value"`
	Type  string  `json:"type"`
}

RatesStruct are the rate struct in Rates

type ReposURL 

type ReposURL struct {
	Github    []string `json:"github"`
	Bitbucket []string `json:"bitbucket"`
}

type Sparkline 

type Sparkline struct {
	Price []float64 `json:"price"`
}

type StatusUpdate 

type StatusUpdate struct {
	Description string `json:"description"`
	Category    string `json:"category"`
	CreatedAt   string `json:"created_at"`
	User        string `json:"user"`
	UserTitle   string `json:"user_title"`
	Pin         bool   `json:"pin"`
	Project     struct {
		Type   string `json:"type"`
		ID     string `json:"id"`
		Name   string `json:"name"`
		Symbol string `json:"ada"`
		Image  Image  `json:"image"`
	} `json:"project"`
}

type Ticker 

type Ticker struct {
	Base   string `json:"base"`
	Target string `json:"target"`
	Market struct {
		Name                string `json:"name"`
		Identifier          string `json:"identifier"`
		HasTradingIncentive bool   `json:"has_trading_incentive"`
	} `json:"market"`
	Last                   float64            `json:"last"`
	Volume                 float64            `json:"volume"`
	ConvertedLast          map[string]float64 `json:"converted_last"`
	ConvertedVolume        map[string]float64 `json:"converted_volume"`
	TrustScore             string             `json:"trust_score"`
	BidAskSpreadPercentage float64            `json:"bid_ask_spread_percentage"`
	Timestamp              string             `json:"timestamp"`
	LastTradedAt           string             `json:"last_traded_at"`
	LastFetchAt            string             `json:"last_fetch_at"`
	IsAnomaly              bool               `json:"is_anomaly"`
	IsStale                bool               `json:"is_stale"`
	TradeURL               string             `json:"trade_url"`
	CoinID                 string             `json:"coin_id"`
	TargetCoinID           string             `json:"target_coin_id"`
}

type UtilService 

type UtilService struct {
	// contains filtered or unexported fields
}

UtilService handles utility for CoinGecko API

func (*UtilService) Ping 

func (s *UtilService) Ping() (*Ping, *http.Response, error)

Ping wraps PingWithContext using the background context.

func (*UtilService) PingWithContext 

func (s *UtilService) PingWithContext(ctx context.Context) (*Ping, *http.Response, error)

Check CoinGecko API server status https://api.coingecko.com/api/v3/ping

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.