Ctrl+K

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.
    Minimum: >= 1
    Maximum: <= 500
  • prevIdstring
    Return the next batch of results, based on the `nextBatchPrevId` value from the previous batch.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • statearray[string]
    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.
    Example: confirmed
    Enum: confirmed failed initialized pendingApproval rejected removed replaced signed unconfirmed
  • typestring
    Filter on sending or receiving `Transfers`
    Enum: send receive
  • 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
  • sortBystring
    Customize sort order for the transfers by specifying the sort key.
    Enum: heightId id
  • reverseboolean
    True, if returning results in reverse order.
  • idstring
    Filter for a transfer by one or more transfer ids
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • pendingApprovalIdstring
    Filter for a transfer with a matching pendingApprovalId
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • addressarray[string]
    Return transfers with elements in `entries` that have an `address` field set to this value
    Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
    Max length: <= 250 characters
  • includeHexboolean
    Include the raw hex data of the transaction in the response (this may be a large amount of data)
  • memoIdarray[string]
    Return transfers with any of the payment identifiers in this array. Available for Stellar and EOS.
    Example: 2000000
    Pattern: ^-?\d+$
  • includeRbfboolean
    True, if including Replace-By-Fee (RBF) transfers.

200 Response

transfers array[object] required
coin string required
A cryptocurrency or token ticker symbol.
Example: btc
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
wallet string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
txid string required
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
txidType string
The type of the transaction id
Allowed values: transactionHash blockHash
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
confirmations integer required
The number of blocks that have been confirmed since this Transfer's block was confirmed
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 string required
The total value (in base units) sent by this Transfer represented as a String
Example: 2000000
Match pattern: ^-?\d+$
intendedValueString string
A string representation (in base units) of the initial value for the transfer. This is present because when a transaction fails on chain, its value is mutated to be zero. This string is immutable and will always be the intended value of the initial transfer regardless of the final state of the transaction.
Example: 2000000
Match pattern: ^-?\d+$
baseValue integer
The value (in base units) sent by this transfer, excluding network fees. BitGo is deprecating this field in the future. Instead, use baseValueWithoutFees.
baseValueString string
The value (in base units) sent by this transfer, excluding network fees represented as a string. BitGo is deprecating this field in the future. Instead, use baseValueWithoutFees.
Example: 2000000
Match pattern: ^-?\d+$
baseValueWithoutFees integer
The value (in base units) sent by this transfer excluding network fees.
baseValueWithoutFeesString string
The value (in base units) sent by this transfer, excluding network fees, represented as a string
Example: 2000000
Match pattern: ^-?\d+$
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
state string required
Allowed values: confirmed failed initialized pendingApproval rejected removed replaced signed unconfirmed
Example: confirmed
tags array[string] required
The tags to be used on this Transfer (used in Policies)
Example: 59cd72485007a239fb00282ed480da1f
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
label string
Address labels (if any) from entries concatenated.
replaces array[string]
Transaction IDs that this transfer replaces.
replacedBy array[string]
Transaction IDs that replace this transfer.
inputs array[object]
If this is a Transfer on a UTXO coin, the array of inputs
outputs array[object]
If this is a Transfer on a UTXO coin, the array of outputs
coin string required
A cryptocurrency or token ticker symbol.
Example: btc
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

404 Response

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