Digital Asset API

Manage digital assets, blockchain addresses, transactions, asset pools, screening, and more.

---

Asset

Get Single Asset

GET /api/v2/asset/{code}

Returns details for a specific asset by its code.

Parameter	Type	Required	Description
code	string	Yes	Asset code (e.g., USDC, BTC)

---

Create or Update Custom Asset

PUT /api/v2/asset

Create a new custom asset or update an existing one.

Field	Type	Required	Description
code	string	Yes	Asset identifier
name	string	Yes	Display name
type	string	Yes	Asset type
network	string	Yes	Blockchain network

---

Enable/Disable Asset Group

PATCH /api/v2/asset-group/{code}/state

Toggle all assets in an asset group on or off.

Parameter	Type	Required	Description
code	string	Yes	Asset group code
enabled	boolean	Yes	Enable or disable

---

Enable/Disable Single Asset

PATCH /api/v2/asset/{code}/state

Toggle a single asset on or off.

---

Update Asset Capabilities

PATCH /api/v2/asset/{code}/capabilities

Update the capabilities (deposit, withdrawal, etc.) for a specific asset.

---

List Asset Groups

GET /api/v2/asset-group

List all asset groups with their enabled assets.

---

Get Asset Group

GET /api/v2/asset-group/{code}

Get a single asset group by its code.

---

Address

Create Address

POST /api/v2/address

Create a new blockchain address within an asset pool.

Field	Type	Required	Description
assetPoolId	UUID	Yes	Target asset pool
network	string	Yes	Blockchain network (e.g., ETHEREUM, TRON)
asset	string	No	Specific asset for the address
label	string	No	Descriptive label

Response:

{
  "id": "addr-uuid",
  "address": "0x1234...abcd",
  "network": "ETHEREUM",
  "asset": "USDC",
  "assetPoolId": "pool-uuid",
  "status": "ACTIVE"
}

---

Validate Address

POST /api/v2/address/validate

Validate a blockchain address format for a specific network.

Field	Type	Required	Description
address	string	Yes	Blockchain address to validate
network	string	Yes	Target network

---

Get Address

GET /api/v2/address/{id}

Get details of a specific address by ID.

---

List Address Tags

GET /api/v2/address/{id}/tags

List tags associated with an address.

---

Get Point-in-Time Address Balance

GET /api/v2/address/{id}/balances

Get historical balance for an address at a specific point in time.

Query	Type	Description
timestamp	ISO 8601	Point-in-time for balance snapshot

---

List Addresses

GET /api/v2/address

List all addresses with optional filters.

Query	Type	Description
assetPoolId	UUID	Filter by asset pool
network	string	Filter by network
status	string	Filter by status
offset	number	Pagination offset
limit	number	Page size

---

Patch Address

PATCH /api/v2/address/{id}

Update address properties (e.g., label, status).

---

Create Addresses Synchronously

POST /api/v2/address/batch

Create addresses across all supporting networks in a single synchronous call.

---

Transaction

Claim Blockchain Transaction

POST /api/v2/transaction/{id}/claim

Claim an unassigned blockchain transaction to an address or asset pool.

---

List Transactions

GET /api/v2/transaction

List all transactions with filters.

Query	Type	Description
assetPoolId	UUID	Filter by asset pool
addressId	UUID	Filter by address
type	string	DEPOSIT, WITHDRAWAL
status	string	Transaction status
fromDate	ISO 8601	Start date
toDate	ISO 8601	End date
offset	number	Pagination offset
limit	number	Page size

---

Get Transaction

GET /api/v2/transaction/{id}

Get a specific transaction by ID.

---

Asset Pool

List Asset Pools

GET /api/v2/asset-pool

List all asset pools.

---

Create Asset Pool

POST /api/v2/asset-pool

Field	Type	Required	Description
name	string	Yes	Pool name
description	string	No	Description

---

Get Asset Pool

GET /api/v2/asset-pool/{id}

---

Delete Asset Pool

