Skip to main content
GET
curl
The response body shown here is a static example, not live data. After you click Send, your live result appears in a separate panel headed 200 OK. The panel under the status-code tabs is a fixed sample from the spec — its field values (fees, prices, sizes, IDs, timestamps) are placeholders. Use Send, or call the endpoint, for current values.
Returns deposits, withdrawals, and transfers for the requesting account, newest-first. Each entry is an AccountTransferUpdate object. The matching engine rejects a withdrawal or transfer before it is persisted when either of the following conditions holds:
  • Non-positive amountamount must be strictly greater than zero.
  • Insufficient free collateralamount exceeds accountEquity − requiredMargin. The engine does not perform partial pulls; the entire request is rejected and account state is left unchanged.
No authentication header is required.

Query Parameters

address
string
required

Master Ethereum address for this API key (must match address from POST /createApiKey for the same key). Required on REST for account-scoped reads and for place/cancel. Invalid hex → 400; mismatch with key → 403.

20-byte EVM address as hex: optional 0x or 0X prefix and exactly 40 hexadecimal digits. API responses normalize to lowercase af after 0x.

Pattern: ^(0x|0X)?[0-9a-fA-F]{40}$
accountIndex
integer
default:0

Subaccount index (0–9) to scope the request to. Defaults to 0 (the primary account). Values above 9 → 400.

Required range: 0 <= x <= 9
limit
integer
default:1000

Maximum number of entries to return. Defaults to the cap.

Required range: 1 <= x <= 1000
from
integer<int64>

Start of the time window, filtering on createdAt (epoch microseconds, inclusive) — the same unit and field the response reports, so a createdAt read from one page is a valid bound for the next with no conversion.

Second- and millisecond-scale values are rejected with a 400 (the server requires at least 1e14). A millisecond bound read as microseconds would land in 1970 and quietly return nothing.

Required range: x >= 100000000000000
Example:

1785801600123456

to
integer<int64>

End of the time window, filtering on createdAt (epoch microseconds, inclusive) — the same unit and field the response reports, so a createdAt read from one page is a valid bound for the next with no conversion.

The bound closes over the whole microsecond it names, so page boundaries overlap by design — deduplicate by id when paging.

Second- and millisecond-scale values are rejected with a 400 (the server requires at least 1e14). A millisecond bound read as microseconds would land in 1970 and quietly return nothing.

Required range: x >= 100000000000000
Example:

1785801699001200

Response

List of account transfer updates (deposits, withdrawals, and transfers), newest-first.

accountTransferUpdates
object[]
required