Class WebSocketClient

If true, this client will throw an error if it attempts to subscribe to an authenticated subscription.

• This is determined by whether or not the katanaperps.WebSocketClientOptions.auth auth property was provided during construction.

See

typedoc Reference Documentation

You can access the current WebSocket

See

typedoc Reference Documentation

A boolean indicating whether the WebSocket client is currently connected to the Katana Perps WebSocket API.

See

typedoc Reference Documentation

Connect to the Katana Perps WebSocket API

---

See

typedoc Reference Documentation

Disconnect from the WebSocket if connected.

• If terminate is true, the WebSocket will be disconnected immediately and this client will cease to work or connect.
  • All listeners will be cleared and all methods will throw errors once terminated.

See

typedoc Reference Documentation

Subscribe a handler to all WebSocket disconnect events.

• Calling multiple times will add multiple subscribers to the given event

---

Example

 websocketClient.onConnect(() => {
  console.warn('WebSocket Connection Connects')
 })
Copy

---

See

typedoc Reference Documentation

Subscribe a handler to all WebSocket disconnect events.

---

Example

 websocketClient.onDisconnect((code, reason) => {
  console.warn('WebSocket Connection Disconnects: ', code, reason)
 })
Copy

---

See

typedoc Reference Documentation

Subscribe a handler to all WebSocket connection errors that may occur during your requests.

• Note: These errors will be coming from the ws library itself and provide its ErrorEvent errors.
• Errors coming from the Katana Perps WebSocket client will be present as a katanaperps.KatanaPerpsErrorEvent KatanaPerpsErrorEvent message to the onMessage handler.

---

Example

 websocketClient.onError(errorEvent => {
  console.error('Connection Error on WebSocket: ', errorEvent.error)
 })
Copy

---

See

typedoc Reference Documentation

Subscribe a handler to all subscription responses.

• Your handler will receive updates when available matching the KatanaPerpsMessageEvent interface.
• Use the katanaperps.MessageEventType MessageEventType enum to get an enum defining all possible type values that can be received on the WebSocket message (see example).

---

Example

 import { MessageEventType } from '@katanaperps/katana-perps-sdk';

 // ... client setup

 websocketClient.onMessage(message => {
  console.log('Receiving Message: ', message)
  switch(message.type) {
    case MessageEventType.subscriptions:
      return handleSubscriptions(message.subscriptions);
    case MessageEventType.error:
     return handleAPIError(message.data);
    case MessageEventType.candles:
     return handleCandles(message.data);
    default:
       break;
  }
 })
Copy

---

See

• typedoc Reference Documentation
• enum katanaperps.MessageEventType MessageEventType
• type KatanaPerpsMessageEvent

Creates new authenticated subscriptions based on the provided parameters.

• Use the katanaperps.SubscriptionNameAuthenticated SubscriptionNameAuthenticated enum for IDE inline documentation and auto completion (see example)

---

Subscription Update Events:

• Receives a katanaperps.KatanaPerpsSubscriptionsListEvent KatanaPerpsSubscriptionsListEvent WebSocket response via the katanaperps.WebSocketClient.onMessage WebSocketClient.onMessage handler listing all active subscriptions.
• Begins receiving katanaperps.KatanaPerpsSubscriptionEvent KatanaPerpsSubscriptionEvent's for all subscribed subscriptions via the katanaperps.WebSocketClient.onMessage WebSocketClient.onMessage handler.

---

Throws

This method will throw an error if you did not provide the katanaperps.WebSocketClientOptionsWithAPIKey.auth auth option to the constructor in order to handle authenticated subscriptions.

---

Example

 import {
   WebSocketClient,
   SubscriptionNameAuthenticated,
 } from '@katanaperps/katana-perps-sdk';

 const client = new WebSocketClient({
   auth: {
     apiKey: '...',
     apiSecret: '...',
     wallet: '0x...'
   }
 })

 client.onMessage(message => {
   console.log('Received WebSocket Message: ', message)
 })

 await client.subscribeAuthenticated([
   { name: SubscriptionNameAuthenticated.positions },
   { name: SubscriptionNameAuthenticated.orders },
 ])
Copy

---

See

• typedoc Reference Documentation
• related client.subscribePublic

