Account groups

An account group is the container your balances, trades and permissions hang off. It is the unit nearly every request is scoped to, and the reason accountGroupUuid appears throughout this documentation.

A group holds one account per currency. Your balances are per account, so a balance is always a balance in a currency, within a group — never a single figure across the relationship.

Why there may be more than one

An organisation is often served by several groups: separate desks or funds that should not see each other's balances, distinct mandates, or a settlement arrangement that has to be kept apart from trading activity.

If you have one group, you can largely ignore the concept. If you have several, treat the group as part of the address of every request — the same call against two groups is two different questions.

Permissions live on the group

Permissions are held per group, not per user, so the same credentials may be able to trade in one group and only read in another. A call that is refused against one group and accepted against another is doing what it should.

This is separate from the permissions on an API key. Both apply: the key says what that integration may attempt, and the group says what is permitted there.

Finding your groups

The account endpoint returns the groups available to your credentials, each with its uuid, its name, and its permissions. That uuid is what every other call expects; the name is a label for people and can change.