Files
gocryptotrader/cmd/documentation/exchanges_templates/exchanges_ticker_readme.tmpl
Adrian Gallagher f5914e8c10 Engine changes
2019-05-22 17:06:38 +10:00

43 lines
1019 B
Cheetah

{{define "exchanges ticker" -}}
{{template "header" .}}
## Current Features for {{.Name}}
+ 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:
```go
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.
```go
tick, err := ticker.GetTicker(...)
if err != nil {
// Handle error
}
```
### Please click GoDocs chevron above to view current GoDoc information for this package
{{template "contributions"}}
{{template "donations"}}
{{end}}