SDKs
JavaScript/Typescript
User Methods
Accounts
Groups

Account Groups

An account in TradrAPI will belong to 3 separate groups:

  • User Group - Assigns general account settings
  • Spread Group - Assigns the spread settings to all trades made by the account and all prices seen by the account.
  • Commission Group - Assigns the commission rates to all trades made by the account.

These groups exist for all accounts irrelevant of the trading platform on which they exist, however some trading platforms may generalise these groups into a single group. In such cases TradrAPI still maintains the same contract of having 3 groups for each account however all 3 groups will essentially be the same.

Get Commission Group

Get the commission group associated with a given account. The commission group is used to determine the commission rates that will be applied to trades made in the account.

Example

import { CommissionGroup } from '@tradrapi/trading-sdk';
 
const account: CommissionGroup = await tradrApi.accounts.getCommissionGroup(101000123);

Response

The CommissionGroup object contains the following properties:

interface CommissionGroup {
  /** The ID of the commission group on the trading platform */
  exchangeGroupId: string;
  /** The name of the commission group */
  name: string;
  /** The currency which the group belongs to */
  currency: string;
}