List transfers

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

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.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: "btc"
  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • allTokensboolean
    Include data for all subtokens (i.e. ERC20 Tokens, Stellar Tokens)
  • dateGtestring(date-time)
    Return transfers with a "date" that is greater than or equal to the given timestamp
  • dateLtstring(date-time)
    Return transfers with a "date" that is less than the given timestamp
  • heightstring
    The block or ledger height
    Example: "2000000"
    Pattern: ^-?\d+$
  • limitintegerDefault: 25
    Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.
  • statestring
    The status of this Transfer
    Example: "confirmed"
    Enum: signedunconfirmedconfirmedpendingApprovalremovedfailedrejected
  • typestring
    Filter on sending or receiving "Transfers"
    Enum: sendreceive
  • 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
  • addressarray
    Return transfers with elements in "entries" that have an "address" field set to this value
  • includeHexboolean
    Include the raw hex data of the transaction in the response (this may be a large amount of data)
  • memoIdarray
    Return transfers with any of the payment identifiers in this array. Available for Stellar and EOS.

200 Response

transfers array[object] required
txid string required
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
height integer required
The height of the block this Transfer was confirmed in (999999999 if unconfirmed)
heightId string
The unique height id of the block
date string <date-time>required
The date this Transfer was last updated
type string required
Defines whether or not this Transfer was sent or received by the user
Allowed values: send receive
value integer
The total value (in base units) sent by this Transfer (may be approximate for ETH and other coins where amounts in base units can exceed 2^53 - 1)
valueString required
The total value (in base units) sent by this Transfer represented as a String
baseValue integer
The value (in base units) sent by this Transfer without network fees, represented
baseValueString
The value (in base units) sent by this Transfer without network fees, represented as a String
feeString string
The Transfer's fee (in base units) represented as a String
payGoFee integer
The Transfer's BitGo fee (in base units)
payGoFeeString string
The Transfer's BitGo fee (in base units) represented as a String
usd number required
The amount of USD of this Transfer (will be negative if it's a send)
usdRate number required
The USD price at the time this Transfer was created
tags array required
The tags to be used on this Transfer (used in Policies)
history array[object] required
An audit log of events that have happened to the Transfer during its lifecycle
comment string required
A comment from the user
vSize integer
The size of the transaction
coinSpecific object required
Transfer fields specific to each coin type
sequenceId string
A "sequenceId" is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a "sequenceId" you can easily reference transfers and transactions&mdash;for example, to safely retry sending. Because the system only confirms one send request per "sequenceId" (and fails all subsequent attempts), you can retry sending without the risk of double spending. The "sequenceId" is only visible to users on the wallet and is not shared publicly.
entries array[object]
An array of objects describing the change in address balances made as a result of this Transfer
usersNotified boolean
Whether BitGo already sent notifications to the users of the transfer wallet
confirmations integer required
The number of blocks that have been confirmed since this Transfer's block was confirmed
inputs array[object]
If this is a Transfer on a UTXO coin, the array of inputs
outputs array
If this is a Transfer on a UTXO coin, the array of outputs
nextBatchPrevId string <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: 585951a5df8380e0e3063e9f

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code