Module http 

REST API: http::Client, its http::Config, request parameters and responses.

Structs

APIErrorResponse

Error part of the response envelope.

APIKeyInformation

Result of GET /v5/user/query-api (Client::get_api_key_information).

APIKeyPermissions

Part of the response of /v5/user/query-api.

AccountCoinBalance

Result of GET /v5/asset/transfer/query-account-coin-balance (Client::get_account_coin_balance).

AccountInfo

Result of GET /v5/account/info (Client::get_account_info).

AmendOrderBatchRequest

Request body of POST /v5/order/amend-batch (Client::amend_orders_batch).

AmendOrderBatchResult

Item of the list returned by POST /v5/order/amend-batch (Client::amend_orders_batch).

AmendOrderRequest

Request body of POST /v5/order/amend (Client::amend_order).

AmendOrderResponse

Result of POST /v5/order/amend (Client::amend_order).

AssetInfoResult

Result of GET /v5/asset/transfer/query-asset-info (Client::get_asset_info).

AuctionFeeInfo

Part of the response of /v5/market/instruments-info.

BatchItemResult

Result of one item of a batch request.

BorrowHistoryEntry

Item of the list returned by GET /v5/account/borrow-history (Client::get_borrow_history).

BucketLimit

Sustained throughput and burst capacity for one rate-limit bucket.

CancelAllOrdersRequest

Request body of POST /v5/order/cancel-all (Client::cancel_all_orders).

CancelOrderBatchRequest

Request body of POST /v5/order/cancel-batch (Client::cancel_orders_batch).

CancelOrderBatchResult

Item of the list returned by POST /v5/order/cancel-batch (Client::cancel_orders_batch).

CancelOrderRequest

Request body of POST /v5/order/cancel (Client::cancel_order).

CancelOrderResponse

Result of POST /v5/order/cancel (Client::cancel_order).

CancelWithdrawalRequest

Request body for Client::cancel_withdrawal.

CancelWithdrawalResult

Result of POST /v5/asset/withdraw/cancel (Client::cancel_withdrawal).

Client

Bybit V5 REST client.

ClosedPnl

Item of the list returned by GET /v5/position/closed-pnl (Client::get_closed_pnl).

CoinBalance

Part of the response of /v5/asset/transfer/query-account-coin-balance.

CoinChain

Part of the response of /v5/asset/coin/query-info.

CoinGreeks

Item of the list returned by GET /v5/asset/coin-greeks (Client::get_coin_greeks).

CoinInfo

Part of the response of /v5/asset/coin/query-info.

CoinInfoResult

Result of GET /v5/asset/coin/query-info (Client::get_coin_info).

CollateralInfoEntry

Item of the list returned by GET /v5/account/collateral-info (Client::get_collateral_info).

Config

Configuration of a Client; start with Config::new or Config::for_env.

CursorPagination

A page of a cursor-paginated list.

DCPConfiguration

Disconnection Cancellation Protection settings of one product.

DCPInfo

Disconnection Cancellation Protection (DCP) settings of the account.

DeliveryPrice

Response for Client::get_delivery_price.

DeliveryPriceEntry

Part of the response of /v5/market/delivery-price.

DeliveryRecord

Item of the list returned by GET /v5/asset/delivery-record (Client::get_delivery_record).

DepositAddress

Result of GET /v5/asset/deposit/query-address (Client::get_deposit_address, Client::get_sub_deposit_address).

DepositAllowedCoinInfoResult

Result of GET /v5/asset/deposit/query-allowed-list (Client::get_deposit_allowed_coin_info).

DepositChain

Part of the response of /v5/asset/deposit/query-address.

DepositCoinConfig

Part of the response of /v5/asset/deposit/query-allowed-list.

DepositRecord

Part of the response of /v5/asset/deposit/query-record.

DepositRecords

Result of GET /v5/asset/deposit/query-record (Client::get_deposit_records, Client::get_sub_deposit_records).

EmptyResult

Returned by position-management and other void-result endpoints whose result field is the empty object {}.

ExchangeOrderRecord

Part of the response of /v5/asset/exchange/order-record.

