List transfers

get

https://app.bitgo-test.com/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

coin

string

required

A cryptocurrency or token ticker symbol.

walletId

string

required

The wallet ID.

Query Params

allTokens

boolean

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

dateGte

date-time

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

dateLt

date-time

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

height

string

The block or ledger height

limit

integer

1 to 500

Defaults to 25

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

prevId

string

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

state

array of objects

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.

state

type

string

enum

Filter on sending or receiving Transfers

Allowed:

valueGte

integer

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

valueLt

integer

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

sortBy

string

enum

Customize sort order for the transfers by specifying the sort key.

Allowed:

reverse

boolean

True, if returning results in reverse order.

string

Filter for a transfer by one or more transfer ids

pendingApprovalId

string

Filter for a transfer with a matching pendingApprovalId

address

array of objects

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

address

includeHex

boolean

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

memoId

array of strings

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

memoId

includeRbf

boolean

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

Responses

200OK

400Bad Request

404Not Found