Type alias WebSocketClientOptions

WebSocket API client options

You must provide options that match either:

• To make public subscriptions, all options are optional.
• To make authenticated subscriptions:
  • you must provide a valid auth property in the constructor options which includes:
    • apiKey
    • apiSecret
    • wallet

Example

  import { WebSocketClient } from '@idexio/idex-sdk';

  // all options are optional for public only clients
  const webSocketClientPublicOnly = new WebSocketClient();

  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
 });
Copy

---

See

• docs WebSocket API Documentation
• related WebSocketClientOptionsWithAPIKey
• related WebSocketClientOptionsPublicOnly