Skip to content

sngyai/go-bybit

BranchesTags

Repository files navigation

Go Report Card golangci-lint test

bybit

bybit is an bybit client for the Go programming language.

Usage

REST API

import (
    "github.com/sngyai/go-bybit"
    "github.com/sngyai/go-bybit/rest"
)

b := rest.NewClient().WithAuth("", "").WithTestnet()

symbol := bybit.SymbolV5BTCUSDT
res, err := b.V5().Market().GetInstrumentsInfo(rest.V5GetInstrumentsInfoParam{
    Category: "spot",
})
if err != nil {
	log.Println(err)
}
log.Printf("InstrumentsInfo: %#v\n", res.Result.Spot.List)

WebSocket API v5

create new websocket

import (
    "github.com/sngyai/go-bybit"
    "github.com/sngyai/go-bybit/ws"
    "github.com/sngyai/go-bybit/ws/wsv5"
)

prx, _ := url.Parse(proxyURL) // some not-exist-proxy

netDialer, _ := proxy.SOCKS5("tcp", prx.Host, nil, &net.Dialer{})
dialer := websocket.Dialer{NetDial: netDialer.Dial}

client := proxyClient("socks5://127.0.0.1:1086")
wsClient := ws.NewWebsocketClient().WithBaseURL(ws.TestWebsocketBaseURL).WithAuth("APIKey", "APISecret").WithDialer(&client)

for single use

svc, err := wsv5.NewWSClient(wsClient).Public(bybit.CategoryV5Spot)
if err != nil {
    fmt.Println(err)
    return err
}
_, err = svc.SubscribeTickers(wsv5.PublicTickersParamKey{
        Symbol: bybit.SymbolV5BTCUSDT,
    },
    func(response wsv5.PublicTickersResponse) error {
        fmt.Printf("v5 recv tickers: %v\n", response)
        return nil
    })
if err != nil {
    fmt.Println(err)
    return err
}

errHandler := func(isWebsocketClosed bool, err error) {
    fmt.Printf("handle ws failed, isWebsocketClosed: %b, err: %v", isWebsocketClosed, err)
}
svc.Start(context.Background(), errHandler)

for multiple use

var executors []ws.WebsocketExecutor
svcRoot := wsv5.NewWSClient(wsClient)
{
    svc, err := svcRoot.Public(bybit.CategoryV5Spot)
    if err != nil {
		return err
    }
    _, err = svc.SubscribeTickers(
		wsv5.PublicTickersParamKey{
			Symbol: bybit.SymbolV5BTCUSDT,
        }, 
		func(response wsv5.PublicTickersResponse) error {
			fmt.Printf("v5 recv ticker: %v\n", response)
			return nil
        })
	if err != nil {
		return err
    }
    executors = append(executors, svc)
}
{
    svc, err := svcRoot.Public(bybit.CategoryV5Spot)
    if err != nil {
        return err
    }
    _, err = svc.SubscribeOrderBook(wsv5.PublicOrderBookParamKey{
		Depth:  50, 
		Symbol: bybit.SymbolV5BTCUSDT,
    }, 
	func(response wsv5.PublicOrderBookResponse) error {
		fmt.Printf("v5 recv orderbook: %v\n", response)
		return nil
    })
    if err != nil {
        return err
    }
    executors = append(executors, svc)
}
wsClient.Start(context.Background(), executors)

Implemented

The following API endpoints have been implemented

REST API V5

Market

Position

Order

Account

User

REST API

Derivatives Unified Margin

Market Data Endpoints
  • /derivatives/v3/public/order-book/L2 Get Order Book
  • /derivatives/v3/public/kline Get Kline
  • /derivatives/v3/public/tickers Get Latest Information For Symbol
  • /derivatives/v3/public/instruments-info Get Instrument Info
  • /derivatives/v3/public/mark-price-kline Get Mark Price Kline
  • /derivatives/v3/public/index-price-kline Get Index Price Kline

Derivatives Contract

Market Data Endpoints
  • /derivatives/v3/public/order-book/L2 Get Order Book
  • /derivatives/v3/public/kline Get Kline
  • /derivatives/v3/public/tickers Get Latest Information For Symbol
  • /derivatives/v3/public/instruments-info Get Instrument Info
  • /derivatives/v3/public/mark-price-kline Get Mark Price Kline
  • /derivatives/v3/public/index-price-kline Get Index Price Kline

Inverse Perpetual

Market Data Endpoints
  • /v2/public/orderBook/L2 Order Book
  • /v2/public/kline/list Query Kline
  • /v2/public/tickers Latest Information for Symbol
  • /v2/public/trading-records Public Trading Records
  • /v2/public/symbols Query Symbol
  • /v2/public/mark-price-kline Query Mark Price Kline
  • /v2/public/index-price-kline Query Index Price Kline
  • /v2/public/premium-index-kline Query Premium Index Kline
  • /v2/public/open-interest Open Interest
  • /v2/public/big-deal Latest Big Deal
  • /v2/public/account-ratio Long-Short Ratio
