List Groups | Helio Developer Portal

Return the account groups available when creating or updating trading accounts. Returns the complete list in a single response; the page/per_page/total fields on the response are always zero (reserved for future pagination).

Authorization

Authorization<token>

Bearer access token issued by the admin login flow.

In: header

Query Parameters

idarray<string>

namestring

currencystring

statusstring

Format: "uint64"

curl -X GET "https://example.com/account-groups?id=string&name=%3Cstring%3E&currency=%3Cstring%3E&status=%3Cstring%3E" \
  -H "Authorization: <token>"

A successful response.

{
  "groups": [
    {
      "id": "string",
      "marginCallLevel": 0.1,
      "stopOutLevel": 0.1,
      "description": "string",
      "name": "string",
      "negativeBalanceProtect": true,
      "status": "TRADE_STATUS_UNSPECIFIED",
      "externalGatewayId": "string",
      "swapFree": true,
      "isDemo": true,
      "symbolProfileId": "string",
      "marginCalculationType": "MARGIN_CALC_TYPE_UNSPECIFIED",
      "marginRecalcScope": "MARGIN_RECALC_SCOPE_UNSPECIFIED",
      "fundingProfileId": "string",
      "statementHeading": "string"
    }
  ],
  "page": "string",
  "perPage": "string",
  "total": "string"
}

List GroupsGET

Authorization

Query Parameters

Response