ec0ed1c1e5
* Add basic docs for gRPC/gctcli/unified API and a few markdown fixes * Update patherinos and spacing fixes * Consistent namerinos * Fix spelling mistakes * Add fancy headers * Uperaterinos * Fix feedback nitterinos
3.3 KiB
GoCryptoTrader Unified API
A cryptocurrency trading bot supporting multiple exchanges written in Golang.
Please note that this bot is under development and is not ready for production!
Community
Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack
Unified API
GoCryptoTrader supports a unified API for dealing with exchanges. Each exchange has its own wrapper file which maps the exchanges own RESTful endpoints into a standardised way for bot and standalone application usage.
A full breakdown of all the supported wrapper funcs can be found here. Please note that these change on a regular basis as GoCryptoTrader is undergoing rapid development.
Each exchange supports public API endpoints which don't require any authentication
(fetching ticker, orderbook, trade data) and also private API endpoints (which
require authentication). Some examples include submitting, cancelling and fetching
open orders). To use the authenticated API endpoints, you'll need to set your API
credentials in either the config.json file or when you initialise an exchange in
your application, and also have the appropriate key permissions set for the exchange.
Each exchange has a credentials validator which ensures that the API credentials
supplied meet the requirements to make an authenticated request.
Public API Ticker Example
var b bitstamp.Bitstamp
b.SetDefaults()
ticker, err := b.FetchTicker(currency.NewPair(currency.BTC, currency.USD), asset.Spot)
if err != nil {
// Handle error
}
fmt.Println(ticker.Last)
Private API Submit Order Example
var b bitstamp.Bitstamp
b.SetDefaults()
b.API.Credentials.Key = "your_key"
b.API.Credentials.Secret = "your_secret"
b.API.Credentials.ClientID = "your_clientid"
order := &exchange.OrderSubmission{
Pair: currency.NewPair(currency.BTC, currency.USD),
OrderSide: exchange.SellOrderSide,
OrderType: exchange.LimitOrderType,
Price: 1000000,
Amount: 0.1,
}
resp, err := b.SubmitOrder(order)
if err != nil {
// Handle error
}
fmt.Println(resp.OrderID)