Skip to content

Interface: WsTopicRequest<TWSTopic extends string = string, TWSPayload = any> ​

Normalised internal format for a request (subscribe/unsubscribe/etc) on a topic, with optional parameters.

  • Topic: the topic this event is for
  • Payload: the parameters to include, optional. E.g. auth requires key + sign. Some topics allow configurable parameters.

Type Parameters ​

Type ParameterDefault type
TWSTopic extends stringstring
TWSPayloadany

Properties ​

PropertyTypeDescription
payload?TWSPayloadOptional product-specific subscription parameters. They are merged into legacy product subscription requests. For Global Derivatives, put channel parameters in the complete topic name; payload is not sent.
topicTWSTopic-

Built by Siebly. Open source SDKs for exchange APIs.