Modules§
Structs§
- Order
Book State - Local order book, reconstructed from a depth snapshot and a stream of diffs.
- Order
Key - Identifies an order. Order ids are unique only within a category.
- Position
Key - Identifies a position: one per symbol in one-way mode, two (buy and sell) in hedge mode.
- Sensitive
String - Signer
- User
State - Open orders, positions and wallet balances of one account.
Enums§
- Account
Type - AdlRank
Indicator - Announcement
Type - Apply
Outcome - Outcome of
OrderBookState::apply_snapshot,OrderBookState::apply_diffandOrderBookState::apply. - Cancel
Type - Category
- Unified Account: spot | linear | inverse | option Classic Account: linear | inverse | spot
- Change
- What
UserState::applyand friends changed. Updates that were older than the stored data are ignored and not reported. - Contract
Type - Convert
Account Type - Copy
Trading - Create
Type - CurAuction
Phase - DCPProduct
- Data
Recording Period - DcpFunction
- Deposit
Status - Depth
Level - Env
- Error
- Exec
Type - Extra
FeeType - Extra
SubFee Type - Interval
- Interval
Time - Locale
- LtOrder
Status - Status of a leveraged token purchase or redemption order.
- LtOrder
Type - Whether a leveraged token order record is a purchase or a redemption.
- LtStatus
- Maintain
Type - Margin
Mode - Margin
Trading - OcoTrigger
By - Option
Period - Order
Status - Order
Type - Pair
- Path
- Place
Type - Position
Idx - Position
Mode - Position
Status - Product
- Reject
Reason - Service
Types - Side
- Slippage
Tolerance Type - SmpType
- Spot
Hedging Status - Spot
Margin Mode - Whether Spot Margin Trade (UTA) is turned on for the account.
- State
- Status
- Stop
Order Type - Tick
Direction - Time
InForce - Topic
- Tpsl
Mode - Trade
Mode - Transfer
Status - Trigger
By - Trigger
Direction - Type
- Unified
Margin Status - Unified
Update Status - Outcome of an Upgrade to Unified Account (Pro) request.
- VipLevel
- Withdraw
Status
Constants§
- BASE_
URL_ API_ DEMO - BASE_
URL_ API_ MAINNET_ 1 - BASE_
URL_ API_ MAINNET_ 2 - BASE_
URL_ API_ MAINNET_ 3 - For Netherland users.
- BASE_
URL_ API_ MAINNET_ 4 - For Hong Kong users.
- BASE_
URL_ API_ MAINNET_ 5 - For Turkey users.
- BASE_
URL_ API_ MAINNET_ 6 - For Kazakhstan users.
- BASE_
URL_ API_ TESTNET - BASE_
URL_ STREAM_ DEMO - BASE_
URL_ STREAM_ MAINNET_ 1 - BASE_
URL_ STREAM_ MAINNET_ 2 - For Turkey users.
- BASE_
URL_ STREAM_ MAINNET_ 3 - For Kazakhstan users.
- BASE_
URL_ STREAM_ TESTNET - DEFAULT_
MAX_ BUFFERED_ DIFFS - Default for
OrderBookState::with_max_buffered. - MAX_
CLOSED_ ORDERS - Maximum number of closed orders remembered to reject late stream updates and stale snapshot entries for them.
Functions§
- create_
stream_ signature - hmac_
sha256 - Generates HMAC using the given key and message.
- spot_
fee_ currency - timestamp
- Return milliseconds.