Skip to main content

​
Accounts API

The Accounts API provides trading account information for partners. Accounts are the containers for positions, balances, and order history.
Automatic Account CreationTrading accounts are created automatically when a user’s KYC verification is approved. There is no manual account creation endpoint. See KYC Verification for details on the user onboarding flow.

​
Endpoints

MethodEndpointDescription
GET/v1/accountsList trading accounts
For user identity information, see the Users API which provides GET /v1/whoami and GET /v1/users.

​
Account Hierarchy

Partner (Firm)
└── Users (created via KYC)
    └── Accounts (auto-provisioned)
        └── Positions & Orders
  • Firm: Your partner organization
  • Users: Individual retail traders (created when KYC is approved)
  • Accounts: Trading accounts (automatically provisioned with user)

​
List Accounts

Returns the trading accounts available to the authenticated user.

​
Request

GET /v1/accounts
Optional query parameter:
  • user - Filter by user ID

​
Response

{
  "accounts": [
    "firms/ISV-Participant-Acme/accounts/user-123-trading",
    "firms/ISV-Participant-Acme/accounts/user-456-trading"
  ],
  "displayNames": [
    "John's Trading Account",
    "Jane's Trading Account"
  ]
}

​
Response Fields

FieldTypeDescription
accountsarrayEP3 account identifiers
displayNamesarrayHuman-readable account names (parallel array)

​
User vs Account

EntityDescription
UserA person with identity (KYC verified). Created automatically on KYC approval.
AccountA trading account with balances and positions. Auto-provisioned with user.
A user can have multiple accounts for different purposes (e.g., separate trading strategies).