Skip to content

Commit 731e263

Browse files
committed
chore: update readme
1 parent 0f9854d commit 731e263

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed

README.md

+26-11
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
### go-binance
22

3-
A Golang SDK for [binance](https://www.binance.com) API.
3+
A Golang SDK for [binance](https://accounts.binance.com/register?ref=PGDFCE46) API.
44

5+
[![Telegram Chat](https://patrolavia.github.io/telegram-badge/chat.png)](https://t.me/gobinancegroup)
56
[![Build Status](https://travis-ci.org/adshao/go-binance.svg?branch=master)](https://travis-ci.org/adshao/go-binance)
67
[![GoDoc](https://godoc.org/github.com/adshao/go-binance?status.svg)](https://godoc.org/github.com/adshao/go-binance)
78
[![Go Report Card](https://goreportcard.com/badge/github.com/adshao/go-binance)](https://goreportcard.com/report/github.com/adshao/go-binance)
@@ -13,6 +14,12 @@ For best compatibility, please use Go >= 1.8.
1314

1415
Make sure you have read binance API document before continuing.
1516

17+
18+
## Community
19+
Join our growing community on Telegram to get help, or just chat!
20+
21+
[![Telegram Chat](https://patrolavia.github.io/telegram-badge/chat.png)](https://t.me/gobinancegroup)
22+
1623
### API List
1724

1825
Name | Description | Status
@@ -23,9 +30,9 @@ Name | Description | Status
2330
[margin-api.md](https://binance-docs.github.io/apidocs/spot/en) | Details on the Margin API (/sapi) | <input type="checkbox" checked> Implemented
2431
[futures-api.md](https://binance-docs.github.io/apidocs/futures/en/#general-info) | Details on the Futures API (/fapi) | <input type="checkbox" checked> Implemented
2532
[delivery-api.md](https://binance-docs.github.io/apidocs/delivery/en/#general-info) | Details on the Coin-M Futures API (/dapi) | <input type="checkbox" checked> Implemented
26-
[options-api.md](https://binance-docs.github.io/apidocs/voptions/en/#general-info) | Details on the Options API(/eapi) | <input type="checkbox" checked> Implemented
33+
[options-api.md](https://binance-docs.github.io/apidocs/voptions/en/#general-info) | Details on the Options API(/eapi) | <input type="checkbox" checked> Implemented
34+
2735

28-
2936
If you find an unimplemented interface, please submit an issue. It's great if you can open a PR to fix it.
3037

3138
### Installation
@@ -46,7 +53,7 @@ go get github.com/adshao/go-binance/v1
4653
import (
4754
// for spot and other interfaces contained in https://binance-docs.github.io/apidocs/spot/en/#change-log
4855
"github.com/adshao/go-binance/v2"
49-
56+
5057
"github.com/adshao/go-binance/v2/futures" // optional package
5158
"github.com/adshao/go-binance/v2/delivery" // optional package
5259
"github.com/adshao/go-binance/v2/options" // optional package
@@ -82,12 +89,12 @@ Following are some simple examples, please refer to [godoc](https://godoc.org/gi
8289
If you have any questions, please refer to the specific version of the code for specific reference definitions or usage methods
8390

8491
##### Proxy Client
85-
92+
8693
```
8794
proxyUrl := "http://127.0.0.1:7890" // Please replace it with your exact proxy URL.
8895
client := binance.NewProxiedClient(apiKey, apiSecret, proxyUrl)
8996
```
90-
97+
9198

9299
#### Create Order
93100

@@ -243,7 +250,7 @@ If you want to use a proxy, you can set `HTTPS_PROXY` or `HTTP_PROXY` in the env
243250
binance.SetWsProxyUrl("http://127.0.0.1:7890")
244251
binance.WsDepthServe("LTCBTC", wsDepthHandler, errHandler)
245252
```
246-
253+
247254
#### Depth
248255

249256
```golang
@@ -432,13 +439,13 @@ func main() {
432439

433440
func listenOrderPlaceResponse(ctx context.Context, wg *sync.WaitGroup, orderPlaceService *futures.OrderPlaceWsService) {
434441
defer wg.Done()
435-
442+
436443
go func() {
437444
for msg := range orderPlaceService.GetReadChannel() {
438445
log.Println("order place response", string(msg))
439446
}
440447
}()
441-
448+
442449
go func() {
443450
for err := range orderPlaceService.GetReadErrorChannel() {
444451
log.Println("order place error", err)
@@ -455,7 +462,7 @@ func listenOrderPlaceResponse(ctx context.Context, wg *sync.WaitGroup, orderPlac
455462
```go
456463
func main() {
457464
orderPlaceService, _ := futures.NewOrderPlaceWsService(apiKey, secretKey)
458-
465+
459466
id := "some-id"
460467
request := futures.NewOrderPlaceWsRequest()
461468
request.
@@ -470,11 +477,19 @@ func main() {
470477
if err != nil {
471478
log.Fatal(err)
472479
}
473-
480+
474481
// handle response
475482
}
476483
```
477484

485+
## Check out some of the other packages
486+
487+
- Check out [CCXT](https://github.com/ccxt/ccxt) for more than 100 crypto exchanges with a unified trading API.
488+
- Check out [Python-Binance](https://github.com/sammchardy/python-binance) for a complete Python Wrapper.
489+
- Check out [Node-Binance-API] (https://github.com/carlosmiei/node-binance-api) for a node.js sdk.
490+
- Check out [Binance-Trade-Bot] (https://github.com/ccxt/binance-trade-bot) for a binance bot in python
491+
492+
478493

479494

480495

0 commit comments

Comments
 (0)