DELETE /api/v2/asset-pool/{id}

---

Update Asset Pool

PATCH /api/v2/asset-pool/{id}

---

Get Max Withdrawable Balance

GET /api/v2/asset-pool/{id}/max-withdrawable

Returns the maximum amount that can be withdrawn from the pool.

---

Get Asset Pool Summary

GET /api/v2/asset-pool/{id}/summary

Returns aggregated balances across all assets in the pool.

---

Get Point-in-Time Balances

GET /api/v2/asset-pool/{id}/balances

Historical balance snapshot for reconciliation.

Query	Type	Description
timestamp	ISO 8601	Point-in-time

---

Fee

Estimate Transaction Fee

POST /api/v2/fee/estimate

Estimate the network fee for a transaction before executing it.

Field	Type	Required	Description
network	string	Yes	Blockchain network
asset	string	Yes	Asset code
amount	number	Yes	Transaction amount
toAddress	string	No	Destination address

---

Screening

List Screening Results

GET /api/v2/screening

List all transaction screening results with filters.

Query	Type	Description
status	string	PASS, FLAG, BLOCK
transactionId	UUID	Filter by transaction
offset	number	Pagination offset
limit	number	Page size

---

Approve, Reject or Bypass Screening

PUT /api/v2/screening/{id}

Manually action a flagged transfer.

Field	Type	Required	Description
action	string	Yes	APPROVE, REJECT, or BYPASS
reason	string	No	Reason for the action

---

Key Pair

List Key Pairs

GET /api/v2/key-pair

List all cryptographic key pairs.

---

Create Key Pair

POST /api/v2/key-pair

Create a new key pair for custody operations.

---

Get Key Pair

GET /api/v2/key-pair/{id}

---

Patch Key Pair

PATCH /api/v2/key-pair/{id}

---

Staking

Create Staking Request

POST /api/v2/staking

Create a new staking request (e.g., stake TRX for energy).

Field	Type	Required	Description
network	string	Yes	Blockchain network
asset	string	Yes	Asset to stake
amount	number	Yes	Amount to stake
addressId	UUID	Yes	Source address

---

Return

Create Return Transaction Request

POST /api/v2/return

Create a request to return funds to the original sender.

Field	Type	Required	Description
transactionId	UUID	Yes	Original transaction ID
reason	string	No	Reason for return

---

Network

Get All Networks

GET /api/v2/network

Returns all supported blockchain networks and their configuration.

Response includes:

• Network name and code
• Supported assets
• Confirmation requirements
• Block time
• Status (active/maintenance)

---

Export

List Exports

GET /api/v2/export

List all export jobs.

---

Get Export with Download Link

GET /api/v2/export/{id}

Get an export job with a download URL for the generated file.

---

Create Export Job

POST /api/v2/export

Create a new data export job (transactions, balances, etc.).

Field	Type	Required	Description
type	string	Yes	Export type
fromDate	ISO 8601	Yes	Start date
toDate	ISO 8601	Yes	End date
format	string	No	CSV or JSON (default: CSV)

---

Transaction Request

List Transaction Requests

GET /api/v2/transaction-request

List all transaction requests (withdrawal requests).

---

Create Transaction Request

POST /api/v2/transaction-request

Create a new withdrawal/transfer transaction request.

Field	Type	Required	Description
assetPoolId	UUID	Yes	Source asset pool
toAddress	string	Yes	Destination address
network	string	Yes	Blockchain network
asset	string	Yes	Asset code
amount	number	Yes	Amount to send
reference	string	No	Your reference

---

Get Transaction Request

GET /api/v2/transaction-request/{id}

---

Consolidation

Create Consolidation Request

POST /api/v2/consolidation

Create a request to consolidate funds from multiple addresses into a single address.

Field	Type	Required	Description
assetPoolId	UUID	Yes	Asset pool to consolidate
targetAddressId	UUID	Yes	Destination address
asset	string	Yes	Asset to consolidate