README
¶
GoCryptoTrader package Ticker
This ticker package is part of the GoCryptoTrader codebase.
This is still in active development
You can track ideas, planned features and what's in progress on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.
Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack
Current Features for ticker
-
This services the exchanges package by ticker functions.
-
This package facilitates ticker generation.
-
Attaches methods to an ticker
- Returns a string of a value
-
Gets a loaded ticker by exchange, asset type and currency pair.
-
This package is primarily used in conjunction with but not limited to the exchange interface system set by exchange wrapper orderbook functions in "exchange"_wrapper.go.
Examples below:
tick, err := yobitExchange.FetchTicker()
if err != nil {
// Handle error
}
// Converts ticker value to string
tickerValString := tick.PriceToString(...)
- or if you have a routine setting an exchange orderbook you can access it via the package itself.
tick, err := ticker.GetTicker(...)
if err != nil {
// Handle error
}
Please click GoDocs chevron above to view current GoDoc information for this package
Contribution
Please feel free to submit any pull requests or suggest any desired features to be added.
When submitting a PR, please abide by our coding guidelines:
- Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
- Code must be documented adhering to the official Go commentary guidelines.
- Code must adhere to our coding style.
- Pull requests need to be based on and opened against the
masterbranch.
Donations
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc
Documentation
¶
Index ¶
- Variables
- func FindLast(p currency.Pair, a asset.Item) (float64, error)
- func ProcessTicker(p *Price) error
- func SubscribeTicker(exchange string, p currency.Pair, a asset.Item) (dispatch.Pipe, error)
- func SubscribeToExchangeTickers(exchange string) (dispatch.Pipe, error)
- type Price
- type Service
- type Ticker
Constants ¶
This section is empty.
Variables ¶
var ( // ErrNoTickerFound is when a ticker is not found ErrNoTickerFound = errors.New("no ticker found") // ErrBidEqualsAsk error for locked markets ErrBidEqualsAsk = errors.New("bid equals ask this is a crossed or locked market") // ErrExchangeNameIsEmpty is an error for when an exchange name is empty ErrExchangeNameIsEmpty = errors.New("exchange name is empty") )
Functions ¶
func ProcessTicker ¶
ProcessTicker processes incoming tickers, creating or updating the Tickers list
func SubscribeTicker ¶
SubscribeTicker subscribes to a ticker and returns a communication channel to stream new ticker updates
Types ¶
type Price ¶
type Price struct {
Last float64 `json:"Last"`
High float64 `json:"High"`
Low float64 `json:"Low"`
Bid float64 `json:"Bid"`
Ask float64 `json:"Ask"`
Volume float64 `json:"Volume"`
QuoteVolume float64 `json:"QuoteVolume"`
PriceATH float64 `json:"PriceATH"`
Open float64 `json:"Open"`
Close float64 `json:"Close"`
OpenInterest float64 `json:"OpenInterest"`
MarkPrice float64 `json:"MarkPrice"`
IndexPrice float64 `json:"IndexPrice"`
Pair currency.Pair `json:"Pair"`
ExchangeName string `json:"exchangeName"`
AssetType asset.Item `json:"assetType"`
LastUpdated time.Time
// Funding rate field variables
FlashReturnRate float64
BidPeriod float64
BidSize float64
AskPeriod float64
AskSize float64
FlashReturnRateAmount float64
}
Price struct stores the currency pair and pricing information
func GetExchangeTickers ¶
GetExchangeTickers returns all tickers for a given exchange
Source Files