Returns a list of all websocket statuses for the account.
| Name | Description | Example |
|---|
| Name | Description | Type |
|---|---|---|
| statuses | The websocket statuses on the account. | array |
|
feed
|
The feed name for the connection. | string |
|
feed_connection_number
|
The connection number for this account within a feed. | integer |
|
ip
|
The IP address detected for the client connection. | string |
|
connected_on
|
The UTC time this client connection connected to the server. | string |
|
status_updated_on
|
The UTC time the server updated this client connection status data. | string |
|
is_delayed
|
Whether this connection is delayed an extra 15 minutes from the source. Note that the Delayed SIP source is already delayed, so this value will be false for those connections. | boolean |
|
is_firehose
|
The client connection is in firehose mode (all channels subscribed). | boolean |
|
trade_subscriptions
|
The count of channel subscriptions for trade events. | integer |
|
quote_subscriptions
|
The count of channel subscriptions for ask and bid events. | integer |
|
refresh_subscriptions
|
The count of channel subscriptions for refresh events (OPRA options feed only). | integer |
|
unusual_activity_subscriptions
|
The count of channel subscriptions for unusual activity events (OPRA options feed only). | integer |
|
packets_per_second
|
The packets per second sent since the last status update. | number |
|
total_packets_sent
|
The total packets sent since the beginning of this connection. A packet is a group of events sent as one message over the websocket. | string |
|
events_per_second
|
The events per second sent since the last status update. | number |
|
total_events
|
The total events sent to this connection's server-side queue since the beginning of this connection. An event is an individual occurrence of a trade, quote, etc. | string |
|
total_sent_events
|
The total events sent to the client inside packets. A packet is a group of events sent as one message over the websocket. | string |
|
total_drops
|
The total number of events dropped from the connection's server-side queue. Event drops happen when the connection's server-side queue is full. The server-side queue fills due to client-side connections not receiving packets fast enough, which can be caused by a slow network, or clients not decoupling processing of packets from the receipt of packets. | string |
|
queue_depth_percentage
|
The percentage that the connection's server-side queue is full. 0-100. | number |
| account | The account. | object |
|
email
|
The email address for the account. | string |
|
statuses
The websocket statuses on the account.
|
||
|
account
The account.
|
Back to Product Docs