Vaults

Export Vaults With Assets Async

Changed on

Get a CSV-format list of balances of all vaults and their assets.

get/api/v1/vaults/export_async

Request

  • Base URL: https://api.fordefi.com
  • URL: https://api.fordefi.com/api/v1/vaults/export_async
  • Auth: HTTP bearer

Query parameters

limitinteger

The number of vault/asset pairs to export, unlimited if not set.

vaults_idsstring[]

Vault IDs to filter on.

vault_typesVaultType[]

Vault types to filter on.

chainsstring[]

List of chains to filter by. If empty, all chains will be included.

asset_idsstring[]

List of vault asset IDs to filter on.

vault_group_idsstring[]

List of vault group IDs to filter on. Filter applies to current and pending vault groups.

vault_statesVaultState[]

List of vault states to filter on.

searchstring

Free-text search on vault name or address.

hide_emptyboolean

If True, only vaults with assets will be exported. If False, all vaults will be exported.

Response

Successful Response

idstring uuid required

ID of the export.

creation_timestring date-time required

The date and time when the object was created.

type'csv' | 'zip' required
state'created' | 'in_progress' | 'aborted' | 'ready' | 'error' required
organization_idstring uuid required

The id of the organization.

user_idstring required

The id of the user.

resource_type'transaction' | 'backup_snapshot' | 'vault' required
successful_items_countinteger required

The number of items that were successfully exported.

failed_items_countinteger required

The number of items that failed to be exported.

total_items_countinteger required

The total number of items to be exported.

request_idstring required

The request id of the export.

download_urlstring required

The download url of the export.

expiration_timestring date-time required

The date and time when the object will expire.

Changes