Getting a list of transactions
Getting your transaction history
The GET /transactions endpoint allow users to retrieve a list of all transaction history. To do this the user must have viewer as their API key role.
Query Parameters
The parameters can be use to filter and sort the data retrieval. Below are the parameters for this endpoint :
| Component | Type | Description |
|---|---|---|
| limit | number | Default at 200 |
| offset | number | Offset for pagination |
| transaction_id | string | The transaction id |
| source_id | string | The id of the source vault to filter by |
| source_address | string | The address of the source wallet to filter by |
| asset_id | string | The ID of the asset to filter by |
| network_id | string | The ID of the network to filter by |
| start_date | string | Start date of transaction records |
| end_date | string | End date of transaction records |
| transaction_type | enum | Type of transaction to filter by |
| destination_id | string | The id of the destination vault or whitelist to filter by |
| destination_address | string | The address of the destination wallet to filter by |
| status | enum | The transaction status |
Enumerated values are the predefined values that the variable can take. For example, "source_type" can only have values such as "vault", "external", "whitelist" and "network".
| Parameters | Possible Values |
|---|---|
| transaction_type | withdraw, rebalance, deposit, stake, claim, unstake, change pool |
| source_type | vault, external, whitelist, network |
| destination_type | vault, whitelist, network, stake pool, validator |
| status | pending, processing, confirming, completed, rejected, cancelled, failed |
Response
The response will state the detail of the transaction including :
| Component | Type | Description |
|---|---|---|
| transaction_id | string | The transaction id |
| timestamp | string | The retrieval of data at the time of request |
Each transaction will show the following details :
| Component | Type | Description |
|---|---|---|
| transaction_type | enum | Type of transaction |
| asset_id | string | Unique ID of asset (ie. ETH, BTC, ETH_ARB) |
| asset_name | string | Name of asset |
| network_id | string | ID of network (i.e. ETH, ) |
| network_name | string | Id of blockchain network (ie. Ethereum Mainnet) |
| amount | string | Amount of transaction |
| fee | string | Transaction fee |
Information of the source will include these four components :
| Component | Type | Description |
|---|---|---|
| source_type | string | Type of source |
| source_id | string | Id of source |
| source_name | string | Name of source |
| source_address | string | Wallet address of the source |
Information of the destination will include these four components :
| Component | Type | Description |
|---|---|---|
| destination_type | string | Type of destination |
| destination_id | string | Id of destination |
| destination_name | string | Name of destination |
| destination_address | string | Wallet address of the destination |
| memo | string | Memo for address types with memo/tag/note |
Details of the transaction will also include the following :
| Component | Type | Description |
|---|---|---|
| txn_hash | string | Transaction hash |
| blockexplorer_link | string | Link to the transaction on the blockexplorer |
| note | string | Transaction note |
| status | enum | Transaction status |
Example Response
{
"transactions": [
{
"transaction_id": "2301xse2...",
"timestamp": "2019-01-02T12:34:56.000Z",
"transaction": {
"transaction_type": "withdraw",
"asset_id": "BTC",
"asset_name": "Bitcoin",
"network_id": "BTC",
"network_name": "Bitcoin Network",
"amount": "1.02332",
"fee": "0.0023",
"source": {
"source_type": "vault",
"source_id": "3",
"source_name": "Long Term Vault",
"source_address": "2300slsdx2309"
},
"destination": {
"destination_type": "whitelist",
"destination_id": "xyz",
"destination_name": "Exchange wallet",
"destination_address": "23099upsj2",
"memo": ""
},
"txn_hash": "02391sdxw23sx2",
"blockexplorer_link": "https:/scan.io/tx/02391sdxw23sx2",
"note": "Withdraw to exchange wallet"
},
"status": "completed"
},
{
"transaction_id": "2205xse2...",
"timestamp": "2019-01-02T12:34:56.000Z",
"transaction": {
"transaction_type": "rebalance",
"asset_id": "ETH",
"asset_name": "Ethereum",
"network_id": "ETH",
"network_name": "Ethereum Mainnet",
"amount": "0.2332",
"fee": "0.0023",
"source": {
"source_type": "vault",
"source_id": "3",
"source_name": "Long Term Vault",
"source_address": "2300slsdx2309"
},
"destination": {
"destination_type": "vault",
"destination_id": "222",
"destination_name": "Short Term Vault",
"destination_address": "0xd231ls2...",
"memo": ""
},
"txn_hash": "02391sdxw23sx2",
"blockexplorer_link": "https:/etherscan.io/tx/02391sdxw23sx2",
"note": "Withdraw to exchange wallet"
},
"status": "completed"
},
{
"transaction_id": "2205xse2...",
"timestamp": "2019-01-02T12:34:56.000Z",
"transaction": {
"transaction_type": "deposit",
"asset_id": "XRP",
"asset_name": "XRP",
"network_id": "XRP",
"network_name": "Ripple",
"amount": "200.3214",
"fee": "0.0023",
"source": {
"source_type": "external",
"source_id": "",
"source_name": "",
"source_address": "2300slsdx2309"
},
"destination": {
"destination_type": "vault",
"destination_id": "3",
"destination_name": "Long Term Vault",
"destination_address": "0xd231ls2...",
"memo": "123"
},
"txn_hash": "02391sdxw23sx2",
"blockexplorer_link": "https:/etherscan.io/tx/02391sdxw23sx2",
"note": ""
},
"status": "completed"
},
{
"id": "2205xse2...",
"timestamp": "2019-01-02T12:34:56.000Z",
"transaction": {
"asset_id": "XRP",
"asset_name": "Ripple",
"network_id": "XRP",
"network_name": "Ripple",
"transaction_type": "withdraw",
"amount": "200.3214",
"fee": "0.0023",
"source": {
"source_type": "vault",
"vault_id": "12",
"source_name": "Long Term Vault",
"source_address": "2300slsdx2309"
},
"destination": {
"destination_type": "network",
"destination_id": "xyz",
"destination_name": "Counterparty Workspace - Profile Name",
"destination_address": "0xd231ls2...",
"memo": "123"
},
"txn_hash": "02391sdxw23sx2",
"blockexplorer_link": "https:/etherscan.io/tx/02391sdxw23sx2",
"note": ""
},
"status": "completed"
},
{
"id": "2205xse2...",
"timestamp": "2019-01-02T12:34:56.000Z",
"transaction": {
"transaction_type": "deposit",
"asset_id": "ADA",
"asset_name": "Cardano",
"network_id": "ADA",
"network_name": "Cardano Network",
"amount": "5000",
"fee": "0.02",
"source": {
"source_type": "vault",
"source_id": "42",
"source_name": "Long Term Vault",
"source_address": "2300slsdx2309"
},
"destination": {
"destination_type": "stakepool",
"destination_id": "xyz",
"destination_name": "Stake Pool Name",
"destination_address": "pool123sxa2",
"memo": ""
},
"txn_hash": "02391sdxw23sx2",
"blockexplorer_link": "https:/etherscan.io/tx/02391sdxw23sx2",
"note": ""
},
"status": "completed"
}
]
}Getting your transaction detail
To view a certain transaction, use the endpoint GET /transactions/{tx_id} to retrieve the details of it. To do this, input the transaction id into "transaction_id" in the parameter.
Path Parameters
| Component | Type | Description |
|---|---|---|
| transaction_id | string | Transaction ID to retrieve |
The format of response follows the same format as GET /transactions .
Example Response
{
"transactions": [
{
"transaction_id": "2301xse2...",
"timestamp": "2019-01-02T12:34:56.000Z",
"transaction": {
"transaction_type": "withdraw",
"asset_id": "BTC",
"asset_name": "Bitcoin",
"network_id": "BTC",
"network_name": "Bitcoin Network",
"amount": "1.02332",
"fee": "0.0023",
"source": {
"source_type": "vault",
"source_id": "3",
"source_name": "Long Term Vault",
"source_address": "2300slsdx2309"
},
"destination": {
"destination_type": "whitelist",
"destination_id": "xyz",
"destination_name": "Exchange wallet",
"destination_address": "23099upsj2",
"memo": ""
},
"txn_hash": "02391sdxw23sx2",
"blockexplorer_link": "https:/scan.io/tx/02391sdxw23sx2",
"note": "Withdraw to exchange wallet"
},
"status": "completed"
}
]
}Updated about 1 month ago