Expand description
Types used as operation parameters and responses.
Modules§
- error
- Error types.
Structs§
- Account
Balance AccountBalance- AddPosition
Margin Request AddPositionMarginRequest- AddPosition
Margin Response AddPositionMarginResponse- AppUser
AppUser- AppUser
Address - Wallet address
- Application
Balance ApplicationBalance- Application
Movement ApplicationMovement- Application
Order ApplicationOrder- Attach
Position TpSl Request AttachPositionTpSlRequest- Attach
Position TpSl Response AttachPositionTpSlResponse- Batch
Cancel AllResponse BatchCancelAllResponse- Batch
Cancel Error BatchCancelError- Batch
Cancel Orders Request BatchCancelOrdersRequest- Batch
Cancel Orders Response BatchCancelOrdersResponse- Batch
Cancel Result BatchCancelResult- Batch
Close AllRequest BatchCloseAllRequest- Batch
Close AllResponse BatchCloseAllResponse- Batch
Close Error BatchCloseError- Batch
Close Result BatchCloseResult- Batch
Create Error BatchCreateError- Batch
Create Order Item BatchCreateOrderItem- Batch
Create Orders Request BatchCreateOrdersRequest- Batch
Create Orders Response BatchCreateOrdersResponse- Batch
Create Result BatchCreateResult- Batch
Replace Error BatchReplaceError- Batch
Replace Order Item BatchReplaceOrderItem- Batch
Replace Orders Request BatchReplaceOrdersRequest- Batch
Replace Orders Response BatchReplaceOrdersResponse- Batch
Replace Result BatchReplaceResult- Cancel
Conditional Order Response CancelConditionalOrderResponse- Cancel
Order Request CancelOrderRequest- Cancel
Order Response CancelOrderResponse- Candle
Candle- Challenge
Request ChallengeRequest- Challenge
Request Address - Ethereum wallet address
- Challenge
Request Session Public Key - Lowercase hex (64 chars) ed25519 public key generated locally by the SDK. The returned challenge message will embed this key so the wallet’s signature binds it; the same value must be submitted to /api/v1/auth/verify.
- Challenge
Response ChallengeResponse- Chart
Data Point ChartDataPoint- Close
Position Request ClosePositionRequest- Close
Position Response ClosePositionResponse- Conditional
Order ConditionalOrder- Create
Delegated Session Request CreateDelegatedSessionRequest- Create
Delegated Session Response CreateDelegatedSessionResponse- Create
Limit Request CreateLimitRequest- Create
Limit Request Daily Limit - Maximum daily spending limit in token units
- Create
Limit Request MaxAmount - Maximum amount allowed in token units
- Create
Limit Response CreateLimitResponse- Create
Order Request CreateOrderRequest- Create
Order Response CreateOrderResponse- Delegated
Agent DelegatedAgent- Delegated
Agent Allowed Actions Item DelegatedAgentAllowedActionsItem- Delegated
Agent Allowed Order Types Item DelegatedAgentAllowedOrderTypesItem- Delegated
Agent Allowed Time InForce Item DelegatedAgentAllowedTimeInForceItem- Delegated
Agent Owner DelegatedAgentOwner- Delete
Limit Response DeleteLimitResponse- Execution
Price Range ExecutionPriceRange- Failed
Mint FailedMint- FeeTier
Schedule Row FeeTierScheduleRow- Funding
Payment Record FundingPaymentRecord- Funding
Record FundingRecord- GetApp
Stats Response GetAppStatsResponse- GetAvailable
Collateral Response GetAvailableCollateralResponse- GetBalance
ByAsset Response GetBalanceByAssetResponse- GetBalances
Response GetBalancesResponse- GetCandles
Response - OHLCV candlestick data.
- GetConfig
Response GetConfigResponse- GetConfig
Response Allowed Origins Item GetConfigResponseAllowedOriginsItem- GetFunding
State Response GetFundingStateResponse- GetIndex
Price Response GetIndexPriceResponse- GetLimits
Response GetLimitsResponse- GetMargin
Account Movements Response GetMarginAccountMovementsResponse- GetMargin
Account Summary Response GetMarginAccountSummaryResponse- GetMark
Price Response GetMarkPriceResponse- GetMarket
Metadata Response - Market metadata with current price and 24h statistics.
- GetMarket
Stats Response - Exchange-wide life-to-date cumulative market statistics across all trading pairs.
- GetMovements
Response GetMovementsResponse- GetMy
FeeTier Response GetMyFeeTierResponse- GetOpen
Interest Response - Latest public open interest for a trading pair.
- GetOrder
Response GetOrderResponse- GetOrderbook
Response - Orderbook snapshot with token metadata and sequence number.
- GetOrders
Status GetOrdersStatus- GetPerp
Market Config Response GetPerpMarketConfigResponse- GetPerp
Market Summary Response GetPerpMarketSummaryResponse- GetPortfolio
Assets Response GetPortfolioAssetsResponse- GetPortfolio
Chart Response GetPortfolioChartResponse- GetPortfolio
Margin Response GetPortfolioMarginResponse- GetPortfolio
Performance Response GetPortfolioPerformanceResponse- GetPortfolio
Realized PnlResponse GetPortfolioRealizedPnlResponse- GetPortfolio
Stats Response GetPortfolioStatsResponse- GetPortfolio
Summary Response GetPortfolioSummaryResponse- GetPosition
PnlHistory Response GetPositionPnlHistoryResponse- GetPosition
Response GetPositionResponse- GetPosition
Risk Response GetPositionRiskResponse- GetProfile
Response GetProfileResponse- GetProfile
Response Address - Wallet address
- GetRewards
Balance Response GetRewardsBalanceResponse- GetScreener
Response - Paginated screener response sorted by quoteVolume24h desc (nulls last).
- GetTrade
ById Response - A single trade.
- GetTrader
Code Info Response GetTraderCodeInfoResponse- GetTrades
Response - Recent trades for a trading pair.
- GetTrading
Pair Response - Single trading pair details.
- GetUser
Trades Response GetUserTradesResponse- Index
Component IndexComponent- Initiate
Withdrawal Request InitiateWithdrawalRequest- Ledger
Movement LedgerMovement- List
AppBalances Response ListAppBalancesResponse- List
AppMovements Response ListAppMovementsResponse- List
AppOrders Response ListAppOrdersResponse- List
AppUsers Response ListAppUsersResponse- List
Application Orders Status ListApplicationOrdersStatus- List
Application Users Address ListApplicationUsersAddress- List
Conditional Orders Response ListConditionalOrdersResponse- List
Delegated Agent Owners Response ListDelegatedAgentOwnersResponse- List
Delegated Agents Response ListDelegatedAgentsResponse- List
Funding History Response ListFundingHistoryResponse- List
Funding Payments Response ListFundingPaymentsResponse- List
Margin Accounts Response ListMarginAccountsResponse- List
Orders Response ListOrdersResponse- List
Pending Withdrawals Response ListPendingWithdrawalsResponse- List
Position History Response ListPositionHistoryResponse- List
Positions Response ListPositionsResponse- List
Positions Status ListPositionsStatus- List
SubAccounts Response ListSubAccountsResponse- List
Trading Pairs Response - Paginated list of trading pairs.
- Margin
Account Movement MarginAccountMovement- Margin
Account Summary MarginAccountSummary- Match
Result MatchResult- Mint
Tokens Request MintTokensRequest- Mint
Tokens Response MintTokensResponse- Minted
Token MintedToken- Orderbook
Data OrderbookData- Parent
TpSl Leg ParentTpSlLeg- Pending
Withdrawal - A single pending withdrawal in a list response. A lightweight summary — the executable calldata is not included (it does not exist until the withdrawal is confirmed on-chain; fetch it from GetWithdrawal once it becomes ready).
- PnlBreakdown
- Lifetime PnL components for the authenticated user. The fields satisfy totalPnl = (spotRealized + perpsRealized) + (spotUnrealized + perpsUnrealized) - fundingPaid - fees.
- Portfolio
Asset Row PortfolioAssetRow- Portfolio
Assets Performance PortfolioAssetsPerformance- Portfolio
Best Day PortfolioBestDay- Portfolio
Closed Trade Stats PortfolioClosedTradeStats- Portfolio
Margin Position Counts PortfolioMarginPositionCounts- Portfolio
Margin Total PortfolioMarginTotal- Portfolio
Performance Drawdown PortfolioPerformanceDrawdown- Portfolio
Performance Point PortfolioPerformancePoint- Portfolio
Realized PnlPoint PortfolioRealizedPnlPoint- Portfolio
Realized Totals PortfolioRealizedTotals- Portfolio
Risk Bucket PortfolioRiskBucket- Portfolio
Series Window PortfolioSeriesWindow- Portfolio
Summary Activity PortfolioSummaryActivity- Portfolio
Summary Current PortfolioSummaryCurrent- Portfolio
Window PortfolioWindow- Position
Position- Position
History Event PositionHistoryEvent- Position
PnlPoint - One PnL state sample for a position in one bucket. Cumulative fields are lifetime values as of the bucket; fundingPaid and fees are cost-positive.
- Price
Change PriceChange- Price
Level PriceLevel- Public
Health Check Response PublicHealthCheckResponse- Public
Trade - A public trade event. Serializes to the REST envelope: { data: { … }, eventType, tradingPairId, tradingMode }. The WebSocket surface emits the equivalent envelope with snake_case keys.
- Reduce
Position Margin Request ReducePositionMarginRequest- Reduce
Position Margin Response ReducePositionMarginResponse- Refresh
Request RefreshRequest- Refresh
Response RefreshResponse- Replace
Order Request ReplaceOrderRequest- Replace
Order Response ReplaceOrderResponse- Revoke
Delegated Agent Response RevokeDelegatedAgentResponse- Revoke
Request RevokeRequest- Revoke
Response RevokeResponse- Rewards
Balance Entry RewardsBalanceEntry- Risk
Tier RiskTier- Screener
Item - Per-pair screener row. Window fields null when insufficient history.
- Screener
Snapshot Point - One UTC-day bucket in a pair’s 7-day snapshot.
- Simulate
Fees Price SimulateFeesPrice- Simulate
Fees Quantity SimulateFeesQuantity- Simulate
Fees Response SimulateFeesResponse- Simulate
Order Risk Request SimulateOrderRiskRequest- Simulate
Order Risk Response SimulateOrderRiskResponse- Simulate
Parent Margin Order Risk Request SimulateParentMarginOrderRiskRequest- Simulate
Risk Bucket Order Risk Request SimulateRiskBucketOrderRiskRequest- SubAccount
SubAccount- SubAccount
Address - Sub-account wallet address
- SubAccount
Limit SubAccountLimit- Submit
Whitelist Request SubmitWhitelistRequest- Submit
Whitelist Request Telegram Username - Applicant Telegram username
- Submit
Whitelist Request Twitter Username - Applicant Twitter/X username
- Submit
Whitelist Request Wallet Address - Applicant wallet address
- Submit
Whitelist Response SubmitWhitelistResponse- TpSlLeg
TpSlLeg- Trade
Data - Core fields of a single executed trade, nested under
datain the public trade event envelope. - Trader
Code Response TraderCodeResponse- Trading
Pair Data - Trading pair configuration including tokens, fees, and order limits.
- Transfer
Collateral From Margin Account Request TransferCollateralFromMarginAccountRequest- Transfer
Collateral From Margin Account Response TransferCollateralFromMarginAccountResponse- Transfer
Collateral From Parent Margin Account Request TransferCollateralFromParentMarginAccountRequest- Transfer
Collateral ToMargin Account Request TransferCollateralToMarginAccountRequest- Transfer
Collateral ToMargin Account Response TransferCollateralToMarginAccountResponse- Transfer
Collateral ToParent Margin Account Request TransferCollateralToParentMarginAccountRequest- Transfer
Collateral ToRisk Bucket Request TransferCollateralToRiskBucketRequest- Transfer
Rewards Request TransferRewardsRequest- Transfer
Rewards Response TransferRewardsResponse- Update
Limit Request UpdateLimitRequest- Update
Limit Request Daily Limit - New maximum daily spending limit in token units
- Update
Limit Request MaxAmount - New maximum amount allowed in token units
- Update
Limit Response UpdateLimitResponse- Updated
Fields UpdatedFields- Upsert
Delegated Agent Request UpsertDelegatedAgentRequest- Upsert
Delegated Agent Request Allowed Actions Item UpsertDelegatedAgentRequestAllowedActionsItem- Upsert
Delegated Agent Request Allowed Order Types Item UpsertDelegatedAgentRequestAllowedOrderTypesItem- Upsert
Delegated Agent Request Allowed Time InForce Item UpsertDelegatedAgentRequestAllowedTimeInForceItem- User
Info UserInfo- User
Info Address - Wallet address
- User
Trade UserTrade- Verify
Request VerifyRequest- Verify
Request Address - Ethereum wallet address
- Verify
Request Nonce - Challenge nonce
- Verify
Request Session Public Key - Lowercase hex (64 chars) ed25519 public key generated locally by the SDK. Subsequent authenticated requests are signed with the matching private key. The wallet’s signature on the challenge message proves the user authorized this specific public key.
- Verify
Request Signature - Wallet signature over the challenge message
- Verify
Response VerifyResponse- Withdrawal
Withdrawal
Enums§
- Batch
Create Order Item Margin Mode - Risk bucket mode for margin orders. Defaults to ISOLATED. Values: ISOLATED, CROSS.
- Batch
Create Order Item Position Side - Position side for margin orders: LONG, SHORT, or NONE
- Create
Order Request Margin Mode - Risk bucket mode for margin orders. Defaults to ISOLATED. Values: ISOLATED, CROSS.
- Create
Order Request Position Side - Position side for margin orders: LONG, SHORT, or NONE
- GetOrderbook
Snapshot Denomination GetOrderbookSnapshotDenomination- GetOrderbook
Snapshot Magnitude GetOrderbookSnapshotMagnitude- GetOrderbook
Snapshot Trading Mode GetOrderbookSnapshotTradingMode- GetOrders
Order By GetOrdersOrderBy- GetOrders
Trading Mode GetOrdersTradingMode- GetPortfolio
Assets Response Valuation Status GetPortfolioAssetsResponseValuationStatus- GetPortfolio
Performance Response Calculation Method GetPortfolioPerformanceResponseCalculationMethod- GetPortfolio
Performance Response Valuation Status GetPortfolioPerformanceResponseValuationStatus- GetPortfolio
Realized PnlResponse Bucket Interval GetPortfolioRealizedPnlResponseBucketInterval- GetPortfolio
Summary Response Valuation Status GetPortfolioSummaryResponseValuationStatus- GetPosition
PnlHistory Interval GetPositionPnlHistoryInterval- GetScreener
Market Type GetScreenerMarketType- GetUser
Movements Entry Type GetUserMovementsEntryType- GetUser
Movements Order By GetUserMovementsOrderBy- GetUser
Movements Transaction Type GetUserMovementsTransactionType- List
Application Movements Entry Type ListApplicationMovementsEntryType- List
Application Movements Transaction Type ListApplicationMovementsTransactionType- List
Application Orders Order Type ListApplicationOrdersOrderType- List
Application Orders Side ListApplicationOrdersSide- List
Application Users Account Type ListApplicationUsersAccountType- List
Trading Pairs Market Type ListTradingPairsMarketType- Parent
TpSl LegOrder Type - Triggered order type: MARKET or LIMIT
- Parent
TpSl LegTime InForce - LIMIT only: GTC or IOC
- Portfolio
Asset RowPricing Status PortfolioAssetRowPricingStatus- Portfolio
Assets Performance Calculation Method PortfolioAssetsPerformanceCalculationMethod- Portfolio
Series Window Calculation Interval - Finest retained interval used before display downsampling
- Portfolio
Series Window Coverage PortfolioSeriesWindowCoverage- Portfolio
Series Window Display Interval - Interval of returned chart points
- Portfolio
Series Window Period - Closed portfolio period token
- Portfolio
Window Coverage - History coverage for the requested period
- Portfolio
Window Period - Closed portfolio period token
- Simulate
Fees Order Type SimulateFeesOrderType- Simulate
Fees Side SimulateFeesSide