Account Data

This section describes the REST endpoints and corresponding TypeScript SDK methods for retrieving user account information, balances, positions, executions, and account statistics.

REST Endpoints

Resource	Endpoint
Root Account	`GET /api/v1/user/root-account`
Sub Accounts	`GET /api/v1/user/sub-accounts`
Positions	`GET /api/v1/position/list?sub_account_address=<address>`
Executions (Fills)	`GET /api/v1/execution/list?sub_account_address=<address>`
Account Balances	`GET /api/v1/account/balance`
Account Statistics	`GET /api/v1/account/statistics`

TypeScript SDK

Retrieve the authenticated user’s root account:

const rootAccount = await client.user.getRootAccount();

Retrieve all sub-accounts:

const subAccounts = await client.user.getSubAccounts();

Retrieve account balances:

const balances = await client.account.getBalance();

Retrieve positions:

const positions = await client.position.getPositionInfo({
  sub_account_address,
});

Retrieve execution history:

const executions = await client.trade.getTradeHistory({
  sub_account_address,
});

Retrieve account statistics:

const statistics = await client.account.getStatistics({
  sub_account_address,
});

Timestamp Fields

REST resources use Unix timestamps in milliseconds. Common timestamp fields include:

created_time
updated_time
timestamp_ms

Some legacy responses may still include the timestamp field for backward compatibility.

Overview

Getting Started

Setup

Fund Your Account

Market Data

Trade

Market Make

Account & Portfolio

Access Controls

Troubleshooting

RESTful API

WebSocket Guide

Websoket Reference (AsyncAPI)

REST Endpoints

TypeScript SDK

Timestamp Fields

​REST Endpoints

​TypeScript SDK

​Timestamp Fields

REST Endpoints

TypeScript SDK

Timestamp Fields