Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Transfer

List transfers

Returns deposits and withdrawals for a wallet. Transfers are sorted in descending order by height, then id. Transfers with rejected and pendingApproval states are excluded by default.

get/api/v2/{coin}/wallet/{walletId}/transfer

Path parameters

coinstring required

A cryptocurrency or token ticker symbol.

Example:btc
walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

The wallet ID.

Query parameters

allTokensboolean

Include data for all subtokens (i.e. ERC20 Tokens, Stellar Tokens)

dateGtestring date-time
Example:2025-01-01T00:00:00.000Z

Return transfers with a date that is greater than or equal to the given timestamp

dateLtstring date-time
Example:2025-03-28T00:00:00.000Z

Return transfers with a date that is less than the given timestamp

heightstring
Example:2000000

The block or ledger height

limitinteger

Maximum number of results to return. If the result set is truncated, use the nextBatchPrevId value to get the next batch.

prevIdstring
Example:59cd72485007a239fb00282ed480da1f

Return the next batch of results, based on the nextBatchPrevId value from the previous batch.

stateTransferState[]

The status of the transfer. • confirmed indicates the transaction is confirmed on chain. • failed indicates the transaction failed. initialized is the first state of a transaction and indicates the transaction is initialized. • pendingApproval indicates the transaction is initialized and pending approval. • rejected indicates the transaction was rejected by an approver. • removed indicates the transaction was reorganized from the mempool (it's still possible recieve confirmation in another block). • replaced indicates the transaction was replaced with a new transaction with higher fees. • signed indicates the transaction is signed and pending on-chain confirmation. • unconfirmed indicates the transaction is pending on-chain confirmation.

[
  "confirmed"
]
type'send' | 'receive'

Filter on sending or receiving Transfers

valueGteinteger

Return transfers with a value that is greater than or equal to the given number

valueLtinteger

Return transfers with a value that is less than the given number

sortBy'heightId' | 'id' | 'date'

Customize sort order for the transfers by specifying the sort key. Defaults to heightId. Use date to sort and paginate by creation time.

reverseboolean

True, if returning results in reverse order.

idstring
Example:59cd72485007a239fb00282ed480da1f

Filter for a transfer by one or more transfer ids

pendingApprovalIdstring
Example:59cd72485007a239fb00282ed480da1f

Filter for a transfer with a matching pendingApprovalId

addressAddressString3[]

Return transfers with elements in entries that have an address field set to this value

[
  "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS"
]
includeHexboolean

Include the raw hex data of the transaction in the response (this may be a large amount of data)

memoIdIntegerString[]

Return transfers with any of the payment identifiers in this array. Available for Stellar and EOS.

[
  "2000000"
]
includeRbfboolean

True, if including Replace-By-Fee (RBF) transfers.

includeOperationalboolean

Include operational transfers (channel opening/closing) in the response. Only applicable for Lightning wallets (lnbtc/tlnbtc).

Response

OK

coinstring required

A cryptocurrency or token ticker symbol.

nextBatchPrevIdstring uuid

When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the prevId query parameter.

Example response

{
  "transfers": [
    {
      "coin": "btc",
      "id": "59cd72485007a239fb00282ed480da1f",
      "wallet": "59cd72485007a239fb00282ed480da1f",
      "enterprise": "59cd72485007a239fb00282ed480da1f",
      "txid": "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26",
      "normalizedTxHash": "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26",
      "valueString": "2000000",
      "intendedValueString": "2000000",
      "baseValueString": "2000000",
      "baseValueWithoutFeesString": "2000000",
      "state": "confirmed",
      "tags": [
        "59cd72485007a239fb00282ed480da1f"
      ],
      "history": [
        {
          "user": "59cd72485007a239fb00282ed480da1f"
        }
      ],
      "consolidateId": "59cd72485007a239fb00282ed480da1f",
      "entries": [
        {
          "address": "2NAUwNgXaoFj2VVnSEvNLGuez8CfdU2UCMZ",
          "wallet": "59cd72485007a239fb00282ed480da1f",
          "valueString": "2000000",
          "token": "omg"
        }
      ],
      "inputs": [
        {
          "id": "003f688cc349f1fca8ac5ffa21671ca911b6ef351085c60733ed8c2ebf162cb8:2",
          "address": "2MsKxhhkDo5WaLaYRGA9Cr3iSQPyXsu6Fi2",
          "valueString": "2000000",
          "date": "2017-03-25T23:01:40.248Z",
          "wallet": "59cd72485007a239fb00282ed480da1f",
          "fromWallet": "59cd72485007a239fb00282ed480da1f",
          "redeemScript": "522102f1e990044d2a8be43d5b500bbdcb36277b97a4b07e01c5101ae8ec1568bfd6532103dab7dc82f2fc8c28200c1bdeca9c4cf181e0ca257395829cbd599395048afb57210205422e711827d8356f2fb75334d863941dd7eb45bd5788fa231dc5fa755135b653ae",
          "witnessScript": "52210351311cd81144e6cbdba561d24dfc22644cb02d053339d4beace03231b3be4f372103a8d0c1a375b9ee1a2411f9f8e18373be7f228b18260f63bbfca48809170ed08b2103c3bd8bd074657bbe9ee6714b31a4a54b6fd5b5cda0e1030122f9bf46b5034f6b53ae"
        }
      ],
      "outputs": [
        {
          "id": "003f688cc349f1fca8ac5ffa21671ca911b6ef351085c60733ed8c2ebf162cb8:2",
          "address": "2MsKxhhkDo5WaLaYRGA9Cr3iSQPyXsu6Fi2",
          "valueString": "2000000",
          "date": "2017-03-25T23:01:40.248Z",
          "wallet": "59cd72485007a239fb00282ed480da1f",
          "fromWallet": "59cd72485007a239fb00282ed480da1f",
          "redeemScript": "522102f1e990044d2a8be43d5b500bbdcb36277b97a4b07e01c5101ae8ec1568bfd6532103dab7dc82f2fc8c28200c1bdeca9c4cf181e0ca257395829cbd599395048afb57210205422e711827d8356f2fb75334d863941dd7eb45bd5788fa231dc5fa755135b653ae",
          "witnessScript": "52210351311cd81144e6cbdba561d24dfc22644cb02d053339d4beace03231b3be4f372103a8d0c1a375b9ee1a2411f9f8e18373be7f228b18260f63bbfca48809170ed08b2103c3bd8bd074657bbe9ee6714b31a4a54b6fd5b5cda0e1030122f9bf46b5034f6b53ae"
        }
      ]
    }
  ],
  "coin": "btc",
  "nextBatchPrevId": "585951a5df8380e0e3063e9f"
}