Skip to content
API reference/
/Accounts

Accounts

Account-related data and operations, such as checking balances.

Integral’s system connects to liquidity providers (LPs) and exchanges to retrieve balance data on behalf of brokers. This data is synchronized with Integral trading systems via active polling (every 15 seconds) or WebSockets for near real-time updates.

Operations

Get account balance

Request

Get account balances in a specific asset or all assets.

Security
SSO_TOKEN
Query
custodyOrgstring, <= 255 charactersrequired

Custody organization name

currencystring, <= 17 characters

Currency code. Omit this parameter to get balances for all currencies.

GET
/custody/v2/account/balances
JavaScript
const query = new URLSearchParams({
  custodyOrg: 'string',
  currency: 'string'
}).toString();

const resp = await fetch(
  `https://docs.fxinside.net/_mock/openapi/integral-api-reference/rest/custody/v2/account/balances?${query}`,
  {
    method: 'GET',
    headers: {
      SSO_TOKEN: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

Successful operation. If there are no balances, an empty array is returned.

Bodyapplication/json
custodyOrgstring, <= 255 characters

Custody organization ID associated with the balances.

Example:"CustodyOrgName"
customerOrgstring, <= 255 characters

Customer organization ID associated with the balances.

Example:"CustomerOrgName"
balancesArray of objects(balance)
Response
{
  "custodyOrg": "custodyOrgId",
  "customerOrg": "customerOrgId",
  "balances": [
    { … }
  ]
}