This method allows subscribing to Katana Perps's public subscriptions.

• Use the katanaperps.SubscriptionNamePublic SubscriptionNamePublic enum for IDE inline documentation and auto completion (see example)

---

Subscription Update Events:

• Receives a katanaperps.KatanaPerpsSubscriptionsListEvent KatanaPerpsSubscriptionsListEvent WebSocket response via the katanaperps.WebSocketClient.onMessage WebSocketClient.onMessage handler listing all active subscriptions.
• Begins receiving katanaperps.KatanaPerpsSubscriptionEvent KatanaPerpsSubscriptionEvent's for all subscribed subscriptions via the katanaperps.WebSocketClient.onMessage WebSocketClient.onMessage handler.

---

Example

 import {
   WebSocketClient,
   SubscriptionNamePublic,
   CandleInterval
 } from '@katanaperps/katana-perps-sdk';

 const client = new WebSocketClient();

 await client.subscribePublic([
   // will inherit markets from the markets array
   { name: SubscriptionNamePublic.tickers },
   // overrides the top level markets array with its own
   {
     name: SubscriptionNamePublic.candles,
     interval: CandleInterval.ONE_MINUTE,
     // replaces the top-level markets when provided
     markets: ['ETH-USD', 'BTC-USD'],
   },
 ], ['ETH-USD'])
Copy

---

See

• typedoc Reference Documentation
• related client.subscribeAuthenticated

Unsubscribes from a subscription or subscriptions

---

Subscription Update Events:

• Receives a katanaperps.KatanaPerpsSubscriptionsListEvent KatanaPerpsSubscriptionsListEvent WebSocket response via the katanaperps.WebSocketClient.onMessage WebSocketClient.onMessage handler listing all active subscriptions.

---

See

• typedoc Reference Documentation
• related WebSocketRequestUnsubscribeSubscription

List all active subscriptions

---

Subscription Update Events:

• Receives a katanaperps.KatanaPerpsSubscriptionsListEvent KatanaPerpsSubscriptionsListEvent WebSocket response via the katanaperps.WebSocketClient.onMessage WebSocketClient.onMessage handler listing all active subscriptions.

---

See

typedoc Reference Documentation

When a client is terminated, it will cease to function and a new WebSocketClient must be created to start a new connection.

WebSocket API client

You must provide constructor options that match either:

• If you only need public subscriptions, all options are optional.
• If you want to make authenticated subscriptions:
  • You must provide a valid WebSocketClientOptions.auth auth property in the constructor options which includes:
    • katanaperps.WebSocketClientAuthOptions.apiKey apiKey
    • katanaperps.WebSocketClientAuthOptions.apiSecret apiSecret
    • katanaperps.WebSocketClientAuthOptions.wallet wallet

Example

  import {
   WebSocketClient,
   SubscriptionNameAuthenticated,
   SubscriptionNamePublic
  } from '@katanaperps/katana-perps-sdk';

  const webSocketClientPublicOnly = new WebSocketClient();

  // or ... to enable both public and authenticated subscriptions:

  const client = new WebSocketClient({
   // Edit the values before for your environment
   auth: {
     apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
     apiSecret: 'axuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
     wallet: '0x...',
   }
   // sandbox: true,
   // logger: console.log
 });

 client.onConnect(() => {
   // [see onConnect docs for full example and information]
 })

 client.onDisconnect((code, reason) => {
   // [see onDisconnect docs for full example and information]
 })

 client.onError(errorEvent => {
   // [see onError docs for full example and information]
 })

 client.onMessage(message => {
  console.log('Receiving Message: ', message)
  switch(message.type) {
    case MessageEventType.subscriptions:
      return handleSubscriptions(message.subscriptions);
    case MessageEventType.error:
     return handleAPIError(message.data);
    case MessageEventType.candles:
     return handleCandles(message.data);
    default:
       break;
 })

 await client.connect();

// subscribe as needed!

 await client
   .subscribePublic([
     {
       name: SubscriptionNamePublic.tickers,
       markets: ['ETH-USD']
     },
  ])
  .subscribeAuthenticated([
     { name: SubscriptionNameAuthenticated.positions },
     { name: SubscriptionNameAuthenticated.orders },
  ]);
Copy

---

See

typedoc Reference Documentation