ExchangeOrderRecords

Result of GET /v5/asset/exchange/order-record (Client::get_exchange_order_record).

ExecutionEntry

Item of the list returned by GET /v5/execution/list (Client::get_execution_list).

FeeRateEntry

Item of the list returned by GET /v5/account/fee-rate (Client::get_fee_rate).

FundingRateEntry

Part of the response of /v5/market/funding/history.

GetAccountCoinBalanceParams

Query params for Client::get_account_coin_balance.

GetAssetInfoParams

Query params for Client::get_asset_info.

GetBorrowHistoryParams

Query params for Client::get_borrow_history.

GetClosedPnlParams

Query parameters of GET /v5/position/closed-pnl (Client::get_closed_pnl).

GetCoinGreeksParams

Query params for Client::get_coin_greeks.

GetCoinInfoParams

Query params for Client::get_coin_info.

GetCollateralInfoParams

Query params for Client::get_collateral_info.

GetDeliveryPriceParams

Query params for Client::get_delivery_price.

GetDeliveryRecordParams

Query params for Client::get_delivery_record.

GetDepositAddressParams

Query params for Client::get_deposit_address.

GetDepositAllowedCoinInfoParams

Query params for Client::get_deposit_allowed_coin_info.

GetDepositRecordsParams

Query params for Client::get_deposit_records.

GetExchangeOrderRecordParams

Query params for Client::get_exchange_order_record.

GetExecutionListParams

Query parameters of GET /v5/execution/list (Client::get_execution_list).

GetFeeRateParams

Query params for Client::get_fee_rate.

GetFundingRateHistoryParams

Query params for Client::get_funding_rate_history.

GetHistoricalVolatilityParams

Query params for Client::get_historical_volatility.

GetInstrumentsInfoParams

Query parameters of GET /v5/market/instruments-info (Client::get_instruments_info).

GetInsuranceParams

Query params for Client::get_insurance.

GetInternalTransferRecordsParams

Query params for Client::get_internal_transfer_records.

GetKLinesParams

Query parameters of GET /v5/market/kline (Client::get_index_price_kline, Client::get_kline, Client::get_mark_price_kline, Client::get_premium_index_price_kline).

GetLeverageTokenInfoParams

Query params for Client::get_leverage_token_info.

GetLeverageTokenMarketParams

Query params for Client::get_leverage_token_market.

GetLeverageTokenOrderRecordsParams

Query params for Client::get_leverage_token_order_records.

GetOpenClosedOrdersParams

Query parameters of GET /v5/order/realtime (Client::get_open_closed_orders).

GetOpenInterestParams

Query params for Client::get_open_interest.

GetOrderHistoryParams

Query parameters of GET /v5/order/history (Client::get_order_history).

GetOrderbookParams

Query parameters of GET /v5/market/orderbook (Client::get_orderbook).

GetPositionInfoParams

Query parameters of GET /v5/position/list (Client::get_position_info).

GetRiskLimitParams

Query params for Client::get_risk_limit.

GetSettlementRecordParams

Query params for Client::get_settlement_record.

GetSpotBorrowCheckParams

Query params for Client::get_spot_borrow_check.

GetSubDepositAddressParams

Query params for Client::get_sub_deposit_address.

GetSubDepositRecordsParams

Query params for Client::get_sub_deposit_records.

GetTickersParams

Query parameters of GET /v5/market/tickers (Client::get_tickers).

GetTradesParams

Query parameters of GET /v5/market/recent-trade (Client::get_public_recent_trading_history).

GetTransactionLogParams

Query parameters of GET /v5/account/transaction-log (Client::get_transaction_log).

GetTransferableCoinsParams

Query params for Client::get_transferable_coins.

GetUniversalTransferRecordsParams

Query params for Client::get_universal_transfer_records.

GetWalletBalanceParams

Query parameters of GET /v5/account/wallet-balance (Client::get_wallet_balance).

GetWithdrawableAmountParams

Query params for Client::get_withdrawable_amount.

GetWithdrawalRecordsParams

Query params for Client::get_withdrawal_records.

Headers

Response headers parsed by the client.

HistoricalVolatilityEntry

