v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Transactions

List transactions

Permissions required: Read vault activity

List all transactions for the vaults permissioned to your API key. You can retrieve metadata about your API key from the API Key endpoints.

NOTE: price and USD value information is recent but does not reflect real-time data.

Filters

You may optionally supply the following filters:

  • Set a date range by providing the startDate and/or endDate query parameters. The date refers to the end time of a transaction: when the transaction succeeded or failed. If the date parameters are omitted, all transactions will be returned.
  • Select transactions involving a specific vault by providing the vaultId parameter. If the vaultId parameter is omitted, transactions for all vaults for which your API key is permissioned will be returned.
  • Filter transactions of one or more types with the types parameter. Multiple types should be separated by commas.
  • Select transactions involving a specific wallet by providing the walletId parameter. If the walletId parameter is omitted, transactions for all vaults for which your API key is permissioned will be returned.
  • Filter transactions by the receiving address with the destinationAddress parameter.
get/transactions

Query parameters

vaultIdstring

The vault ID to get transactions for

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

typesstring[]

A comma-separated list of transaction types to return.

walletIdstring

An ID uniquely identifying an Anchorage Digital wallet

destinationAddressstring

The destination address on the transaction for which results will be returned

Response

A list of transactions

Example response

{
  "data": [
    {
      "amount": {
        "quantity": "10.45234733",
        "assetType": "BTC",
        "currentPrice": "9751.01",
        "currentUSDValue": "101920.94"
      },
      "assetType": "BTC",
      "blockchainTxId": "0xd7b99c44240ae5bdd7d2f8572358ee2a521c4d93b74c8fd3df6557ac9f02b008",
      "dateTime": "2019-01-02T12:34:56.000Z",
      "description": "Withdrawing to exchange",
      "extra": "Blockchain-specific details, such as memo in XLM",
      "fee": {
        "quantity": "10.45234733",
        "assetType": "BTC",
        "currentPrice": "9751.01",
        "currentUSDValue": "101920.94"
      },
      "id": "9d570c38a148a6e0b4facf1e0d8c27dd6eba48c41421be1ba8bb778cbeb1a4df",
      "transactionType": "WITHDRAW",
      "vaultId": "1c920f4241b78a1d483a29f3c24b6c4c",
      "vaultName": "Long Hold Vault",
      "walletId": "d24b424293c0d64c6194f52801b3d293"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}