API References

Advanced Wallets - Send to Many

post
http://localhost:3080/api/v1//advancedwallet//sendMany

Send coins or tokens to one or more recipients. You can use this endpoint to schedule outgoing transactions in bulk, lowering your aggregate amount of blockchain fees.

Retrieves the private key from KMS using the provided public key, then signs and broadcasts the transaction.

Works with both multisignature and MPC wallets.

Works with most BitGo-supported assets, but currently unavailable for: ALGO, ARBETH, AVAXC, CELO, CELO:CUSD, CSPR, DOT, EOS, HTETH:BGERCH, NEAR, OPETH, STX, TON, TRX, TRX:USDC, XLM, XRP, XTZ

Use this endpoint only with advanced wallets. For other wallet types, use Send to many.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params
string
enum
required

The key to use for signing the transaction

Allowed:
string
enum

Required for transactions from MPC wallets.

Allowed:
recipients
array of objects
recipients
string

Public key of the key used for signing multisig transactions i.e if source is user, this is the user's public key if source is backup, this is the backup key's public key

string

For TSS wallets, this is the common keychain of the wallet, it remains the same whether source is user or backup

number
2 to 1000

(BTC only) The number of blocks required to confirm a transaction. You can use numBlocks to estimate the fee rate by targeting confirmation within a given number of blocks. If both feeRate and numBlocks are absent, the transaction defaults to 2 blocks for confirmation. Note: The maxFeeRate limits the fee rate generated by numBlocks.

number

Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. If the feeRate is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee. Note: The feeRate overrides the maxFeeRate and minFeeRate.

number

(UTXO only) Custom multiplier to the feeRate. The resulting fee rate is limited by the maxFeeRate. For replace-by-fee (RBF) transactions (that include rbfTxIds), the feeMultiplier must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced. Note: The maxFeeRate limits the fee rate generated by feeMultiplier.

number

(BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The maxFeeRate limits the fee rate generated by both feeMultiplier and numBlocks. Note: The feeRate overrides the maxFeeRate.

number

The unspent selection for the transaction will only consider unspents with at least this many confirmations to be used as inputs. Does not apply to change outputs unless used in combination with enforceMinConfirmsForChange.

boolean
Defaults to false

When set to true, will enforce minConfirms for change outputs. Defaults to false.

number
Defaults to 1000

Specifies the minimum count of good-sized unspents to maintain in the wallet. Change splitting ceases when the wallet has targetWalletUnspents good-sized unspents. Note: Wallets that continuously send a high count of transactions will automatically split large change amounts into multiple good-sized change outputs while they have fewer than targetWalletUnspents good-sized unspents in their unspent pool. Breaking up large unspents helps to reduce the amount of unconfirmed funds in flight in future transactions, and helps to avoid long chains of unconfirmed transactions. This is especially useful for newly funded wallets or recently refilled send-only wallets.

string
length ≤ 256

Optional metadata (only persisted in BitGo) to be applied to the transaction. Use this to add transaction-specific information such as the transaction's purpose or another identifier that you want to reference later. The value is shown in the UI in the transfer listing page.

Ignore unspents smaller than this amount of base units (e.g. satoshis). For doge, only string is allowed.

Ignore unspents larger than this amount of base units (e.g. satoshis). For doge, only string is allowed.

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—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.

number

(XRP only) Absolute max ledger the transaction should be accepted in, whereafter it will be rejected

number

(XRP only) Relative ledger height (in relation to the current ledger) that the transaction should be accepted in, whereafter it will be rejected

boolean
Defaults to false

Set true to disable automatic change splitting. Also see: targetWalletUnspents

unspents
array of strings
unspents
string
length ≤ 256

Optional metadata (only persisted in BitGo) to be applied to the transaction. Use this to add transaction-specific information such as the transaction's purpose or another identifier that you want to reference later. The value is shown in the UI in the transfer listing page.

string

Two factor auth code to enable sending the transaction. Not necessary if using a long lived access token within the spending limit.

string
length ≤ 250

Specifies a custom destination address for the transaction's change output(s)

boolean

Flag for allowing external change addresses

boolean

(DASH only) Specifies whether or not to use Dash's "InstantSend" feature when sending a transaction.

string

Extra transaction information for CSPR, EOS, HBAR, RUNE, STX, TON, XLM, and XRP. Required for XLM transactions. Note: For XRP this is the destination tag (DT). For CSPR this is the transfer ID.

number

Transfer ID for the transaction

string
number

Custom gas limit to be used for sending the transaction. Only for ETH and ERC20 tokens.

string

Custodian transaction ID

string

(DOT only) A nonce ID is a number used to protect private communications by preventing replay attacks. This is an advanced option where users can manually input a new nonce value in order to correct or fill in a missing nonce ID value.

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago