bybitapi

package

Go to main page

Versions in this module

v1

v1.59.2

May 20, 2024

v1.59.1

May 14, 2024

v1.59.0

May 14, 2024

v1.58.0

Mar 19, 2024

v1.57.0

Feb 27, 2024

v1.56.2

Jan 29, 2024

v1.56.1

Jan 28, 2024

v1.56.0

Jan 26, 2024

v1.55.4

Dec 20, 2023

v1.55.3

Dec 18, 2023

v1.55.2

Dec 18, 2023

v1.55.1

Dec 15, 2023

v1.55.0

Dec 14, 2023

v1.54.0

Nov 20, 2023

v1.53.0

Nov 9, 2023

Changes in this version

type APIResponse

+ func (a APIResponse) Error() error

+ func (a APIResponse) Validate() error

type CancelOrderRequest

+ func (p *CancelOrderRequest) GetPath() string

type GetAccountInfoRequest

+ func (g *GetAccountInfoRequest) GetPath() string

type GetFeeRatesRequest

+ func (g *GetFeeRatesRequest) GetPath() string

type GetInstrumentsInfoRequest

+ func (g *GetInstrumentsInfoRequest) GetPath() string

type GetKLinesRequest

+ func (g *GetKLinesRequest) GetPath() string

type GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) GetPath() string

type GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) GetPath() string

type GetTickersRequest

+ func (g *GetTickersRequest) GetPath() string

type GetWalletBalancesRequest

+ func (g *GetWalletBalancesRequest) GetPath() string

type PlaceOrderRequest

+ func (p *PlaceOrderRequest) GetPath() string

v1.52.0

Oct 2, 2023

Changes in this version

+ const KLinesArrayLen

+ const WsSpotPrivateUrl

+ const WsSpotPublicSpotUrl

+ var SupportedIntervals = map[types.Interval]int

+ var ToGlobalInterval = map[string]types.Interval

+ func Sign(payload string, secret string) string

+ type AccountType string

+ const AccountTypeSpot

+ type FeeRate struct

+ MakerFeeRate fixedpoint.Value

+ Symbol string

+ TakerFeeRate fixedpoint.Value

+ type FeeRates struct

+ List []FeeRate

+ type GetFeeRatesRequest struct

+ func (g *GetFeeRatesRequest) BaseCoin(baseCoin string) *GetFeeRatesRequest

+ func (g *GetFeeRatesRequest) Category(category Category) *GetFeeRatesRequest

+ func (g *GetFeeRatesRequest) Do(ctx context.Context) (*FeeRates, error)

+ func (g *GetFeeRatesRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetFeeRatesRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetFeeRatesRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetFeeRatesRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetFeeRatesRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetFeeRatesRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetFeeRatesRequest) Symbol(symbol string) *GetFeeRatesRequest

+ type GetKLinesRequest struct

+ func (g *GetKLinesRequest) Category(category Category) *GetKLinesRequest

+ func (g *GetKLinesRequest) Do(ctx context.Context) (*KLinesResponse, error)

+ func (g *GetKLinesRequest) EndTime(endTime time.Time) *GetKLinesRequest

+ func (g *GetKLinesRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetKLinesRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetKLinesRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetKLinesRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetKLinesRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetKLinesRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetKLinesRequest) Interval(interval string) *GetKLinesRequest

+ func (g *GetKLinesRequest) Limit(limit uint64) *GetKLinesRequest

+ func (g *GetKLinesRequest) StartTime(startTime time.Time) *GetKLinesRequest

+ func (g *GetKLinesRequest) Symbol(symbol string) *GetKLinesRequest

type GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) OrderLinkId(orderLinkId string) *GetOrderHistoriesRequest

+ type GetWalletBalancesRequest struct

+ func (g *GetWalletBalancesRequest) AccountType(accountType AccountType) *GetWalletBalancesRequest

+ func (g *GetWalletBalancesRequest) Coin(coin string) *GetWalletBalancesRequest

+ func (g *GetWalletBalancesRequest) Do(ctx context.Context) (*WalletBalancesResponse, error)

+ func (g *GetWalletBalancesRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetWalletBalancesRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetWalletBalancesRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetWalletBalancesRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetWalletBalancesRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetWalletBalancesRequest) GetSlugsMap() (map[string]string, error)

+ type IntervalSign string

+ const IntervalSignDay

+ const IntervalSignMonth

