Kuma SDK Reference

Index

API Clients

OrderBookRealTimeClient RestAuthenticatedClientOptions RestAuthenticatedClient RestPublicClientOptions RestPublicClient WebSocketClient WebSocketClientOptions

Enums - Request Parameters

CandleInterval TimeInForce OrderType OrderSide SelfTradePrevention PayoutProgram OrderBookRealTimeClientEvent SubscriptionNameAuthenticated SubscriptionNamePublic SubscriptionName

Enums - Response Properties

PositionSide FillType FillAction OrderStatus OrderStateChange MarketStatus TriggerType ChainTransactionStatus LiquidityProvider OrderBookLevelType PositionEventStatus MessageEventType

Kuma - Associate Wallet

RestAuthenticatedClient RestRequestAssociateWallet RestResponseAssociateWallet KumaWallet

Kuma - Authorize Payout

RestAuthenticatedClient PayoutProgram KumaPayoutDistribution RestRequestAuthorizePayout KumaPayoutProgramAuthorization RestResponseAuthorizePayout

Kuma - Cancel Order

RestAuthenticatedClient RestRequestCancelOrdersByWallet RestRequestCancelOrdersByOrderIds RestRequestCancelOrdersByMarket RestRequestCancelOrdersByDelegatedKey RestRequestCancelOrders KumaCanceledOrder RestResponseCancelOrders

Kuma - Create Order

RestAuthenticatedClient TimeInForce OrderType OrderSide SelfTradePrevention RestRequestOrderTypeLimit RestRequestOrderTypeLimitLPP RestRequestOrderTypeMarket RestRequestOrderTypeMarketLPP RestRequestOrderTypeStopLossMarket RestRequestOrderTypeStopLossLimit RestRequestOrderTypeTakeProfitMarket RestRequestOrderTypeTakeProfitLimit RestRequestOrderTypeTrailingStopMarket RestRequestOrder

Kuma - Get Candles

RestPublicClient WebSocketClient CandleInterval RestRequestGetCandles KumaCandle RestResponseGetCandles KumaSubscribeCandles KumaCandleEvent KumaCandleEventData

Kuma - Get Deposits

RestAuthenticatedClient WebSocketClient RestRequestGetDeposit RestRequestGetDeposits KumaDeposit RestResponseGetDeposit RestResponseGetDeposits KumaSubscribeDeposits KumaDepositEvent KumaDepositEventData

Kuma - Get Exchange

RestPublicClient KumaExchange RestResponseGetExchange

Kuma - Get Fills

RestAuthenticatedClient RestRequestGetFill RestRequestGetFills KumaFill RestResponseGetFill RestResponseGetFills

Kuma - Get Funding Payments

RestAuthenticatedClient WebSocketClient RestRequestGetFundingPayments KumaFundingPayment RestResponseGetFundingPayments KumaSubscribeFundingPayments KumaFundingPaymentEvent

Kuma - Get Funding Rates

RestPublicClient RestRequestGetFundingRates KumaFundingRate RestResponseGetFundingRates

Kuma - Get Gas Fees

RestPublicClient KumaGasFees RestResponseGetGasFees

Kuma - Get Historical PnL

RestAuthenticatedClient RestRequestGetHistoricalPnL KumaHistoricalProfitLoss RestResponseGetHistoricalPnL

Kuma - Get Initial Margin Fraction override

RestRequestGetInitialMarginFractionOverride RestResponseGetInitialMarginFractionOverride

Kuma - Get Liquidations

RestPublicClient WebSocketClient RestRequestGetLiquidations KumaLiquidation RestResponseGetLiquidations KumaSubscribeLiquidations KumaLiquidationEvent KumaLiquidationEventData

Kuma - Get Market Maker Rewards Epochs

RestAuthenticatedClient RestRequestGetMarketMakerRewardsEpochWithoutWallet RestRequestGetMarketMakerRewardsEpochWithWallet RestRequestGetMarketMakerRewardsEpoch RestRequestGetMarketMakerRewardsEpochs MarketMakerRewardsEpochMarketWithoutWallet MarketMakerRewardsEpochMarketWithWallet MarketMakerRewardsEpochMarket KumaMarketMakerRewardsEpochSummary MarketMakerRewardsEpochDetailedWithoutWallet MarketMakerRewardsEpochDetailedWithWallet KumaMarketMakerRewardsEpoch RestResponseGetMarketMakerRewardsEpoch RestResponseGetMarketMakerRewardsEpochs

