Skip to content

Interface: WSAPIClientConfigurableOptions ​

Configurable options specific to only the REST-like WebsocketAPIClient

Properties ​

PropertyTypeDescription
attachEventListenersbooleanDefault: true Attach default event listeners, which will console log any high level events (opened/reconnecting/reconnected/etc). If you disable this, you should set your own event listeners on the embedded WS Client wsApiClient.getWSClient().on(....).
keepMarginListenTokenRefreshedbooleanDefault: true If true, the SDK will proactively refresh the margin listen token before it expires, to help ensure a more seamless experience for users who want to maintain a continuous user data stream connection in margin mode.
muteLatencyWarningbooleanDefault: false If true, suppress the latency warning when using HMAC/RSA keys, which require per-request signing and therefore may have higher latency than Ed25519 keys. This warning is only relevant if you are making WS API requests, and not relevant if you are only using the user data stream. If you are latency sensitive, consider using Ed25519 keys instead. For more information refer to the readme.
resubscribeUserDataStreamAfterReconnectbooleanDefault: true If requestSubscribeUserDataStream() was used, automatically resubscribe if reconnected
resubscribeUserDataStreamDelaySecondsnumberDefault: 2 seconds Delay automatic userdata resubscribe by x seconds.

Built by Siebly. Open source SDKs for exchange APIs.