Reading account groups
Listing the account groups a connection can trade for, and why an empty list is not an error frame.
The one request that answers "which account groups may this connection trade
for?". Send it after connecting and hold the result — accountGrpUuid on a
price subscription and on an
order is a uuid from this list.
An empty list is not an error frame. A failure to read your groups and a
genuine absence of them are the same message: accountGroups arrives empty,
with RFS100016 in code, and you cannot tell the two apart from the wire.
Treat it as "ask your desk", not as "retry until it works".
Request
Sent as messageType: "accountGroups". It carries nothing else — the groups are
resolved from the credential the socket authenticated with.
Not rate limited. The gateway's limiter keys only on subscribe and order.
| Field | Type | Required | Notes |
|---|---|---|---|
messageType | string | Required | Always accountGroups on this message. It is how the gateway picks the message type |
chanId | string | Set by the gateway to your connection identifier. Anything you send is discarded | |
authUserUUID | string | Set by the gateway from your credential. Anything you send is discarded |
Response
Sent as messageType: "accountGroups", once per request. Failures arrive on this
message rather than as an error frame.
| Field | Type | Notes |
|---|---|---|
messageType | string | Always accountGroups |
message | string | Please contact your desk support., set alongside code |
code | string | RFS100016 when accountGroups is empty, and absent otherwise. There is no success code |
accountGroups | AccountGroup[] | Your groups. Empty when there are none to return, for either reason |
chanId | string | The connection the message was delivered on, echoed from your request |
timestamp | integer | When the gateway produced this message, in milliseconds |
AccountGroup
| Field | Type | Notes |
|---|---|---|
uuid | string | What you send as accountGrpUuid on a subscription or an order |
name | string | The group's label, for display. Do not key anything on it |