+ const IntervalSignWeek

+ type KLine struct

+ Close fixedpoint.Value

+ High fixedpoint.Value

+ Low fixedpoint.Value

+ Open fixedpoint.Value

+ StartTime types.MillisecondTimestamp

+ TurnOver fixedpoint.Value

+ Volume fixedpoint.Value

+ func (k *KLine) UnmarshalJSON(data []byte) error

+ type KLinesResponse struct

+ Category Category

+ List []KLine

+ Symbol string

type RestClient

+ func (c *RestClient) NewGetFeeRatesRequest() *GetFeeRatesRequest

+ func (c *RestClient) NewGetKLinesRequest() *GetKLinesRequest

+ func (c *RestClient) NewGetWalletBalancesRequest() *GetWalletBalancesRequest

+ type WalletBalances struct

+ AccountIMRate fixedpoint.Value

+ AccountLTV fixedpoint.Value

+ AccountMMRate fixedpoint.Value

+ AccountType AccountType

+ Coins []struct{ ... }

+ TotalAvailableBalance fixedpoint.Value

+ TotalEquity fixedpoint.Value

+ TotalInitialMargin fixedpoint.Value

+ TotalMaintenanceMargin fixedpoint.Value

+ TotalMarginBalance fixedpoint.Value

+ TotalPerpUPL fixedpoint.Value

+ TotalWalletBalance fixedpoint.Value

+ type WalletBalancesResponse struct

+ List []WalletBalances

v1.51.1

Aug 2, 2023

Changes in this version

+ var AllOrderStatuses = []OrderStatus

+ type CancelOrderRequest struct

+ func (p *CancelOrderRequest) Category(category Category) *CancelOrderRequest

+ func (p *CancelOrderRequest) Do(ctx context.Context) (*CancelOrderResponse, error)

+ func (p *CancelOrderRequest) GetParameters() (map[string]interface{}, error)

+ func (p *CancelOrderRequest) GetParametersJSON() ([]byte, error)

+ func (p *CancelOrderRequest) GetParametersQuery() (url.Values, error)

+ func (p *CancelOrderRequest) GetQueryParameters() (url.Values, error)

+ func (p *CancelOrderRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (p *CancelOrderRequest) GetSlugsMap() (map[string]string, error)

+ func (p *CancelOrderRequest) OrderFilter(orderFilter string) *CancelOrderRequest

+ func (p *CancelOrderRequest) OrderId(orderId string) *CancelOrderRequest

+ func (p *CancelOrderRequest) OrderLinkId(orderLinkId string) *CancelOrderRequest

+ func (p *CancelOrderRequest) Symbol(symbol string) *CancelOrderRequest

+ type CancelOrderResponse struct

+ OrderId string

+ OrderLinkId string

+ type GetOpenOrdersRequest struct

+ func (g *GetOpenOrdersRequest) BaseCoin(baseCoin string) *GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) Category(category Category) *GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) Cursor(cursor string) *GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) Do(ctx context.Context) (*OrdersResponse, error)

+ func (g *GetOpenOrdersRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetOpenOrdersRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetOpenOrdersRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetOpenOrdersRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetOpenOrdersRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetOpenOrdersRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetOpenOrdersRequest) Limit(limit uint64) *GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) OpenOnly(openOnly OpenOnly) *GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) OrderFilter(orderFilter string) *GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) OrderId(orderId string) *GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) OrderLinkId(orderLinkId string) *GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) SettleCoin(settleCoin string) *GetOpenOrdersRequest

+ func (g *GetOpenOrdersRequest) Symbol(symbol string) *GetOpenOrdersRequest

+ type GetOrderHistoriesRequest struct

+ func (g *GetOrderHistoriesRequest) Category(category Category) *GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) Cursor(cursor string) *GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) Do(ctx context.Context) (*OrdersResponse, error)

+ func (g *GetOrderHistoriesRequest) EndTime(endTime time.Time) *GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetOrderHistoriesRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetOrderHistoriesRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetOrderHistoriesRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetOrderHistoriesRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetOrderHistoriesRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetOrderHistoriesRequest) Limit(limit uint64) *GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) OrderFilter(orderFilter string) *GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) OrderId(orderId string) *GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) OrderStatus(orderStatus OrderStatus) *GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) StartTime(startTime time.Time) *GetOrderHistoriesRequest

+ func (g *GetOrderHistoriesRequest) Symbol(symbol string) *GetOrderHistoriesRequest

