Categorygithub.com/oneart-dev/bybit
modulepackage
0.0.29
Repository: https://github.com/oneart-dev/bybit.git
Documentation: pkg.go.dev

# README

golangci-lint test

bybit

bybit is an bybit client for the Go programing language.

Usage

REST API

import "github.com/oneart-dev/bybit"

client := bybit.NewClient().WithAuth("your api key", "your api secret")
res, err := client.Future().InversePerpetual().Balance(bybit.CoinBTC)
// do as you want

WebSocket API

for single use

import "github.com/oneart-dev/bybit"

wsClient := bybit.NewWebsocketClient()
svc, err := wsClient.Spot().V1().PublicV1()
if err != nil {
	return err
}
_, err = svc.SubscribeTrade(bybit.SymbolSpotBTCUSDT, func(response bybit.SpotWebsocketV1PublicV1TradeResponse) error {
	// do as you want
})
if err != nil {
	return err
}
svc.Start(context.Background())

for multiple use

import "github.com/oneart-dev/bybit"

wsClient := bybit.NewWebsocketClient()

executors := []bybit.WebsocketExecutor{}

svcRoot := wsClient.Spot().V1()
{
	svc, err := svcRoot.PublicV1()
	if err != nil {
		return err
	}
	_, err = svc.SubscribeTrade(bybit.SymbolSpotBTCUSDT, func(response bybit.SpotWebsocketV1PublicV1TradeResponse) error {
		// do as you want
	})
	if err != nil {
		return err
	}
	executors = append(executors, svc)
}
{
	svc, err := svcRoot.PublicV2()
	if err != nil {
		return err
	}
	_, err = svc.SubscribeTrade(bybit.SymbolSpotBTCUSDT, func(response bybit.SpotWebsocketV1PublicV2TradeResponse) error {
		// do as you want
	})
	if err != nil {
		return err
	}
	executors = append(executors, svc)
}

wsClient.Start(context.Background(), executors)

Implemented

The following API endpoints have been implemented

REST API

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/position/list My Position
  • /v2/private/position/leverage/save Set Leverage
Wallet Data Endpoints
  • /v2/private/wallet/balance Get Wallet Balance

USDT Perpetual

Market Data Endpoints
  • /v2/public/orderBook/L2 Order Book
  • /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/cancel Cancel Active Order
  • /private/linear/order/cancel-all Cancel All Active Orders
  • /private/linear/position/list My Position
  • /private/linear/position/set-leverage Set Leverage
  • /private/linear/trade/execution/list User Trade Records
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
Wallet Data Endpoints
  • /v2/private/wallet/balance Get Wallet Balance

Spot

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

WebSocket API

Spot v1

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

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

IsErrWebsocketClosed :.
MinimumVolumeUSDT :.
NewClient :.
NewTestClient :.
NewTestWebsocketClient :.
NewWebsocketClient :.

# Constants