Kuma - Get Markets

RestPublicClient RestRequestGetMarkets KumaMarket RestResponseGetMarkets

Kuma - Get OrderBook

RestPublicClient WebSocketClient OrderBookPriceLevel RestRequestGetOrderBookLevel1 RestRequestGetOrderBookLevel2 KumaOrderBook RestResponseGetOrderBookLevel1 RestResponseGetOrderBookLevel2 KumaSubscribeOrderBookLevel1 KumaSubscribeOrderBookLevel2 KumaOrderBookLevel1Event KumaOrderBookLevel1EventData KumaOrderBookLevel2Event KumaOrderBookLevel2EventData

Kuma - Get Orders

RestAuthenticatedClient WebSocketClient KumaOrderFill RestRequestGetOrder RestRequestGetOrders KumaOrder RestResponseGetOrder RestResponseGetOrders KumaSubscribeOrders KumaOrderEvent KumaOrderEventDataSystemFill KumaOrderEventDataGeneral KumaOrderEventData KumaOrderFillEventDataSystem KumaOrderFillEventDataGeneral KumaOrderFillEventData

Kuma - Get Payouts

RestAuthenticatedClient PayoutProgram RestRequestGetPayouts KumaPayoutProgram RestResponseGetPayouts

Kuma - Get Ping

RestPublicClient RestResponseGetPing

Kuma - Get Positions

RestAuthenticatedClient WebSocketClient RestRequestGetPositions KumaPosition RestResponseGetPositions KumaSubscribePositions KumaPositionEvent KumaPositionEventData

Kuma - Get Tickers

RestPublicClient WebSocketClient RestRequestGetTickers KumaTicker RestResponseGetTickers KumaSubscribeTickers KumaTickerEvent

Kuma - Get Time

RestPublicClient RestResponseGetTime

Kuma - Get Trades

RestPublicClient WebSocketClient RestRequestGetTrades KumaTrade RestResponseGetTrades KumaSubscribeTrades KumaTradeEvent KumaTradeEventData

Kuma - Get Wallets

RestAuthenticatedClient RestRequestGetWallets KumaWallet RestResponseGetWallets

Kuma - Get WebSocket Token

RestAuthenticatedClient RestRequestGetAuthenticationToken KumaWebSocketToken RestResponseGetAuthenticationToken

Kuma - Get Withdrawals

RestAuthenticatedClient WebSocketClient RestRequestGetWithdrawal RestRequestGetWithdrawals KumaWithdrawal RestResponseGetWithdrawal RestResponseGetWithdrawals RestRequestGetWithdrawalFromManagedAccount RestRequestGetWithdrawalsFromManagedAccount KumaWithdrawalFromManagedAccount RestResponseGetWithdrawalFromManagedAccount RestResponseGetWithdrawalsFromManagedAccount KumaSubscribeWithdrawals KumaWithdrawalEvent KumaWithdrawalEventData

Kuma - Withdraw Funds

RestAuthenticatedClient KumaWithdrawal KumaWithdrawalFromManagedAccount RestRequestWithdrawFundsSDK RestRequestWithdrawFunds RestRequestWithdrawFundsSigned RestResponseWithdrawFunds RestRequestWithdrawFundsFromManagedAccountByQuantitySDK RestRequestWithdrawFundsFromManagedAccountByQuantity RestRequestWithdrawFundsFromManagedAccountByQuantitySigned RestResponseWithdrawFundsFromManagedAccountByQuantity RestRequestWithdrawFundsFromManagedAccountBySharesSDK RestRequestWithdrawFundsFromManagedAccountByShares RestRequestWithdrawFundsFromManagedAccountBySharesSigned RestResponseWithdrawFundsFromManagedAccountByShares

Kuma Interfaces

KumaCanceledOrder KumaWebSocketToken KumaCandle KumaDeposit KumaExchange KumaFill KumaOrderFill KumaFundingPayment KumaFundingRate KumaGasFees KumaHistoricalProfitLoss KumaLiquidation KumaMarketMakerRewardsEpoch KumaMarket KumaOrderBook KumaOrder KumaPosition KumaTicker KumaTrade KumaWallet KumaWithdrawal KumaWithdrawalFromManagedAccount

Stargate

StargateV2Config

Type - Utilities

Expand

WebSocket - Client Options

WebSocketClientOptionsPublicOnly WebSocketClientOptionsWithAPIKey WebSocketClientOptions

WebSocket - Message Types

KumaCandleEvent KumaCandleEventData KumaDepositEvent KumaDepositEventData KumaFundingPaymentEvent KumaFundingPaymentEventData KumaLiquidationEvent KumaLiquidationEventData KumaOrderBookLevel1Event KumaOrderBookLevel1EventData KumaOrderBookLevel2Event KumaOrderBookLevel2EventData KumaOrderEvent KumaOrderEventData KumaPositionEvent KumaPositionEventData KumaTickerEvent KumaTickerEventData KumaTradeEvent KumaTradeEventData KumaWithdrawalEvent KumaWithdrawalEventData

WebSocket - Subscribe

SubscriptionNameAuthenticated SubscriptionNamePublic SubscriptionName WebSocketRequestSubscribe WebSocketRequestSubscribeStrictWithTopLevelMarkets WebSocketRequestSubscribeStrictWithoutTopLevelMarkets KumaSubscribeTickers KumaSubscribeCandles KumaSubscribeTrades KumaSubscribeLiquidations KumaSubscribeOrderBookLevel1 KumaSubscribeOrderBookLevel2 KumaSubscribeOrders KumaSubscribeDeposits KumaSubscribeWithdrawals KumaSubscribePositions KumaSubscribeFundingPayments KumaSubscribeType KumaSubscribeTypeAuthenticated KumaSubscribeTypePublic

WebSocket - Unsubscribe

WebSocketRequestUnsubscribe WebSocketRequestUnsubscribeShortNames WebSocketRequestUnsubscribeSubscription

Base Types

RestRequestByWalletOptional RestRequestByWallet RestRequestByMarketOptional RestRequestByMarket RestRequestPagination RestRequestPaginationWithFromId RestRequestOrderBase GetOrderBookBase RestRequestWithdrawFundsBase RestRequestWithdrawFundsFromManagedAccountByQuantityBase RestRequestWithdrawFundsFromManagedAccountBySharesBase KumaEventBase KumaSubscriptionEventBase KumaSubscribeAuthenticatedBase KumaSubscribePublicBase KumaOrderEventDataBase KumaOrderFillEventDataBase

Other

depositViaStargateV2 estimateDepositFees getStargateV2TargetConfig decodeStargateV2Payload encodeStargateV2Payload getEncodedWithdrawalPayloadForBridgeTarget estimateStargateV2WithdrawQuantity OrderBookRealTimeClientOptions WebSocketHandlerConnect WebSocketHandlerDisconnect WebSocketHandlerError WebSocketHandlerMessage PriceAndSize StandingOrder calculateInitialMarginFractionWithOverride convertToPositionBigInt calculateGrossFillQuantities determineMaximumReduceOnlyQuantityAvailableAtPriceLevel aggregateL2OrderBookAtTickSize adjustPriceToTickSize DecodedStargateV2Payload EncodedStargateV2Payload BridgeTarget FillTypeSystem FillTypeOrder ErrorShortCodes BestAvailablePriceLevels L1OrderBook L2OrderBook OrderBookFeesAndMinimums OrderBookLevelL1 OrderBookLevelL2 RestRequestOrderOfType RestRequestGetExchange WebSocketClientAuthOptions WebSocketRequestSubscribeStrict WebSocketRequestSubscriptionsList WebSocketRequest KumaSubscriptionEvent KumaErrorEvent KumaSubscriptionsListEvent KumaMessageEvent <internal>

Settings

Member Visibility

Theme