One data point from Client::get_historical_volatility.

Insurance

Response for Client::get_insurance.

InsuranceEntry

Part of the response of /v5/market/insurance.

InternalTransferEntry

Item of the list returned by GET /v5/asset/transfer/query-inter-transfer-list (Client::get_internal_transfer_records).

InternalTransferRequest

Request body for Client::internal_transfer.

InverseLinearInstrumentsInfo

Part of the response of /v5/market/instruments-info.

InverseLinearSpotTrade

Part of the response of /v5/account/transaction-log.

KLineRow

Part of the response of /v5/market/kline.

LeverageFilter

Part of the response of /v5/market/instruments-info.

LeverageTokenInfo

Item of the list returned by GET /v5/spot-lever-token/info (Client::get_leverage_token_info).

LeverageTokenMarket

Result of GET /v5/spot-lever-token/reference (Client::get_leverage_token_market).

LeverageTokenOrderRecord

Item of the list returned by GET /v5/spot-lever-token/order-record (Client::get_leverage_token_order_records).

LinearInverseTicker

Part of the response of /v5/market/tickers.

List

A list result without pagination.

LotSizeFilter

Part of the response of /v5/market/instruments-info.

MarginModeFailureReason

Part of the response of /v5/account/set-margin-mode.

OpenInterest

Response for Client::get_open_interest.

OpenInterestEntry

Part of the response of /v5/market/open-interest.

OptionInstrumentsInfo

An option of GET /v5/market/instruments-info.

OptionLotSizeFilter

Order quantity limits of an option.

OptionTicker

Part of the response of /v5/market/tickers.

OptionTrade

Part of the response of /v5/account/transaction-log.

Order

Item of the list returned by GET /v5/order/realtime (Client::get_open_closed_orders, Client::get_order_history).

Orderbook

Result of GET /v5/market/orderbook (Client::get_orderbook).

OrderbookLevel

Part of the response of /v5/market/orderbook.

Phase

Part of the response of /v5/market/instruments-info.

PlaceOrderBatchRequest

Request body of POST /v5/order/create-batch (Client::place_orders_batch).

PlaceOrderBatchResult

Item of the list returned by POST /v5/order/create-batch (Client::place_orders_batch).

PlaceOrderRequest

Request body of POST /v5/order/create (Client::place_order).

PlaceOrderResponse

Result of POST /v5/order/create (Client::place_order).

Position

A position from GET /v5/position/list.

PreListingInfo

Part of the response of /v5/market/instruments-info.

PriceFilter

Part of the response of /v5/market/instruments-info.

PriceKLine

Result of the mark, index and premium index price kline endpoints: rows carry prices only (no volume or turnover).

PriceKLineRow

A price-only kline row: [startTime, open, high, low, close].

PurchaseLeverageTokenRequest

Request body for Client::purchase_leverage_token.

PurchaseLeverageTokenResult

Result of POST /v5/spot-lever-token/purchase (Client::purchase_leverage_token).

RateLimitKey

Identifies one of Bybit’s independent per-UID rate-limit buckets.

RateLimiterConfig

Configuration for the optional per-endpoint rate limiter.

RedeemLeverageTokenRequest

Request body for Client::redeem_leverage_token.

RedeemLeverageTokenResult

Result of POST /v5/spot-lever-token/redeem (Client::redeem_leverage_token).

Resp

Raw response envelope of the Bybit REST API.

Response

A successful REST response.

RetExtInfo

Per-item status for batch trade endpoints. For all other endpoints retExtInfo is {} — the list defaults to empty.

RiskLimit

Response for Client::get_risk_limit.

RiskLimitEntry

Part of the response of /v5/market/risk-limit.

RiskParameters

Part of the response of /v5/market/instruments-info.

SaveTransferSubMemberRequest

Request body for Client::save_transfer_sub_member.

ServerTime

Result of GET /v5/market/time (Client::get_server_time).

SetAutoAddMarginRequest

Request body of POST /v5/position/set-auto-add-margin (Client::set_auto_add_margin).

SetLeverageRequest

Request body of POST /v5/position/set-leverage (Client::set_leverage).