Account Data Endpoints
  • /v2/private/order/create Place Active Order
  • /v2/private/order/list Get Active Order
  • /v2/private/order/cancel Cancel Active Order
  • /v2/private/order/cancelAll Cancel All Active Orders
  • /v2/private/order Query Active Order (real-time)
  • /v2/private/stop-order/create Place Conditional Order
  • /v2/private/stop-order/list Get Conditional Order
  • /v2/private/stop-order/cancel Cancel Conditional Order
  • /v2/private/stop-order/cancelAll Cancel All Conditional Orders
  • /v2/private/stop-order Query Conditional Order (real-time)
  • /v2/private/position/list My Position
  • /v2/private/position/trading-stop Set Trading-Stop
  • /v2/private/position/leverage/save Set Leverage
  • /v2/private/account/api-key API Key info
Wallet Data Endpoints
  • /v2/private/wallet/balance Get Wallet Balance

USDT Perpetual

Market Data Endpoints
  • /v2/public/orderBook/L2 Order Book
  • /public/linear/kline Query Kline
  • /v2/public/tickers Latest Information for Symbol
  • /v2/public/symbols Query Symbol
  • /v2/public/open-interest Open Interest
  • /v2/public/big-deal Latest Big Deal
  • /v2/public/account-ratio Long-Short Ratio
Account Data Endpoints
  • /private/linear/order/create Place Active Order
  • /private/linear/order/list Get Active Order
  • /private/linear/order/cancel Cancel Active Order
  • /private/linear/order/cancel-all Cancel All Active Orders
  • /private/linear/order/replace Replace Active Order
  • /private/linear/order/search Query Active Order (real-time)
  • /private/linear/stop-order/create Place Conditional Order
  • /private/linear/stop-order/list Get Conditional Order
  • /private/linear/stop-order/cancel Cancel Conditional Order
  • /private/linear/stop-order/cancel-all Cancel All Conditional Orders
  • /private/linear/stop-order/search Query Conditional Order (real-time)
  • /private/linear/position/list My Position
  • /private/linear/position/set-leverage Set Leverage
  • /private/linear/position/trading-stop Set Trading-Stop
  • /private/linear/trade/execution/list User Trade Records
  • /v2/private/account/api-key API Key info
Wallet Data Endpoints
  • /v2/private/wallet/balance Get Wallet Balance

Inverse Future

Market Data Endpoints
  • /v2/public/orderBook/L2 Order Book
  • /v2/public/kline/list Query Kline
  • /v2/public/tickers Latest Information for Symbol
  • /v2/public/trading-records Public Trading Records
  • /v2/public/symbols Query Symbol
  • /v2/public/mark-price-kline Query Index Price Kline
  • /v2/public/index-price-kline Query Index Price Kline
  • /v2/public/open-interest Open Interest
  • /v2/public/big-deal Latest Big Deal
  • /v2/public/account-ratio Long-Short Ratio
Account Data Endpoints
  • /futures/private/order/create Place Active Order
  • /futures/private/order/list Get Active Order
  • /futures/private/order/cancel Cancel Active Order
  • /futures/private/order/cancelAll Cancel All Active Orders
  • /futures/private/order Query Active Order (real-time)
  • /futures/private/stop-order/create Place Conditional Order
  • /futures/private/stop-order/list Get Conditional Order
  • /futures/private/stop-order/cancel Cancel Conditional Order
  • /futures/private/stop-order/cancelAll Cancel All Conditional Orders
  • /futures/private/stop-order Query Conditional Order (real-time)
  • /futures/private/position/list My Position
  • /futures/private/position/trading-stop Set Trading-Stop
  • /futures/private/position/leverage/save Set Leverage
  • /v2/private/account/api-key API Key info
Wallet Data Endpoints
  • /v2/private/wallet/balance Get Wallet Balance

Spot v1

Market Data Endpoints
  • /spot/v1/symbols Query Symbol
  • /spot/quote/v1/depth Order Book
  • /spot/quote/v1/depth/merged Merged Order Book
  • /spot/quote/v1/trades Public Trading Records
  • /spot/quote/v1/kline Query Kline
  • /spot/quote/v1/ticker/24hr Latest Information for Symbol
  • /spot/quote/v1/ticker/price Last Traded Price
  • /spot/quote/v1/ticker/book_ticker Best Bid/Ask Price
Account Data Endpoints
  • /spot/v1/order
    • Place Active Order
    • Get Active Order
    • Cancel Active Order
    • Fast Cancel Active Order
  • /spot/v1/order/fast Fast Cancel Active Order
  • /spot/order/batch-cancel Batch Cancel Active Order
  • /spot/order/batch-fast-cancel Batch Fast Cancel Active Order
  • /spot/order/batch-cancel-by-ids Batch Cancel Active Order By IDs
  • /spot/v1/open-orders Open Orders
Wallet Data Endpoints
  • /spot/v1/account Get Wallet Balance

WebSocket API

Private v5

Private Topics
  • Position

Spot v1

Public Topics
  • trade
Public Topics V2
  • trade
Private Topics
  • outboundAccountInfo

Integration Tests

There are tests so that we can get to know the changes of bybit api response.

See below

Contributing

I would like to cover Bybit API and contributions are always welcome. The calling pattern is established, so adding new methods is relatively straightforward. See some PRs like https://github.com/sngyai/bybit/pull/44.

To submit issues, PRs, and every other help is welcome.

About

A Go SDK for Bybit API

Topics

bybit bybit-api bybit-websocket

Resources

Readme

License

MIT license
Activity

Stars

2 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 2

v0.0.2 Latest
Mar 28, 2024
+ 1 release

Packages

 
 
 

Contributors

Languages