Accounts API
The Accounts API provides user and account management capabilities for partners managing retail traders.
Partner APIThis API is primarily used by partners who are building trading platforms for retail users. Direct trading partners typically donβt need these endpoints.
Endpoints
| Method | Endpoint | Description |
|---|
GET | /v1/accounts/whoami | Get current user info |
GET | /v1/accounts | List accounts |
POST | /v1/accounts | Create account |
GET | /v1/accounts/{id} | Get account details |
Account Hierarchy
Partner (Firm)
βββ Users
βββ Accounts
βββ Positions & Orders
- Firm: Your partner organization
- Users: Individual retail traders on your platform
- Accounts: Trading accounts belonging to users
User vs Account
| Entity | Description |
|---|
| User | A person with identity (KYC verified) |
| Account | A trading account with balances and positions |
A user can have multiple accounts (e.g., for different strategies or purposes).
Common Use Cases
- User onboarding - Create accounts for new users after KYC
- Account lookup - Get account details for display
- Multi-account management - List and manage user accounts