No description provided by the author
No description provided by the author
CategoryV5Inverse :.
CategoryV5Linear :.
CategoryV5Option :.
CategoryV5Spot :.
CoinBTC :.
CoinEOS :.
CoinETH :.
CoinUSDT :.
CoinXRP :.
ContractType :.
ContractType :.
ContractType :.
DirectionNext :.
DirectionPrev :.
ExecTypeAdlTrade :.
ExecTypeBustTrade :.
ExecTypeFunding :.
ExecTypeTrade :.
Innovation :.
Innovation :.
spot.
InstrumentStatus :.
InstrumentStatus :.
InstrumentStatus :.
InstrumentStatus :.
linear & inverse:.
InstrumentStatus :.
InstrumentStatus :.
option.
Interval1 :.
Interval120 :.
Interval15 :.
Interval240 :.
Interval3 :.
Interval30 :.
Interval360 :.
Interval5 :.
Interval60 :.
Interval720 :.
IntervalD :.
IntervalM :.
IntervalW :.
IsLeverageFalse : false then spot trading.
IsLeverageTrue : true then margin trading.
MainNetBaseURL :.
MainNetBaseURL2 :.
OptionsType :.
OptionsType :.
OrderFilterOrder :.
OrderFilterStopOrder :.
OrderFilterTpSlOrder :.
OrderStatusCancelled :.
OrderStatusCreated :.
OrderStatusFilled :.
OrderStatusNew :.
OrderStatusPartiallyFilled :.
OrderStatusPendingCancel :.
OrderStatusRejected :.
OrderStatusSpotCanceled :.
OrderStatusSpotFilled :.
OrderStatusSpotNew :.
OrderStatusSpotPartiallyFilled :.
OrderStatusSpotPendingCancel :.
OrderStatusSpotPendingNew :.
OrderStatusSpotRejected :.
OrderTypeLimit :.
OrderTypeMarket :.
OrderTypeSpotLimit :.
OrderTypeSpotLimitMaker :.
OrderTypeSpotMarket :.
Period15min :.
Period1d :.
Period1h :.
Period30min :.
Period4h :.
Period5min :.
PositionIdx :.
PositionIdx :.
PositionIdx :.
SideBuy :.
SideNone : not defined officially.
SideSell :.
SpotInterval12h :.
SpotInterval15m :.
SpotInterval1d :.
SpotInterval1h :.
SpotInterval1m :.
SpotInterval1M :.
SpotInterval1w :.
SpotInterval2h :.
SpotInterval30m :.
SpotInterval3m :.
SpotInterval4h :.
SpotInterval5m :.
SpotInterval6h :.
SpotWebsocketV1PrivateEventTypeOutboundAccountInfo :.
SpotWebsocketV1PrivatePath :.
SpotWebsocketV1PublicV1EventSubscribe :.
SpotWebsocketV1PublicV1EventUnsubscribe :.
SpotWebsocketV1PublicV1Path :.
SpotWebsocketV1PublicV1TopicTrade :.
SpotWebsocketV1PublicV2EventSubscribe :.
SpotWebsocketV1PublicV2EventUnsubscribe :.
SpotWebsocketV1PublicV2Path :.
SpotWebsocketV1PublicV2TopicTrade :.
SymbolInverseBTCUSD :.
SymbolInverseEOSUSD :.
SymbolInverseETHUSD :.
SymbolInverseXRPUSD :.
SymbolSpotAXSUSDT :.
SymbolSpotBITUSDT :.
SymbolSpotBTCETH :.
SymbolSpotBTCUSDT :.
SymbolSpotDOGEUSDT :.
SymbolSpotDOGEXRP :.
SymbolSpotDYDXUSDT :.
SymbolSpotEOSUSDT :.
SymbolSpotETHUSDT :.
SymbolSpotGENEUSDT :.
SymbolSpotLTCUSDT :.
SymbolSpotMANAUSDT :.
SymbolSpotPMTEST5BTC :.
SymbolSpotUNIUSDT :.
SymbolSpotXLMUSDT :.
SymbolSpotXRPBTC :.
SymbolSpotXRPUSDT :.
SymbolUSDTADA :.
SymbolUSDTBCH :.
SymbolUSDTBTC :.
SymbolUSDTDOT :.
SymbolUSDTETH :.
SymbolUSDTLINK :.
SymbolUSDTLTC :.
SymbolUSDTUNI :.
SymbolUSDTXTZ :.
USDC Perpetual.
Inverse Perpetual.
Inverse Futures.
SymbolV5 :.
USDT Perpetual:.
SymbolV5 :.
SymbolV5 :.
SymbolV5 :.
SymbolV5 :.
Spot.
SymbolV5 :.
TestNetBaseURL :.
TestWebsocketBaseURL :.
TickDirectionMinusTick :.
TickDirectionPlusTick :.
TickDirectionZeroMinusTick :.
TickDirectionZeroPlusTick :.
TimeInForceFillOrKill :.
TimeInForceGoodTillCancel :.
TimeInForceImmediateOrCancel :.
TimeInForcePostOnly :.
TimeInForceSpotFOK :.
TimeInForceSpotGTC :.
TimeInForceSpotIOC :.
TpSlModeFull :.
TpSlModePartial :.
TriggerByIndexPrice :.
TriggerByLastPrice :.
TriggerByMarkPrice :.
TriggerDirectionFall : triggered when market price falls.
TriggerDirectionRise : triggered when market price rises.
WebsocketBaseURL :.

