Basic documentation update for engine branch (#369)

* 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
2026-05-20 23:16:49 +00:00 · 2019-10-21 13:09:56 +11:00
parent 92147cdc5f
commit ec0ed1c1e5
9 changed files with 313 additions and 47 deletions
--- a/docs/EXCHANGE_API.md
+++ b/docs/EXCHANGE_API.md
@@ -0,0 +1,72 @@
+# GoCryptoTrader Unified API
+
+<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
+
+[![Build Status](https://travis-ci.com/thrasher-corp/gocryptotrader.svg?branch=master)](https://travis-ci.com/thrasher-corp/gocryptotrader)
+[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
+[![GoDoc](https://godoc.org/github.com/thrasher-corp/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-corp/gocryptotrader)
+[![Coverage Status](http://codecov.io/github/thrasher-corp/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master)
+[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-corp/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
+
+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](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk)
+
+## 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.](https://github.com/thrasher-corp/gocryptotrader/blob/engine/exchanges/interfaces.go#L16)
+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
+
+```go
+    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
+
+```go
+    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)
+```