mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-06-05 23:16:53 +00:00
Updated documentation tool (#155)
* Updated documentation tool Added templates Updated documentation using tool * Fixed incorrect version in web README * Added new templates to tool. Updated documents in templates across the code base. Used tool to regenerate documentation.
This commit is contained in:
committed by
Adrian Gallagher
parent
aaf9f52a70
commit
3b8591bcc8
@@ -21,6 +21,37 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
|
||||
## Current Features for orderbook
|
||||
|
||||
+ This package facilitates orderbook generation.
|
||||
+ Attaches methods to an orderbook
|
||||
- To Return total Bids
|
||||
- To Return total Asks
|
||||
- Update orderbooks
|
||||
+ Gets a loaded orderbook 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
|
||||
ob, err := yobitExchange.GetOrderbookEx()
|
||||
if err != nil {
|
||||
// Handle error
|
||||
}
|
||||
|
||||
// Find total asks which also returns total orderbook value
|
||||
totalAsks, totalOrderbookVal := ob.CalculateTotalAsks()
|
||||
```
|
||||
|
||||
+ or if you have a routine setting an exchange orderbook you can access it via
|
||||
the package itself.
|
||||
|
||||
```go
|
||||
ob, err := orderbook.GetOrderbook(...)
|
||||
if err != nil {
|
||||
// Handle error
|
||||
}
|
||||
```
|
||||
|
||||
### Please click GoDocs chevron above to view current GoDoc information for this package
|
||||
|
||||
|
||||
Reference in New Issue
Block a user