Get portfolio transactions
GET/1/private/portfolio/transactions
Retrieve the transaction history for a specified vault.
Request
Header Parameters
Possible values: >= 12 characters and <= 19 characters, Value must match regular expression (^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$|AA[A-Z0-9]{2} ?[A-Z0-9]{4} ?[A-Z0-9]{4} ?[A-Z0-9]{4})
Vault ID or Vault IIBAN
- application/json
Body
required
Nonce used in construction of API-Sign header
Continue paginating with a cursor
quote objectnullable
Quote amounts and fees in main transaction details in this currency (the quoting is a best effort job of getting the closest rate to the time of the transaction) by default the quoted fields are None
Quoting isn't always available when its not a None will be returned as well.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
Responses
- 200
Transactions retrieved.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- simple_order
- simple_order_failed
- simple_order_deposit_action
- dust_sweep
- funding
- funding_action
- trade
- transfer
- legacy_staking
- earn_allocation
- earn_deallocation
- earn_reward
- earn_auto_allocation
- custody_staking
- custody_unstaking
- custody_staking_reward
- custody_transfer
- simple_order
- transfer_peer_to_peer
- otc_trade
- bundle_trade
- user_account_transfer
- unknown
- deposit
- withdrawal
- other
- failed
- other
- failed
- spot
- earn
- legal_entities
- bundles
- unknown
- spot
- earn
- legal_entities
- bundles
- unknown
- ]
error object[]required
Possible values: [E, W]
API error severity.
result objectnullable
transactions object[]required
Transactions list
details object nullable
Transaction details
Possible values: [simple_order]
core objectrequired
Ptl-like transaction details
PTL quote id
Possible values: [unspecified, buy, sell, convert]
What type the trade is from the user's perspective
funding_fee objectnullable
Funding fee
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quoted_funding_fee objectnullable
Quoted funding fee
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
Possible values: [simple_order_failed]
core objectrequired
PtlFailed-like transaction details
receive_asset objectrequired
Receive asset
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
spend_asset objectrequired
Spend asset
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
Possible values: [unspecified, buy, sell, convert]
What type the trade is from the user's perspective
Possible values: [other, insufficient_funds, card_issue, user_account_issue]
Failure reason
Possible values: [simple_order_deposit_action]
core objectrequired
Simple order deposit action
Transaction reference
Funding reference
Possible values: [dust_sweep]
core objectrequired
Dust sweep-like transaction details
PTL quote id
How many spend assets were used
Possible values: [funding]
core objectrequired
Funding-like transaction details
Funding reference
state object required
State
deposit objectrequired
A state of a deposit
Possible values: [unspecified, settled, success, failure, returned]
Status
Possible values: [unspecified, held, returned]
Status details
Possible values: [unspecified, initial, pending, success, failure]
Possible values: [held, not_held]
Holding
Received time
Crypto (On-chain) transaction id
Possible values: [unspecified, verified, not_verified]
Address verification status
Address verification eligibility id
custody objectnullable
Custody details
RFC 3339 date time format. Some examples of this format":" 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00
task objectnullable
Details about a custody task
Underlying approval ID of the custody task
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^T[A-Z2-7]12[ACEGIKMOQSUWY246]$
Custody task ID. The task ID is deprecated in favor of the approval ID.
initiator objectnullable
Details about the task's initiator
Possible values: >= 14 characters and <= 42 characters
The user's identifying IIBAN
The user full name
Role that the custody user holds in the organization.
Possible values: [funding_action]
core objectrequired
Funding action-like transaction details
Funding transaction reference
Funding reference
Possible values: [trade]
core objectrequired
Trade details
Possible values: [unspecified, buy, sell]
Side/direction of the trade
Uses margin Note":" Only denotes if the SMV2 shorts wallet is used in the trade so it is only relevant for smv2
Possible values: [transfer]
core objectrequired
Transfer-like transaction details
Possible values: [unspecified, domain, spot_from_futures, spot_to_futures, vault_to_spot, spot_to_vault, vault_to_vault, vault_to_trading, trading_to_vault]
Subtype
custody objectnullable
Custody details
RFC 3339 date time format. Some examples of this format":" 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00
task objectnullable
Details about a custody task
Underlying approval ID of the custody task
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^T[A-Z2-7]12[ACEGIKMOQSUWY246]$
Custody task ID. The task ID is deprecated in favor of the approval ID.
initiator objectnullable
Details about the task's initiator
Possible values: >= 14 characters and <= 42 characters
The user's identifying IIBAN
The user full name
Role that the custody user holds in the organization.
Possible values: [legacy_staking]
core objectrequired
Legacy staking transaction details
Possible values: [unspecified, spot, staking]
Side
Possible values: [earn_allocation]
core objectrequired
Earn allocation transaction details
Strategy id
Request id
Possible values: [unspecified, in_progress, done]
Status of bonding
Possible values: [unspecified, flex, bonded, timed, instant, custody]
Lock type
Bonding seconds
Possible values: [earn_deallocation]
core objectrequired
Earn de-allocation transaction details
Strategy id
Request id
Possible values: [unspecified, in_progress, done]
Status of unbonding
Possible values: [unspecified, flex, bonded, timed, instant, custody]
Lock type
Unbonding seconds
Possible values: [earn_reward]
core objectrequired
Earn reward transaction details
Strategy id
Reward id
Possible values: [unspecified, airdrop, flex, bonded, timed, instant]
Reward info
Possible values: [earn_auto_allocation]
core objectrequired
Earn auto allocation transaction details
Strategy id
Possible values: [custody_staking]
core objectrequired
Custody un/staking transaction details
Strategy id
Request id
status object nullable
Status of un/bonding
string
Possible values: [unspecified, in_progress, done]
failed objectrequired
custody objectrequired
Custody details
RFC 3339 date time format. Some examples of this format":" 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00
task objectnullable
Details about a custody task
Underlying approval ID of the custody task
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^T[A-Z2-7]12[ACEGIKMOQSUWY246]$
Custody task ID. The task ID is deprecated in favor of the approval ID.
initiator objectnullable
Details about the task's initiator
Possible values: >= 14 characters and <= 42 characters
The user's identifying IIBAN
The user full name
Role that the custody user holds in the organization.
Possible values: [custody_unstaking]
core objectrequired
Custody un/staking transaction details
Strategy id
Request id
status object nullable
Status of un/bonding
string
Possible values: [unspecified, in_progress, done]
failed objectrequired
custody objectrequired
Custody details
RFC 3339 date time format. Some examples of this format":" 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00
task objectnullable
Details about a custody task
Underlying approval ID of the custody task
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^T[A-Z2-7]12[ACEGIKMOQSUWY246]$
Custody task ID. The task ID is deprecated in favor of the approval ID.
initiator objectnullable
Details about the task's initiator
Possible values: >= 14 characters and <= 42 characters
The user's identifying IIBAN
The user full name
Role that the custody user holds in the organization.
Possible values: [custody_staking_reward]
core objectrequired
Earn reward transaction details
Strategy id
Reward id
Possible values: [custody_transfer]
core objectrequired
Possible values: [unspecified, sent, received]
Side
Possible values: [unspecified, vault_to_spot, spot_to_vault]
Flow
Possible values: [unspecified, initial, pending, success, failed]
Status
Possible values: >= 14 characters and <= 42 characters
Source iban
Possible values: >= 14 characters and <= 42 characters
Destination iban
Crypto transaction id
max_on_chain_fee objectnullable
Max on chain fee (for crypto transfers)
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quoted_max_on_chain_fee objectnullable
Quoted max on chain fee (for crypto transfers)
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
custody objectnullable
Custody meta data
RFC 3339 date time format. Some examples of this format":" 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00
task objectnullable
Details about a custody task
Underlying approval ID of the custody task
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^T[A-Z2-7]12[ACEGIKMOQSUWY246]$
Custody task ID. The task ID is deprecated in favor of the approval ID.
initiator objectnullable
Details about the task's initiator
Possible values: >= 14 characters and <= 42 characters
The user's identifying IIBAN
The user full name
Role that the custody user holds in the organization.
Possible values: [bridge_simple_order]
core objectrequired
Simple order quote id
Bridge funding transaction id
Possible values: [unspecified, buy, sell, convert]
What type the trade is from the user's perspective (no actual trades here)
Possible values: [transfer_peer_to_peer]
core objectrequired
TransferPeerToPeer-like transaction details
Possible values: [unspecified, sent, received]
Side
Is cancellable
Possible values: [unspecified, in_progress, pending_email_verification, success, failed, cancelled, expired]
Status
metadata objectrequired
Metadata
Note
sender objectnullable
Sender
Iiban
Friendly name
recipient objectnullable
Recipient
Iiban
Friendly name
Possible values: [otc_trade]
core objectrequired
Unique OTC trade identifier
Trade ID associated with the settled OTC trade
Initiation time of the OTC trade
max_on_chain_fee objectnullable
Max on chain fee (for crypto transfers)
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quoted_max_on_chain_fee objectnullable
Quoted max on chain fee (for crypto transfers)
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
OTC trade exchange rate represented in terms of the quote asset
base objectrequired
The base asset of the OTC transaction
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quote objectrequired
The quote asset of the OTC transaction
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
Vault to trading ref id
Trading to vault ref id
custody objectnullable
Custody meta data
RFC 3339 date time format. Some examples of this format":" 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00
initiator objectnullable
Details about the transactions's initiator
Possible values: >= 14 characters and <= 42 characters
The user's identifying IIBAN
The user full name
Role that the custody user holds in the organization.
Possible values: [bundle_trade]
core objectrequired
Possible values: [unspecified, buy, sell]
Side/direction of the trade
Simple order bulk quote id
bundle objectrequired
Bundle details
Id
Name
Possible values: [user_account_transfer]
core objectrequired
Details for a user account transfer
Possible values: [unspecified, sent, received]
Side
metadata objectrequired
Metadata
Possible values: >= 16 characters and <= 19 characters
Counterparty
Possible values: [unknown]
Id
Time
Possible values: [unspecified, deposit, withdrawal, trade, margin, adjustment, rollover, credit, transfer, transfer_peer_to_peer, settle, dividend, nft_trade, reward, nft_creator_fee, nft_rebate, nft_airdrop, simple_order, simple_order_failed, simple_order_with_deposit, custom_simple_order, custom_simple_order_failed, custom_simple_order_with_deposit, recurring_simple_order, recurring_simple_order_failed, recurring_simple_order_with_deposit, reserved_fee, fee_sweep, fee_sweep_dlt, reward_sweep, reward_sweep_old, interest_sweep, conversion, dust_sweep, futures_transfer, custody_transfer, deposit_action, withdrawal_action, legacy_staking_allocation, legacy_staking_deallocation, legacy_staking_reward, earn_legacy_migration, block_trade, equity_trade, earn_staking_allocation, earn_staking_deallocation, earn_staking_auto_allocation, earn_staking_reward, earn_oir_allocation, earn_oir_deallocation, earn_oir_auto_allocation, earn_oir_reward, custody_staking, custody_unstaking, custody_staking_reward, ic_settlement, credit_rollover, interest, airdrop, earn_oir_auto_deallocation, earn_staking_auto_deallocation, simple_order_opposite_side, bridge_simple_order, bridge_deposit, simple_order_deposit_action, otc_buy, otc_sell, bundle_trade, equity_fee, corporate_action, earn_base_reward, earn_base_auto_allocation, earn_base_auto_deallocation, user_account_transfer]
Type
Possible values: [unspecified, deposit, withdrawal, transfer, trade, margin_trade, margin_rollover, margin_settle, earn, earn_rewards, simple_trading, nft, block_trade, credit, equity_trade, equity_dividend, reward_bonus, conversion, reward, custody, legacy_staking, legacy_staking_rewards, equity_fee, corporate_action, other]
Category
Possible values: [unspecified, funding, transfer, spot_margin, equity, earn, simple_trading, custody, staking, nft, other]
Area
Possible values: [unspecified, in_progress, successful, failed]
Status
Reference id 1
Reference id 2
spend objectnullable
Spend side
Ledger Id
Time
Possible values: [unspecified, domain, invite_bonus, welcome_bonus, bonus]
Subtype
amount objectrequired
Amount
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quoted_amount objectnullable
Quoted Amount
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
fee objectnullable
Fee
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quoted_fee objectnullable
Quoted Fee
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
total objectnullable
Total (total debit or credit including fees) only optional for backwards compatibility reasons
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quoted_total objectnullable
Quoted Total
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
balance objectnullable
Balance
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
wallet object nullable
Wallet information
Possible values: [spot]
Possible values: [main, shorts, unknown]
Possible values: [earn]
Possible values: [flexible, liquid, bonded, locked, closed, unknown]
Possible values: [legal_entities]
Possible values: [unknown]
Possible values: [bundles]
Possible values: [unknown]
receive objectnullable
Receive side
Ledger Id
Time
Possible values: [unspecified, domain, invite_bonus, welcome_bonus, bonus]
Subtype
amount objectrequired
Amount
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quoted_amount objectnullable
Quoted Amount
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
fee objectnullable
Fee
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quoted_fee objectnullable
Quoted Fee
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
total objectnullable
Total (total debit or credit including fees) only optional for backwards compatibility reasons
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
quoted_total objectnullable
Quoted Total
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
balance objectnullable
Balance
To be used as response value for Decimal amounts.
All result amounts will be expressed in units of this asset.
Possible values: [currency, volume, forex, equity, equity_pair, nft]
wallet object nullable
Wallet information
Possible values: [spot]
Possible values: [main, shorts, unknown]
Possible values: [earn]
Possible values: [flexible, liquid, bonded, locked, closed, unknown]
Possible values: [legal_entities]
Possible values: [unknown]
Possible values: [bundles]
Possible values: [unknown]
stats objectnullable
Cursor statistics
Transactions seen
Next cursor
{
"error": [
{
"severity": "E",
"errorClass": "string",
"type": "string",
"errorMessage": "string"
}
],
"result": {
"transactions": [
{
"details": {},
"id": "string",
"time": "string",
"type": "unspecified",
"category": "unspecified",
"area": "unspecified",
"status": "unspecified",
"ref_id": "string",
"ref_id2": "string",
"spend": {
"ledger_id": "string",
"time": "string",
"subtype": "unspecified",
"amount": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"quoted_amount": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"fee": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"quoted_fee": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"total": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"quoted_total": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"balance": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"wallet": {}
},
"receive": {
"ledger_id": "string",
"time": "string",
"subtype": "unspecified",
"amount": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"quoted_amount": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"fee": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"quoted_fee": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"total": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"quoted_total": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"balance": {
"amount": "string",
"asset": "string",
"class": "currency"
},
"wallet": {}
}
}
],
"stats": {
"transactions_seen": 0
},
"next_cursor": "string"
}
}