+ type GetTickersRequest struct

+ func (g *GetTickersRequest) Category(category Category) *GetTickersRequest

+ func (g *GetTickersRequest) Do(ctx context.Context) (*APIResponse, error)

+ func (g *GetTickersRequest) DoWithResponseTime(ctx context.Context) (*Tickers, error)

+ func (g *GetTickersRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetTickersRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetTickersRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetTickersRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetTickersRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetTickersRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetTickersRequest) Symbol(symbol string) *GetTickersRequest

+ type Instrument struct

+ BaseCoin string

+ Innovation string

+ LotSizeFilter struct{ ... }

+ MarginTrading string

+ PriceFilter struct{ ... }

+ QuoteCoin string

+ Status Status

+ Symbol string

+ type OpenOnly int

+ const OpenOnlyOrder

+ type Order struct

+ AvgPrice fixedpoint.Value

+ BlockTradeId string

+ CancelType string

+ CloseOnTrigger bool

+ CreatedTime types.MillisecondTimestamp

+ CumExecFee fixedpoint.Value

+ CumExecQty fixedpoint.Value

+ CumExecValue fixedpoint.Value

+ IsLeverage string

+ LastPriceOnCreated string

+ LeavesQty fixedpoint.Value

+ LeavesValue fixedpoint.Value

+ OrderId string

+ OrderIv string

+ OrderLinkId string

+ OrderStatus OrderStatus

+ OrderType OrderType

+ PlaceType string

+ PositionIdx int

+ Price fixedpoint.Value

+ Qty fixedpoint.Value

+ ReduceOnly bool

+ RejectReason string

+ Side Side

+ SlLimitPrice string

+ SlTriggerBy string

+ SmpGroup int

+ SmpOrderId string

+ SmpType string

+ StopLoss fixedpoint.Value

+ StopOrderType string

+ Symbol string

+ TakeProfit fixedpoint.Value

+ TimeInForce TimeInForce

+ TpLimitPrice string

+ TpTriggerBy string

+ TpslMode string

+ TriggerBy string

+ TriggerDirection int

+ TriggerPrice fixedpoint.Value

+ UpdatedTime types.MillisecondTimestamp

+ type OrderStatus string

+ const OrderStatusActive

+ const OrderStatusCancelled

+ const OrderStatusCreated

+ const OrderStatusDeactivated

+ const OrderStatusFilled

+ const OrderStatusNew

+ const OrderStatusPartiallyFilled

+ const OrderStatusPartiallyFilledCanceled

+ const OrderStatusRejected

+ type OrderType string

+ const OrderTypeLimit

+ const OrderTypeMarket

+ type OrdersResponse struct

+ Category string

+ List []Order

+ NextPageCursor string

+ type PlaceOrderRequest struct

+ func (p *PlaceOrderRequest) Category(category Category) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) CloseOnTrigger(closeOnTrigger bool) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Do(ctx context.Context) (*PlaceOrderResponse, error)

+ func (p *PlaceOrderRequest) GetParameters() (map[string]interface{}, error)

+ func (p *PlaceOrderRequest) GetParametersJSON() ([]byte, error)

+ func (p *PlaceOrderRequest) GetParametersQuery() (url.Values, error)

+ func (p *PlaceOrderRequest) GetQueryParameters() (url.Values, error)

+ func (p *PlaceOrderRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (p *PlaceOrderRequest) GetSlugsMap() (map[string]string, error)

+ func (p *PlaceOrderRequest) IsLeverage(isLeverage bool) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Mmp(mmp bool) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) OrderFilter(orderFilter string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) OrderIv(orderIv string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) OrderLinkId(orderLinkId string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) OrderType(orderType OrderType) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) PositionIdx(positionIdx string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Price(price string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Qty(qty string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) ReduceOnly(reduceOnly bool) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Side(side Side) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) SlLimitPrice(slLimitPrice string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) SlOrderType(slOrderType string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) SlTriggerBy(slTriggerBy string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) SmpType(smpType string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) StopLoss(stopLoss string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) Symbol(symbol string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) TakeProfit(takeProfit string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) TimeInForce(timeInForce TimeInForce) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) TpLimitPrice(tpLimitPrice string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) TpOrderType(tpOrderType string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) TpTriggerBy(tpTriggerBy string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) TpslMode(tpslMode string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) TriggerBy(triggerBy string) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) TriggerDirection(triggerDirection int) *PlaceOrderRequest