SetMarginModeRequest

Request body for Client::set_margin_mode.

SetMarginModeResponse

Response for Client::set_margin_mode.

SetRiskLimitRequest

Request body of POST /v5/position/set-risk-limit (Client::set_risk_limit).

SetRiskLimitResponse

Result of POST /v5/position/set-risk-limit (Client::set_risk_limit).

SetSpotMarginLeverageRequest

Request body for Client::set_spot_margin_leverage.

SetTradingStopRequest

Request body of POST /v5/position/trading-stop (Client::set_trading_stop).

SettlementRecord

Item of the list returned by GET /v5/asset/settlement-record (Client::get_settlement_record).

SpotAsset

Part of the response of /v5/asset/transfer/query-asset-info.

SpotAssetInfo

Part of the response of /v5/asset/transfer/query-asset-info.

SpotBorrowCheck

Response for Client::get_spot_borrow_check.

SpotInstrumentsInfo

Part of the response of /v5/market/instruments-info.

SpotLotSizeFilter

Part of the response of /v5/market/instruments-info.

SpotPriceFilter

Part of the response of /v5/market/instruments-info.

SpotTicker

Part of the response of /v5/market/tickers.

SwitchCrossIsolatedMarginRequest

Request body of POST /v5/position/switch-isolated (Client::switch_cross_isolated_margin).

SwitchPositionModeRequest

Request body of POST /v5/position/switch-mode (Client::switch_position_mode).

SwitchSpotMarginModeRequest

Request body for Client::switch_spot_margin_mode.

SwitchSpotMarginModeResult

Result of POST /v5/spot-margin-trade/switch-mode (Client::switch_spot_margin_mode).

TransactionLog

Item of the list returned by GET /v5/account/transaction-log (Client::get_transaction_log).

TransferResult

Response for Client::internal_transfer and Client::universal_transfer.

TransferableSubMembers

Response for Client::get_transferable_sub_members.

UnifiedUpdateMsg

Part of the response of /v5/account/upgrade-to-uta.

UniversalTransferEntry

Item of the list returned by GET /v5/asset/transfer/query-universal-transfer-list (Client::get_universal_transfer_records).

UniversalTransferRequest

Request body for Client::universal_transfer.

UpgradeToUtaResult

Response for Client::upgrade_to_uta.

WalletBalance

Item of the list returned by GET /v5/account/wallet-balance (Client::get_wallet_balance).

WalletCoin

Part of the response of /v5/account/wallet-balance.

WithdrawRecord

Part of the response of /v5/asset/withdraw/query-record.

WithdrawRecords

Result of GET /v5/asset/withdraw/query-record (Client::get_withdrawal_records).

WithdrawRequest

Request body for Client::withdraw.

WithdrawResult

Result of POST /v5/asset/withdraw/create (Client::withdraw).

WithdrawableAmountByWallet

Part of the response of /v5/asset/withdraw/withdrawable-amount.

WithdrawableAmountEntry

Part of the response of /v5/asset/withdraw/withdrawable-amount.

WithdrawableAmountResult

Result of GET /v5/asset/withdraw/withdrawable-amount (Client::get_withdrawable_amount).

Enums

FundingRateHistory

Response for Client::get_funding_rate_history.

InstrumentsInfo

Result of GET /v5/market/instruments-info (Client::get_instruments_info).

KLine

Result of GET /v5/market/kline (Client::get_kline).

OrderFilter

Part of the request of /v5/order/cancel.

Ticker

Result of GET /v5/market/tickers (Client::get_tickers).

Trade

Result of GET /v5/market/recent-trade (Client::get_public_recent_trading_history).

Constants

DEFAULT_CONNECT_TIMEOUT

Default timeout of establishing a TCP/TLS connection.

DEFAULT_RECV_WINDOW

Default X-BAPI-RECV-WINDOW, milliseconds.

DEFAULT_TIMEOUT

Default total timeout of one HTTP request.

MAX_PAGES

Upper bound on the number of pages fetched by the *_all methods.

Type Aliases

CancelAllOrdersResponse

Response for cancel-all: a flat list of cancelled order IDs.