Structs§
- APIError
Response - APIKey
Information - APIKey
Permissions - Account
Coin Balance - Account
Info - Amend
Order Batch Request - Amend
Order Batch Result - Amend
Order Request - Amend
Order Response - Asset
Info Result - Auction
FeeInfo - Batch
Item Result - Borrow
History Entry - Bucket
Limit - Sustained throughput and burst capacity for one rate-limit bucket.
- Cancel
AllOrders Request - Cancel
Order Batch Request - Cancel
Order Batch Result - Cancel
Order Request - Cancel
Order Response - Cancel
Withdrawal Request - Request body for
Client::cancel_withdrawal. - Cancel
Withdrawal Result - Client
- Closed
Pnl - Coin
Balance - Coin
Chain - Coin
Greeks - Coin
Info - Coin
Info Result - Collateral
Info Entry - Config
- Cursor
Pagination - DCPConfiguration
- DCPInfo
- Delivery
Price - Response for
Client::get_delivery_price. - Delivery
Price Entry - Delivery
Record - Deposit
Address - Deposit
Allowed Coin Info Result - Deposit
Chain - Deposit
Coin Config - Deposit
Record - Deposit
Records - Empty
Result - Returned by position-management and other void-result endpoints whose
resultfield is the empty object{}. - Exchange
Order Record - Exchange
Order Records - Execution
Entry - FeeRate
Entry - Funding
Rate Entry - GetAccount
Coin Balance Params - Query params for
Client::get_account_coin_balance. - GetAsset
Info Params - Query params for
Client::get_asset_info. - GetBorrow
History Params - Query params for
Client::get_borrow_history. - GetClosed
PnlParams - GetCoin
Greeks Params - Query params for
Client::get_coin_greeks. - GetCoin
Info Params - Query params for
Client::get_coin_info. - GetCollateral
Info Params - Query params for
Client::get_collateral_info. - GetDelivery
Price Params - Query params for
Client::get_delivery_price. - GetDelivery
Record Params - Query params for
Client::get_delivery_record. - GetDeposit
Address Params - Query params for
Client::get_deposit_address. - GetDeposit
Allowed Coin Info Params - Query params for
Client::get_deposit_allowed_coin_info. - GetDeposit
Records Params - Query params for
Client::get_deposit_records. - GetExchange
Order Record Params - Query params for
Client::get_exchange_order_record. - GetExecution
List Params - GetFee
Rate Params - Query params for
Client::get_fee_rate. - GetFunding
Rate History Params - Query params for
Client::get_funding_rate_history. - GetHistorical
Volatility Params - Query params for
Client::get_historical_volatility. - GetInstruments
Info Params - GetInsurance
Params - Query params for
Client::get_insurance. - GetInternal
Transfer Records Params - Query params for
Client::get_internal_transfer_records. - GetK
Lines Params - GetLeverage
Token Info Params - Query params for
Client::get_leverage_token_info. - GetLeverage
Token Market Params - Query params for
Client::get_leverage_token_market. - GetLeverage
Token Order Records Params - Query params for
Client::get_leverage_token_order_records. - GetOpen
Closed Orders Params - GetOpen
Interest Params - Query params for
Client::get_open_interest. - GetOrder
History Params - GetOrderbook
Params - GetPosition
Info Params - GetRisk
Limit Params - Query params for
Client::get_risk_limit. - GetSettlement
Record Params - Query params for
Client::get_settlement_record. - GetSpot
Borrow Check Params - Query params for
Client::get_spot_borrow_check. - GetSub
Deposit Address Params - Query params for
Client::get_sub_deposit_address. - GetSub
Deposit Records Params - Query params for
Client::get_sub_deposit_records. - GetTickers
Params - GetTrades
Params - GetTransaction
LogParams - GetTransferable
Coins Params - Query params for
Client::get_transferable_coins. - GetUniversal
Transfer Records Params - Query params for
Client::get_universal_transfer_records. - GetWallet
Balance Params - GetWithdrawable
Amount Params - Query params for
Client::get_withdrawable_amount. - GetWithdrawal
Records Params - Query params for
Client::get_withdrawal_records. - Headers
- Historical
Volatility Entry - One data point from
Client::get_historical_volatility. - Insurance
- Response for
Client::get_insurance. - Insurance
Entry - Internal
Transfer Entry - Internal
Transfer Request - Request body for
Client::internal_transfer. - Inverse
Linear Instruments Info - Inverse
Linear Spot Trade - KLine
Row - Leverage
Filter - Leverage
Token Info - Leverage
Token Market - Leverage
Token Order Record - Linear
Inverse Ticker - List
- LotSize
Filter - Margin
Mode Failure Reason - Open
Interest - Response for
Client::get_open_interest. - Open
Interest Entry - Option
Instruments Info - Option
Ticker - Option
Trade - Order
- Orderbook
- Orderbook
Level - Phase
- Place
Order Batch Request - Place
Order Batch Result - Place
Order Request - Place
Order Response - Position
- PreListing
Info - Price
Filter - Purchase
Leverage Token Request - Request body for
Client::purchase_leverage_token. - Purchase
Leverage Token Result - Rate
Limit Key - Identifies one of Bybit’s independent per-UID rate-limit buckets.
- Rate
Limiter Config - Configuration for the optional per-endpoint rate limiter.
- Redeem
Leverage Token Request - Request body for
Client::redeem_leverage_token. - Redeem
Leverage Token Result - Resp
- Response
- RetExt
Info - Per-item status for batch trade endpoints.
For all other endpoints
retExtInfois{}— thelistdefaults to empty. - Risk
Limit - Response for
Client::get_risk_limit. - Risk
Limit Entry - Risk
Parameters - Save
Transfer SubMember Request - Request body for
Client::save_transfer_sub_member. - Server
Time - SetAuto
AddMargin Request - SetLeverage
Request - SetMargin
Mode Request - Request body for
Client::set_margin_mode. - SetMargin
Mode Response - Response for
Client::set_margin_mode. - SetRisk
Limit Request - SetRisk
Limit Response - SetSpot
Margin Leverage Request - Request body for
Client::set_spot_margin_leverage. - SetTrading
Stop Request - Settlement
Record - Spot
Asset - Spot
Asset Info - Spot
Borrow Check - Response for
Client::get_spot_borrow_check. - Spot
Instruments Info - Spot
LotSize Filter - Spot
Price Filter - Spot
Ticker - Switch
Cross Isolated Margin Request - Switch
Position Mode Request - Switch
Spot Margin Mode Request - Request body for
Client::switch_spot_margin_mode. - Switch
Spot Margin Mode Result - Transaction
Log - Transfer
Result - Response for
Client::internal_transferandClient::universal_transfer. - Transferable
SubMembers - Response for
Client::get_transferable_sub_members. - Unified
Update Msg - Universal
Transfer Entry - Universal
Transfer Request - Request body for
Client::universal_transfer. - Upgrade
ToUta Result - Response for
Client::upgrade_to_uta. - Wallet
Balance - Wallet
Coin - Withdraw
Record - Withdraw
Records - Withdraw
Request - Request body for
Client::withdraw. - Withdraw
Result - Withdrawable
Amount ByWallet - Withdrawable
Amount Entry - Withdrawable
Amount Result
Enums§
- Funding
Rate History - Response for
Client::get_funding_rate_history. - Instruments
Info - KLine
- Order
Filter - Ticker
- Trade
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
*_allmethods.
Type Aliases§
- Cancel
AllOrders Response - Response for cancel-all: a flat list of cancelled order IDs.