Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rtunazzz authored Jan 20, 2023
1 parent 72c8a48 commit de8a09b
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
<p align="center"><img width=100% src="https://user-images.githubusercontent.com/38296319/200170420-0644f467-49ff-4ecd-8811-1bc939f84fea.png"></p>

This library provides a wrapper around [Binance's futures leaderboard](https://www.binance.com/en/futures-activity/leaderboard) API. (*keep in mind this is not a publicly documented API*)

You're able to subscribe to positions opened by leading futures traders (that are sharing their positions publicly via Binance) and query their leaderboard data.
This library provides a convenient way to access Binance's futures leaderboard API, which allows you to subscribe to positions opened by leading futures traders (that are sharing their positions publicly via Binance) and query other leaderboard data. Keep in mind that this is not a publicly documented API.

## Installation
```bash
Expand All @@ -28,8 +26,8 @@ import (
)

func main() {
// You can find this UID (encryptedUid) in the end of a leaderboard profile URL. For example:
// https://www.binance.com/en/futures-activity/leaderboard/user?encryptedUid=47E6D002EBB1173967A6561F72B9395C
// You can find this UID (encryptedUid) in the end of a leaderboard profile URL.
// For example: https://www.binance.com/en/futures-activity/leaderboard/user?encryptedUid=47E6D002EBB1173967A6561F72B9395C
u := bfldb.NewUser("47E6D002EBB1173967A6561F72B9395C")
cp, ce := u.SubscribePositions(context.Background())

Expand Down

0 comments on commit de8a09b

Please sign in to comment.