Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Transfers

List transfers

Permissions required: Transfer funds

List all transfers created by your API key.

Filters

You may optionally supply the following filters:

  • Set a date range by providing the startDate and/or endDate query parameters. If the date parameters are omitted, all transfers will be returned.
  • Specify a specific vault to return transfers for by specifying the vaultId parameter. If the vaultId parameter is omitted, transfers originating from all vaults will be returned. Providing both vaultId and walletId filters will result in an error.
  • Specify a specific wallet to return transfers for by specifying the walletId parameter. If the walletId parameter is omitted, transfers originating from all vaults and wallets will be returned. Providing both vaultId and walletId filters will result in an error.
  • Filter transfers of one or more statuses with the statuses parameter. Multiple statuses should be separated by commas.

Multiple Transfers

To fetch a specific batch of transfers, pass a comma-separated list of transferIds as the transferIds query parameter.

get/transfers

Query parameters

vaultIdstring

The ID of a vault. If provided, only transfers originating from this vault will be returned.

walletIdstring

The ID of a wallet. If provided, only transfers originating from this wallet will be returned.

transferIdsstring[]

A list of transferIds to return. Invalid transferIds will be ignored.

startDatestring date

The start date (inclusive) in YYYY-MM-DD format. The earliest valid start date is '2017-01-01`. Dates are always in UTC RFC 3339 'full-date'.

endDatestring date

The end date (inclusive) in YYYY-MM-DD format. The latest valid end date is the current date. Dates are always in UTC RFC 3339 'full-date'.

afterIdstring

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

limitinteger

Maximum number of results to return per query

statusesstring[]

One or more transfer statuses to filter results

Response

A list of transfers.

Example response

{
  "data": [
    {
      "transferId": "008d3ec72558ce907571886df63ef51594b5bd8cf106a0b7fa8f12a30dfc867f",
      "amount": {
        "quantity": "1000.00000000",
        "assetType": "USDC",
        "currentPrice": "1.00",
        "currentUSDValue": "1000.00"
      },
      "fee": {
        "quantity": "0.0002207155625",
        "assetType": "ETH"
      },
      "assetType": "USDC",
      "source": {
        "id": "1c920f4241b78a1d483a29f3c24b6c4c",
        "type": "WALLET"
      },
      "destination": {
        "id": "55e89d4a644d736b01533a2ea9b32a20",
        "type": "WALLET"
      },
      "transferMemo": "Internal ID: #12838927347",
      "status": "COMPLETED",
      "createdAt": "2019-01-02T12:34:56.000Z",
      "endedAt": "2019-01-03T12:34:56.000Z"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}