get_account
Retrieve account balances, connected exchanges, global variables, or supported exchanges from your Gainium account.
Instructions
Get account information: balances, connected exchanges, global variables, or supported exchanges.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| info | Yes | Information type. balances: account balances. exchanges: connected exchanges. globalVariables: user variables. supportedExchanges: API supports. | |
| fields | No | Field selection: preset ("minimal", "standard", "extended", "full") or comma-separated fields (e.g. "_id,uuid,settings.name,profit.total"). Default: "standard" | |
| page | No | Page number for pagination (1-based). Default: 1 | |
| paperContext | No | Paper trading context (true = paper, false = real). Default: false | |
| exchangeId | No | Filter by exchange ID (balances only) | |
| asset | No | Filter by single asset (balances only) | |
| assets | No | Filter by multiple assets (balances only). Use asset OR assets, not both. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | OK on success, NOTOK on a handled API error. | |
| reason | No | Error reason when status is NOTOK; null otherwise. | |
| data | No | Account information for the requested type: balances, connected exchanges, global variables, or supported exchanges (array or object depending on `info`). | |
| meta | No | Pagination / result metadata, present on list-style responses. |