# Variables

ErrAccessDenied : Access denied.
ErrPathNotFound : Request path not found.

# Structs

AccountAssetService :.
AccountRatioParam :.
AccountRatioResponse :.
AccountRatioResult :.
No description provided by the author
APIKeyResponse :.
Balance :.
BalanceResponse :.
BalanceResult :.
BigDealParam :.
BigDealResponse :.
BigDealResult :.
CancelLinearOrder :.
CancelLinearOrderParam :.
CancelLinearOrderResponse :.
CancelLinearOrderResult :.
CancelOrder : so far, same as CreateOrder.
CancelOrderParam :.
CancelOrderResponse :.
CancelOrderResult :.
Client :.
CommonResponse :.
CommonV3Response :.
CommonV5Response :.
Balance :.
BalanceResponse :.
BalanceResult :.
ContractExecutionHistoryListParam :.
ContractExecutionHistoryListResponse :.
ContractExecutionHistoryListResult :.
No description provided by the author
LeverageFilter :.
No description provided by the author
No description provided by the author
ListKlineResult :.
LotSizeFilter :.
PriceFilter :.
SymbolsResult :.
No description provided by the author
SymbolsResponse :.
No description provided by the author
TickersResponse :.
TickersResult :.
CopyTradingService :.
CreateLinearOrder :.
CreateLinearOrderParam :.
CreateLinearOrderResponse :.
CreateLinearOrderResult :.
CreateOrder :.
CreateOrderParam :.
CreateOrderResponse :.
CreateOrderResult :.
DerivativeService :.
ErrorResponse :.
FutureCommonService :.
FutureContractService :.
FutureInverseFutureService :.
FutureInversePerpetualService :.
FutureService :.
FutureUSDTPerpetualService :.
IndexPriceKlineParam :.
IndexPriceKlineResponse :.
IndexPriceKlineResult :.
LeverageFilter :.
LinearCancelAllParam : Parameters to be supplied to cancel all endpoint.
LinearCancelAllResponse : Response from cancel all endpoint.
LinearExecutionHistoryListParam :.
LinearExecutionHistoryListResponse :.
LinearExecutionHistoryListResult :.
LinearExecutionList :.
LinearExecutionListParam :.
LinearExecutionListResponse :.
LinearExecutionListResult :.
ListKlineParam :.
ListKlineResponse :.
ListKlineResult :.
ListLinearPositionResponse :.
ListLinearPositionResult :.
ListLinearPositionsResponse :.
ListLinearPositionsResult :.
ListOrder :.
ListOrderParam :.
ListOrderResponse :.
ListOrderResult :.
ListPositionResponse :.
ListPositionResult :.
ListPositionsResponse :.
ListPositionsResult :.
LotSizeFilter :.
MarkPriceKlineParam :.
MarkPriceKlineResponse :.
MarkPriceKlineResult :.
OpenInterestParam :.
OpenInterestResponse :.
OpenInterestResult :.
OrderBookResponse :.
OrderBookResult :.
PremiumIndexKlineParam :.
PremiumIndexKlineResponse :.
PremiumIndexKlineResult :.
PriceFilter :.
RateLimitError :.
No description provided by the author
SaveLeverageParam :.
SaveLeverageResponse :.
SaveLinearLeverageParam :.
SaveLinearLeverageResponse :.
No description provided by the author
No description provided by the author
No description provided by the author
SpotDeleteOrderParam :.
SpotDeleteOrderResponse :.
SpotDeleteOrderResult :.
SpotGetOrderParam :.
SpotGetOrderResponse :.
SpotGetOrderResult :.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SpotPostOrderParam :.
SpotPostOrderResponse :.
SpotPostOrderResult :.
SpotQuoteDepthBidAsk :.
SpotQuoteDepthMergedParam :.
SpotQuoteDepthMergedResponse :.
SpotQuoteDepthMergedResult :.
SpotQuoteDepthParam :.
SpotQuoteDepthResponse :.
SpotQuoteDepthResult :.
SpotQuoteKline :.
SpotQuoteKlineParam :.
SpotQuoteKlineResponse :.
SpotQuoteKlineResult :.
SpotQuoteTicker24hrParam :.
SpotQuoteTicker24hrResponse :.
SpotQuoteTicker24hrResult :.
SpotQuoteTickerBookTickerParam :.
SpotQuoteTickerBookTickerResponse :.
SpotQuoteTickerBookTickerResult :.
SpotQuoteTickerPriceParam :.
SpotQuoteTickerPriceResponse :.
SpotQuoteTickerPriceResult :.
SpotQuoteTradesParam :.
SpotQuoteTradesResponse :.
SpotQuoteTradesResult :.
SpotService :.
SpotSymbolsResponse :.
SpotSymbolsResult :.
SpotV1Service :.
SpotV3Service :.
SpotWebsocketService :.
SpotWebsocketV1PrivateOutboundAccountInfoResponse :.
SpotWebsocketV1PrivateOutboundAccountInfoResponseContent :.
SpotWebsocketV1PrivateOutboundAccountInfoResponseWalletBalanceChange :.
SpotWebsocketV1PrivateParamKey :.
SpotWebsocketV1PrivateService :.
SpotWebsocketV1PublicV1Service :.
SpotWebsocketV1PublicV1TradeContent :.
SpotWebsocketV1PublicV1TradeParam :.
SpotWebsocketV1PublicV1TradeParamChild :.
SpotWebsocketV1PublicV1TradeParamKey :.
SpotWebsocketV1PublicV1TradeResponse :.
SpotWebsocketV1PublicV1TradeResponseParams :.
SpotWebsocketV1PublicV2Service :.
SpotWebsocketV1PublicV2TradeContent :.
SpotWebsocketV1PublicV2TradeParam :.
SpotWebsocketV1PublicV2TradeParamChild :.
SpotWebsocketV1PublicV2TradeParamKey :.
SpotWebsocketV1PublicV2TradeResponse :.
SpotWebsocketV1PublicV2TradeResponseParams :.
SpotWebsocketV1Service :.
SymbolsResponse :.
SymbolsResult :.
TestClient :.
TestWebSocketClient :.
TickersResponse :.
TickersResult :.
TradingRecordsParam :.
TradingRecordsResponse :.
TradingRecordsResult :.
USDCContractOptionService :.
USDCContractPerpetualService :.
USDCContractService :.
V5AccountService :.
V5APIKeyResponse :.
V5ApiKeyResult :.
V5AssetService :.
V5CancelOrderParam :.
V5CancelOrderResponse :.
V5CancelOrderResult :.
V5CreateOrderParam :.
V5CreateOrderResponse :.
V5CreateOrderResult :.
V5ExecutionService :.
No description provided by the author
No description provided by the author
V5GetOpenOrdersResponse :.
V5GetOpenOrdersResult :.
No description provided by the author
V5GetOpenOrdersResponse :.
V5GetOpenOrdersResult :.
No description provided by the author
V5GetIndexPriceKlineItem :.
V5GetIndexPriceKlineParam :.
V5GetIndexPriceKlineResponse :.
V5GetIndexPriceKlineResult :.
V5GetInstrumentsInfoLinearInverseResult :.
V5GetInstrumentsInfoOptionResult :.
V5GetInstrumentsInfoParam : Spot does not support pagination, so limit, cursor are invalid.
V5GetInstrumentsInfoResponse :.
V5GetInstrumentsInfoResult : Responses are filled according to category.
V5GetInstrumentsInfoSpotResult :.
V5GetKlineItem :.
V5GetKlineParam :.
V5GetKlineResponse :.
V5GetKlineResult :.
V5GetMarkPriceKlineItem :.
V5GetMarkPriceKlineParam :.
V5GetMarkPriceKlineResponse :.
V5GetMarkPriceKlineResult :.
No description provided by the author
V5GetOpenOrdersParam :.
V5GetOpenOrdersResponse :.
V5GetOpenOrdersResult :.
No description provided by the author
V5GetOrderbookBidAsk :.
V5GetOrderbookParam :.
V5GetOrderbookResponse :.
V5GetOrderbookResult :.
No description provided by the author
V5GetOpenOrdersResponse :.
V5GetOpenOrdersResult :.
V5GetPositionInfoItem :.
V5GetPositionInfoParam :.
V5GetPositionInfoResponse :.
V5GetPositionInfoResult :.
V5GetPremiumIndexPriceKlineItem :.
V5GetPremiumIndexPriceKlineParam :.
V5GetPremiumIndexPriceKlineResponse :.
V5GetPremiumIndexPriceKlineResult :.
V5GetTickersLinearInverseResult :.
V5GetTickersOptionResult :.
V5GetTickersParam :.
V5GetTickersResponse :.
V5GetTickersResult : Responses are filled according to category.
V5GetTickersSpotResult :.
V5MarketService :.
V5OrderService :.
V5PositionService :.
V5Service :.
V5SetLeverageParam :.
V5SetLeverageResponse :.
V5SpotLeverageTokenService :.
V5SpotMarginTradeService :.
V5UserService :.
V5WalletBalanceCoin :.
V5WalletBalanceList :.
V5WalletBalanceResponse :.
V5WalletBalanceResult :.
WebSocketClient :.