+ func (p *PlaceOrderRequest) TriggerPrice(triggerPrice string) *PlaceOrderRequest

+ type PlaceOrderResponse struct

+ OrderId string

+ OrderLinkId string

type RestClient

+ func (c *RestClient) NewCancelOrderRequest() *CancelOrderRequest

+ func (c *RestClient) NewGetOpenOrderRequest() *GetOpenOrdersRequest

+ func (c *RestClient) NewGetOrderHistoriesRequest() *GetOrderHistoriesRequest

+ func (c *RestClient) NewGetTickersRequest() *GetTickersRequest

+ func (c *RestClient) NewPlaceOrderRequest() *PlaceOrderRequest

+ type Side string

+ const SideBuy

+ const SideSell

+ type Ticker struct

+ Ask1Price fixedpoint.Value

+ Ask1Size fixedpoint.Value

+ Bid1Price fixedpoint.Value

+ Bid1Size fixedpoint.Value

+ HighPrice24H fixedpoint.Value

+ LastPrice fixedpoint.Value

+ LowPrice24H fixedpoint.Value

+ PrevPrice24H fixedpoint.Value

+ Price24HPcnt fixedpoint.Value

+ Symbol string

+ Turnover24H fixedpoint.Value

+ UsdIndexPrice fixedpoint.Value

+ Volume24H fixedpoint.Value

+ type Tickers struct

+ Category Category

+ ClosedTime types.MillisecondTimestamp

+ List []Ticker

+ type TimeInForce string

+ const TimeInForceFOK

+ const TimeInForceGTC

+ const TimeInForceIOC

v1.51.0

Jul 24, 2023

Changes in this version

+ const RestBaseURL

+ type APIResponse struct

+ Result json.RawMessage

+ RetCode uint

+ RetExtInfo json.RawMessage

+ RetMsg string

+ Time types.MillisecondTimestamp

+ type AccountInfo struct

+ DcpStatus string

+ MarginMode string

+ SmpGroup int

+ TimeWindow int

+ UnifiedMarginStatus int

+ UpdatedTime string

+ type Category string

+ const CategorySpot

+ type GetAccountInfoRequest struct

+ func (g *GetAccountInfoRequest) Do(ctx context.Context) (*AccountInfo, error)

+ func (g *GetAccountInfoRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetAccountInfoRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetAccountInfoRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetAccountInfoRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetAccountInfoRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetAccountInfoRequest) GetSlugsMap() (map[string]string, error)

+ type GetInstrumentsInfoRequest struct

+ func (g *GetInstrumentsInfoRequest) Category(category Category) *GetInstrumentsInfoRequest

+ func (g *GetInstrumentsInfoRequest) Cursor(cursor string) *GetInstrumentsInfoRequest

+ func (g *GetInstrumentsInfoRequest) Do(ctx context.Context) (*InstrumentsInfo, error)

+ func (g *GetInstrumentsInfoRequest) GetParameters() (map[string]interface{}, error)

+ func (g *GetInstrumentsInfoRequest) GetParametersJSON() ([]byte, error)

+ func (g *GetInstrumentsInfoRequest) GetParametersQuery() (url.Values, error)

+ func (g *GetInstrumentsInfoRequest) GetQueryParameters() (url.Values, error)

+ func (g *GetInstrumentsInfoRequest) GetSlugParameters() (map[string]interface{}, error)

+ func (g *GetInstrumentsInfoRequest) GetSlugsMap() (map[string]string, error)

+ func (g *GetInstrumentsInfoRequest) Limit(limit uint64) *GetInstrumentsInfoRequest

+ func (g *GetInstrumentsInfoRequest) Symbol(symbol string) *GetInstrumentsInfoRequest

+ type InstrumentsInfo struct

+ Category Category

+ List []struct{ ... }

+ type RestClient struct

+ func NewClient() (*RestClient, error)

+ func (c *RestClient) Auth(key, secret string)

+ func (c *RestClient) NewAuthenticatedRequest(ctx context.Context, method, refURL string, params url.Values, ...) (*http.Request, error)

+ func (c *RestClient) NewGetAccountRequest() *GetAccountInfoRequest

+ func (c *RestClient) NewGetInstrumentsInfoRequest() *GetInstrumentsInfoRequest

+ type Status string

+ const StatusTrading

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL