Katana Perps 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

KatanaPerps - Associate Wallet

RestAuthenticatedClient RestRequestAssociateWallet RestResponseAssociateWallet KatanaPerpsWallet

KatanaPerps - Authorize Payout

RestAuthenticatedClient PayoutProgram KatanaPerpsPayoutDistribution RestRequestAuthorizePayout KatanaPerpsPayoutProgramAuthorization RestResponseAuthorizePayout

KatanaPerps - Cancel Order

RestAuthenticatedClient RestRequestCancelOrdersByWallet RestRequestCancelOrdersByOrderIds RestRequestCancelOrdersByMarket RestRequestCancelOrdersByDelegatedKey RestRequestCancelOrders KatanaPerpsCanceledOrder RestResponseCancelOrders

KatanaPerps - Create Order

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

KatanaPerps - Get Candles

RestPublicClient WebSocketClient CandleInterval RestRequestGetCandles KatanaPerpsCandle RestResponseGetCandles KatanaPerpsSubscribeCandles KatanaPerpsCandleEvent KatanaPerpsCandleEventData

KatanaPerps - Get Deposits

RestAuthenticatedClient WebSocketClient RestRequestGetDeposit RestRequestGetDeposits KatanaPerpsDeposit RestResponseGetDeposit RestResponseGetDeposits KatanaPerpsSubscribeDeposits KatanaPerpsDepositEvent KatanaPerpsDepositEventData

KatanaPerps - Get Exchange

RestPublicClient KatanaPerpsExchange RestResponseGetExchange

KatanaPerps - Get Fills

RestAuthenticatedClient RestRequestGetFill RestRequestGetFills KatanaPerpsFill RestResponseGetFill RestResponseGetFills

KatanaPerps - Get Funding Payments

RestAuthenticatedClient WebSocketClient RestRequestGetFundingPayments KatanaPerpsFundingPayment RestResponseGetFundingPayments KatanaPerpsSubscribeFundingPayments KatanaPerpsFundingPaymentEvent

KatanaPerps - Get Funding Rate Samples

RestRequestGetFundingRateSamples KatanaPerpsFundingRateSample RestResponseGetFundingRateSamples

KatanaPerps - Get Funding Rates

RestPublicClient RestRequestGetFundingRates KatanaPerpsFundingRate RestResponseGetFundingRates

KatanaPerps - Get Gas Fees

RestPublicClient KatanaPerpsGasFees RestResponseGetGasFees

KatanaPerps - Get Historical PnL

RestAuthenticatedClient RestRequestGetHistoricalPnL KatanaPerpsHistoricalProfitLoss RestResponseGetHistoricalPnL

KatanaPerps - Get Initial Margin Fraction override

RestRequestGetInitialMarginFractionOverride RestResponseGetInitialMarginFractionOverride

KatanaPerps - Get Liquidations

RestPublicClient WebSocketClient RestRequestGetLiquidations KatanaPerpsLiquidation RestResponseGetLiquidations KatanaPerpsSubscribeLiquidations KatanaPerpsLiquidationEvent KatanaPerpsLiquidationEventData

KatanaPerps - Get Market Maker Rewards Epochs

RestAuthenticatedClient RestRequestGetMarketMakerRewardsEpochWithoutWallet RestRequestGetMarketMakerRewardsEpochWithWallet RestRequestGetMarketMakerRewardsEpoch RestRequestGetMarketMakerRewardsEpochs MarketMakerRewardsEpochMarketWithoutWallet MarketMakerRewardsEpochMarketWithWallet MarketMakerRewardsEpochMarket KatanaPerpsMarketMakerRewardsEpochSummary MarketMakerRewardsEpochDetailedWithoutWallet MarketMakerRewardsEpochDetailedWithWallet KatanaPerpsMarketMakerRewardsEpoch RestResponseGetMarketMakerRewardsEpoch RestResponseGetMarketMakerRewardsEpochs

KatanaPerps - Get Markets

RestPublicClient RestRequestGetMarkets KatanaPerpsMarket RestResponseGetMarkets

KatanaPerps - Get OrderBook

RestPublicClient WebSocketClient OrderBookPriceLevel RestRequestGetOrderBookLevel1 RestRequestGetOrderBookLevel2 KatanaPerpsOrderBook RestResponseGetOrderBookLevel1 RestResponseGetOrderBookLevel2 KatanaPerpsSubscribeOrderBookLevel1 KatanaPerpsSubscribeOrderBookLevel2 KatanaPerpsOrderBookLevel1Event KatanaPerpsOrderBookLevel1EventData KatanaPerpsOrderBookLevel2Event KatanaPerpsOrderBookLevel2EventData

KatanaPerps - Get Orders

RestAuthenticatedClient WebSocketClient KatanaPerpsOrderFill RestRequestGetOrder RestRequestGetOrders KatanaPerpsOrder RestResponseGetOrder RestResponseGetOrders KatanaPerpsSubscribeOrders KatanaPerpsOrderEvent KatanaPerpsOrderEventDataSystemFill KatanaPerpsOrderEventDataGeneral KatanaPerpsOrderEventData KatanaPerpsOrderFillEventDataSystem KatanaPerpsOrderFillEventDataGeneral KatanaPerpsOrderFillEventData

KatanaPerps - Get Payouts

RestAuthenticatedClient PayoutProgram RestRequestGetPayouts KatanaPerpsPayoutProgram RestResponseGetPayouts

KatanaPerps - Get Ping

RestPublicClient RestResponseGetPing

KatanaPerps - Get Positions

RestAuthenticatedClient WebSocketClient RestRequestGetPositions KatanaPerpsPosition RestResponseGetPositions KatanaPerpsSubscribePositions KatanaPerpsPositionEvent KatanaPerpsPositionEventData

KatanaPerps - Get Tickers

RestPublicClient WebSocketClient RestRequestGetTickers KatanaPerpsTicker RestResponseGetTickers KatanaPerpsSubscribeTickers KatanaPerpsTickerEvent

KatanaPerps - Get Time

RestPublicClient RestResponseGetTime

KatanaPerps - Get Trades

RestPublicClient WebSocketClient RestRequestGetTrades KatanaPerpsTrade RestResponseGetTrades KatanaPerpsSubscribeTrades KatanaPerpsTradeEvent KatanaPerpsTradeEventData

KatanaPerps - Get Wallets

RestAuthenticatedClient RestRequestGetWallets KatanaPerpsWallet RestResponseGetWallets

KatanaPerps - Get WebSocket Token

RestAuthenticatedClient RestRequestGetAuthenticationToken KatanaPerpsWebSocketToken RestResponseGetAuthenticationToken

KatanaPerps - Get Withdrawals

RestAuthenticatedClient WebSocketClient RestRequestGetWithdrawal RestRequestGetWithdrawals KatanaPerpsWithdrawal RestResponseGetWithdrawal RestResponseGetWithdrawals RestRequestGetWithdrawalFromManagedAccount RestRequestGetWithdrawalsFromManagedAccount KatanaPerpsWithdrawalFromManagedAccount RestResponseGetWithdrawalFromManagedAccount RestResponseGetWithdrawalsFromManagedAccount KatanaPerpsSubscribeWithdrawals KatanaPerpsWithdrawalEvent KatanaPerpsWithdrawalEventData

KatanaPerps - Withdraw Funds

RestAuthenticatedClient KatanaPerpsWithdrawal KatanaPerpsWithdrawalFromManagedAccount RestRequestWithdrawFundsSDK RestRequestWithdrawFunds RestRequestWithdrawFundsSigned RestResponseWithdrawFunds RestRequestWithdrawFundsFromManagedAccountByQuantitySDK RestRequestWithdrawFundsFromManagedAccountByQuantity RestRequestWithdrawFundsFromManagedAccountByQuantitySigned RestResponseWithdrawFundsFromManagedAccountByQuantity RestRequestWithdrawFundsFromManagedAccountBySharesSDK RestRequestWithdrawFundsFromManagedAccountByShares RestRequestWithdrawFundsFromManagedAccountBySharesSigned RestResponseWithdrawFundsFromManagedAccountByShares

KatanaPerps Interfaces

KatanaPerpsCanceledOrder KatanaPerpsWebSocketToken KatanaPerpsCandle KatanaPerpsDeposit KatanaPerpsExchange KatanaPerpsFill KatanaPerpsOrderFill KatanaPerpsFundingPayment KatanaPerpsFundingRateSample KatanaPerpsFundingRate KatanaPerpsGasFees KatanaPerpsHistoricalProfitLoss KatanaPerpsLiquidation KatanaPerpsMarketMakerRewardsEpoch KatanaPerpsMarket KatanaPerpsOrderBook KatanaPerpsOrder KatanaPerpsPosition KatanaPerpsTicker KatanaPerpsTrade KatanaPerpsWallet KatanaPerpsWithdrawal KatanaPerpsWithdrawalFromManagedAccount

Stargate

BridgeConfig

Type - Utilities

Expand

WebSocket - Client Options

WebSocketClientOptionsPublicOnly WebSocketClientOptionsWithAPIKey WebSocketClientOptions

WebSocket - Message Types

KatanaPerpsCandleEvent KatanaPerpsCandleEventData KatanaPerpsDepositEvent KatanaPerpsDepositEventData KatanaPerpsFundingPaymentEvent KatanaPerpsFundingPaymentEventData KatanaPerpsLiquidationEvent KatanaPerpsLiquidationEventData KatanaPerpsOrderBookLevel1Event KatanaPerpsOrderBookLevel1EventData KatanaPerpsOrderBookLevel2Event KatanaPerpsOrderBookLevel2EventData KatanaPerpsOrderEvent KatanaPerpsOrderEventData KatanaPerpsPositionEvent KatanaPerpsPositionEventData KatanaPerpsTickerEvent KatanaPerpsTickerEventData KatanaPerpsTradeEvent KatanaPerpsTradeEventData KatanaPerpsWithdrawalEvent KatanaPerpsWithdrawalEventData

WebSocket - Subscribe

SubscriptionNameAuthenticated SubscriptionNamePublic SubscriptionName WebSocketRequestSubscribe WebSocketRequestSubscribeStrictWithTopLevelMarkets WebSocketRequestSubscribeStrictWithoutTopLevelMarkets KatanaPerpsSubscribeTickers KatanaPerpsSubscribeCandles KatanaPerpsSubscribeTrades KatanaPerpsSubscribeLiquidations KatanaPerpsSubscribeOrderBookLevel1 KatanaPerpsSubscribeOrderBookLevel2 KatanaPerpsSubscribeOrders KatanaPerpsSubscribeDeposits KatanaPerpsSubscribeWithdrawals KatanaPerpsSubscribePositions KatanaPerpsSubscribeFundingPayments KatanaPerpsSubscribeType KatanaPerpsSubscribeTypeAuthenticated KatanaPerpsSubscribeTypePublic

WebSocket - Unsubscribe

WebSocketRequestUnsubscribe WebSocketRequestUnsubscribeShortNames WebSocketRequestUnsubscribeSubscription

Base Types

RestRequestByWalletOptional RestRequestByWallet RestRequestByMarketOptional RestRequestByMarket RestRequestPagination RestRequestPaginationWithFromId RestRequestOrderBase GetOrderBookBase RestRequestWithdrawFundsBase RestRequestWithdrawFundsFromManagedAccountByQuantityBase RestRequestWithdrawFundsFromManagedAccountBySharesBase KatanaPerpsEventBase KatanaPerpsSubscriptionEventBase KatanaPerpsSubscribeAuthenticatedBase KatanaPerpsSubscribePublicBase KatanaPerpsOrderEventDataBase KatanaPerpsOrderFillEventDataBase

Other

EncodedDepositBridgeAdapterPayload depositViaBridge depositViaVaultComposerSync depositViaForwarder estimateDepositFees getBridgeTargetConfig DecodedWithdrawalBridgeAdapterPayload EncodedWithdrawalBridgeAdapterPayload decodeWithdrawalBridgeAdapterPayload encodeWithdrawalBridgeAdapterPayload getEncodedWithdrawalPayloadForBridgeTarget estimateBridgeWithdrawQuantity OrderBookRealTimeClientOptions WebSocketHandlerConnect WebSocketHandlerDisconnect WebSocketHandlerError WebSocketHandlerMessage PriceAndSize StandingOrder calculateInitialMarginFractionWithOverride convertToPositionBigInt calculateGrossFillQuantities determineMaximumReduceOnlyQuantityAvailableAtPriceLevel aggregateL2OrderBookAtTickSize adjustPriceToTickSize BridgeTarget FillTypeSystem FillTypeOrder ErrorShortCodes BestAvailablePriceLevels L1OrderBook L2OrderBook OrderBookFeesAndMinimums OrderBookLevelL1 OrderBookLevelL2 RestRequestOrderOfType RestRequestGetExchange WebSocketClientAuthOptions WebSocketRequestSubscribeStrict WebSocketRequestSubscriptionsList WebSocketRequest KatanaPerpsSubscriptionEvent KatanaPerpsErrorEvent KatanaPerpsSubscriptionsListEvent KatanaPerpsMessageEvent <internal>

Settings

Member Visibility

Theme