# Interfaces

FutureContractServiceI :.
FutureInverseFutureServiceI :.
FutureInversePerpetualServiceI :.
FutureServiceI :.
FutureUSDTPerpetualServiceI :.
No description provided by the author
SpotServiceI :.
SpotV1ServiceI :.
USDCContractServiceI :.
V5AccountServiceI :.
V5AssetServiceI :.
V5ExecutionServiceI :.
V5MarketServiceI :.
V5OrderServiceI :.
V5PositionServiceI :.
V5ServiceI :.
V5SpotLeverageTokenServiceI :.
V5SpotMarginTradeServiceI :.
V5UserServiceI :.
WebsocketExecutor :.

# Type aliases

AccountType :.
CategoryV5 :.
Coin :.
ContractType :.
Direction :.
ExecType :.
Innovation :.
InstrumentStatus :.
Interval :.
IsLeverage : Valid for spot only.
No description provided by the author
OptionsType :.
OrderFilter : Valid for spot only.
OrderStatus :.
OrderStatusSpot :.
OrderType :.
OrderTypeSpot :.
Period :.
PositionIdx :.
Side :.
SpotInterval :.
SpotQuoteDepthBidsAsks :.
SpotWebsocketV1PrivateEventType :.
SpotWebsocketV1PublicV1Event :.
SpotWebsocketV1PublicV1Topic :.
SpotWebsocketV1PublicV2Event :.
SpotWebsocketV1PublicV2Topic :.
SymbolInverse :.
SymbolSpot :.
SymbolUSDT :.
SymbolV5 :.
TickDirection :.
TimeInForce :.
TimeInForceSpot :.
TpSlMode :.
TriggerBy :.
TriggerDirection :.
V5GetIndexPriceKlineList :.
V5GetKlineList :.
V5GetMarkPriceKlineList :.
V5GetOrderbookBidAsks :.
V5GetPositionInfoList :.
V5GetPremiumIndexPriceKlineList :.