179 lines
5.9 KiB
Markdown
179 lines
5.9 KiB
Markdown
# bybit-go-api
|
|
[](https://github.com/wuhewuhe/bybit-go-api) [](https://github.com/wuhewuhe/bybit-go-api) [](https://github.com/wuhewuhe/bybit-go-api/blob/main/LICENSE)
|
|
## Table of Contents
|
|
- [About](#about)
|
|
- [Development](#development)
|
|
- [Installation](#installation)
|
|
- [Usage](#usage)
|
|
- [Contact](#contact)
|
|
- [Contributors](#contributors)
|
|
- [Donations](#donations)
|
|
## About
|
|
The Official Go Lang API connector for Bybit's HTTP and WebSocket APIs.
|
|
|
|
Dive into a plethora of functionalities:
|
|
- Market Data Retrieval
|
|
- Trade Execution
|
|
- Position Management
|
|
- Account and Asset Info Retrieval
|
|
- User and Upgrade Management
|
|
- Public Websocket Streaming
|
|
- Private Websocket Streaming
|
|
- Lending Institution and Client
|
|
- Broker Earning Data
|
|
|
|
bybit-go-api provides an official, robust, and high-performance go connector to Bybit's trading APIs.
|
|
|
|
Initially conceptualized by esteemed go developer Victor, this module is now maintained by Bybit's in-house go experts.
|
|
|
|
Your contributions are most welcome!
|
|
|
|
## Development
|
|
bybit-go-api is under active development with the latest features and updates from Bybit's API implemented promptly. The module utilizes minimal external libraries to provide a lightweight and efficient experience. If you've made enhancements or fixed bugs, please submit a pull request.
|
|
|
|
## Installation
|
|
Ensure you have go 1.21.0 or higher. And use dependencies as below
|
|
```go
|
|
require (
|
|
github.com/google/uuid v1.4.0
|
|
github.com/gorilla/websocket v1.5.1
|
|
github.com/stretchr/testify v1.8.4
|
|
)
|
|
```
|
|
|
|
## Usage
|
|
Note: Replace placeholders (like YOUR_API_KEY, links, or other details) with the actual information. You can also customize this template to better fit the actual state and details of your Java API.
|
|
### Rest API
|
|
- Place an order by Map
|
|
```go
|
|
client := bybit.NewBybitHttpClient("YOUR_API_KEY", "YOUR_API_SECRET", bybit.WithBaseURL(bybit.TESTNET))
|
|
params := map[string]interface{}{"category": "linear", "symbol": "BTCUSDT", "side": "Buy", "positionIdx": 0, "orderType": "Limit", "qty": "0.001", "price": "10000", "timeInForce": "GTC"}
|
|
orderResult, err := client.NewTradeService(params).PlaceOrder(context.Background())
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
return
|
|
}
|
|
fmt.Println(bybit.PrettyPrint(orderResult))
|
|
```
|
|
|
|
- Place an order by Trade Class
|
|
```go
|
|
client := bybit.NewBybitHttpClient("YOUR_API_KEY", "YOUR_API_SECRET", bybit.WithBaseURL(bybit.TESTNET))
|
|
orderResult, err := client.NewPlaceOrderService("linear", "XRPUSDT", "Buy", "Market", "10").Do(context.Background())
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
return
|
|
}
|
|
fmt.Println(bybit.PrettyPrint(orderResult))
|
|
```
|
|
|
|
- Place batch order
|
|
```go
|
|
client := bybit.NewBybitHttpClient("YOUR_API_KEY", "YOUR_API_SECRET", bybit.WithBaseURL(bybit.TESTNET))
|
|
params := map[string]interface{}{"category": "option",
|
|
"request": []map[string]interface{}{
|
|
{
|
|
"category": "option",
|
|
"symbol": "BTC-10FEB23-24000-C",
|
|
"orderType": "Limit",
|
|
"side": "Buy",
|
|
"qty": "0.1",
|
|
"price": "5",
|
|
"orderIv": "0.1",
|
|
"timeInForce": "GTC",
|
|
"orderLinkId": "9b381bb1-401",
|
|
"mmp": false,
|
|
"reduceOnly": false,
|
|
},
|
|
{
|
|
"category": "option",
|
|
"symbol": "BTC-10FEB23-24000-C",
|
|
"orderType": "Limit",
|
|
"side": "Buy",
|
|
"qty": "0.1",
|
|
"price": "5",
|
|
"orderIv": "0.1",
|
|
"timeInForce": "GTC",
|
|
"orderLinkId": "82ee86dd-001",
|
|
"mmp": false,
|
|
"reduceOnly": false,
|
|
},
|
|
},
|
|
}
|
|
orderResult, err := client.NewTradeService(params).PlaceBatchOrder(context.Background())
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
return
|
|
}
|
|
fmt.Println(bybit.PrettyPrint(orderResult))
|
|
```
|
|
|
|
- Get Position
|
|
```go
|
|
client := bybit.NewBybitHttpClient("YOUR_API_KEY", "YOUR_API_SECRET", bybit.WithBaseURL(bybit.TESTNET))
|
|
params := map[string]interface{}{"category": "linear", "settleCoin": "USDT", "limit": 10}
|
|
orderResult, err := client.NewPositionService(params).GetPositionList(context.Background())
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
return
|
|
}
|
|
fmt.Println(bybit.PrettyPrint(orderResult))
|
|
```
|
|
|
|
- Get Transaction Log
|
|
```go
|
|
client := bybit.NewBybitHttpClient("YOUR_API_KEY", "YOUR_API_SECRET", bybit.WithBaseURL(bybit.TESTNET))
|
|
params := map[string]interface{}{"accountType": "UNIFIED", "category": "linear"}
|
|
accountResult, err := client.NewAccountService(params).GetTransactionLog(context.Background())
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
return
|
|
}
|
|
fmt.Println(bybit.PrettyPrint(accountResult))
|
|
```
|
|
|
|
### Websocket public channel
|
|
- Order book Subscribe
|
|
```go
|
|
ws := bybit.NewBybitPublicWebSocket("wss://stream.bybit.com/v5/public/spot", func(message string) error {
|
|
fmt.Println("Received:", message)
|
|
return nil
|
|
})
|
|
_ = ws.Connect([]string{"orderbook.1.BTCUSDT"})
|
|
select {}
|
|
```
|
|
|
|
### Websocket private channel
|
|
```go
|
|
ws := bybit.NewBybitPrivateWebSocket("wss://stream-testnet.bybit.com/v5/private", "YOUR_API_KEY", "YOUR_API_SECRET", func(message string) error {
|
|
fmt.Println("Received:", message)
|
|
return nil
|
|
})
|
|
_ = ws.Connect([]string{"order"})
|
|
select {}
|
|
```
|
|
|
|
## Contact
|
|
For support, join our Bybit API community on [Telegram](https://t.me/Bybitapi).
|
|
|
|
## Contributors
|
|
List of other contributors
|
|
<table>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/wuhewuhe">
|
|
<img src="https://avatars.githubusercontent.com/u/32245754?v=4" width="100px;" alt=""/>
|
|
<br />
|
|
<sub>
|
|
<b>Victor</b>
|
|
</sub>
|
|
</a>
|
|
<br />
|
|
<a href="https://github.com/wuhewuhe/bybit-java-api/commits?author=wuhewuhe" title="Code">💻</a>
|
|
<a href="https://github.com/wuhewuhe/bybit-java-api/commits?author=wuhewuhe" title="Documentation">📖</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## Donations
|
|
Your donations keep our development active and our community growing. Donate USDT to our [ERC20 Wallet Address](0x238bbb45af1254e2fd76564c9b56042c452f3d6e). |