Skip to main content
GET
List portfolio transactions

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42

Query Parameters

page_token
string

Opaque token returned as next_page_token in the previous response. Omit to request the first page.

Required string length: 1 - 256
types
enum<string>[]

Filter by transaction type.

Category of portfolio transaction. swap and price_trigger_swap represent both successful executions and failed execution attempts; use status to distinguish them. deposit and withdrawal represent incoming and outgoing funding transactions, respectively. transfer represents both transfers between accounts and movements between an account's spot and futures balances.

Available options:
swap,
price_trigger_swap,
earn_reward,
deposit,
withdrawal,
transfer,
recurring_swap
page_size
integer<int32>
default:20

Maximum number of results to return. Ignored when page_token is present.

Required range: 1 <= x <= 25
assets
object[]

Filter transactions by specific assets.

start_timestamp
string<date-time>

Lower bound of the transaction timestamp filter. RFC 3339 timestamp.

end_timestamp
string<date-time>

Upper bound of the transaction timestamp filter. RFC 3339 timestamp.

statuses
enum<string>[]

Filter transactions by lifecycle status. When polling a newly created transfer or withdrawal through completion, omit this filter or provide an empty array so both in_progress and the terminal successful or failed status can be observed. Filtering only by in_progress discovers pending transactions but excludes terminal results; remove or change that filter before polling for completion.

Lifecycle statuses available to filter transactions.

Available options:
in_progress,
successful,
failed
ids
string[]

Filter transactions by specific transaction IDs.

sort_direction
enum<string>
default:desc

Sort order for transaction results by timestamp.

Available options:
asc,
desc
quote_symbol
string

Asset to use for quoting amounts and fees in the response. Quoting is best-effort based on rates at transaction time. If not provided or if quoting is unavailable, quoted fields will be null.

Required string length: 1 - 16
quote_type
enum<string>
default:fiat

Quote asset classification. Supports fiat and stablecoin.

Available options:
fiat,
stablecoin
references
object[]

Filter by originating references. Entries are ORed together and combined with types and other filters using AND semantics. Reference kind selects the originating system namespace. For a deposit or withdrawal, use kind=funding and the originating funding identifier. For a transfer, use kind=transfer and the transfer_id returned by POST /v1/transfers or an accepted POST /v1/accounts/{account_id}/transfers/derivatives request. Reference identifiers are distinct from the TX identifiers accepted by ids.

Response

Successful response

data
object[]
required

List of portfolio transactions matching the query parameters. Always present; serialized as an empty array when no transactions match.

quote_symbol
string
required

The asset used as the quote currency for all amount_in_quote fields. Present only when quote_symbol was requested.

quote_type
enum<string>
default:fiat
required

Quote asset classification. Supports fiat and stablecoin.

Available options:
fiat,
stablecoin
next_page_token
string

Opaque token for retrieving the next page. Absent when there are no more results.

Required string length: 1 - 256