Ctrl+K

Internal API for List SendQueue by State

get/api/v2/internal/{coin}/sendq/{state}

This endpoint is used internally to retrieve SendQueue entries based on their state.

Path Parameters

  • coinstringRequired
    Non-empty coin string
    Example: btc
    Min length: >= 1 characters
  • statestringRequired
    The state of SendQ entries to retrieve (e.g., 'pending', 'attempted', 'failed', 'done', 'reverted', 'held', 'replaced', 'abandoned')
    Enum: pending attempted failed done reverted held replaced abandoned

Query Parameters

  • limitstring
    Optional limit for number of entries to return
  • prevIdstring
    Optional ID to start listing from (for pagination)
  • datestring
    Optional date to filter by (all SendQueues later than date)
  • countstring
    Optional string to return count instead of entries
  • lightningstring
    Optional string to filter lightning transactions
  • crossChainstring
    Optional string to filter cross chain transactions
  • walletVersionstring
    Optional string to specify wallet model version (v1 or v2, defaults to v2)

200 Response

sendqueueOne ofrequired
address string
agent required
attempts number required
Number of transmission attempts
coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
coinSpecificOne ofrequired
Transaction fields specific to each coin type
comment string
confirmHeight number
createTime number required
Number of milliseconds since January 1, 1970
Example: 1537289808000
customNode object
debugTa2Ta
deployment boolean required
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
error string
Error regarding the transaction
expireTime number
feesUsed required
firstValidBlock number
held boolean required
Indicates that the transaction was held at some point
instant boolean
Use instant sending (coin-specific) method if available
instantId string
lastValidBlock number
lowPriority boolean
modifyTime number required
Number of milliseconds since January 1, 1970
Example: 1537289808000
nextAttempt required
payGoFee number required
The Transfer's BitGo fee (in base units)
payGoFeeString string required
The Transfer's BitGo fee (in base units) represented as a String
pendingApprovalId string
state string required
The status of this SendQueue item
Allowed values: pending attempted failed done reverted held replaced abandoned
Example: done
submitHeight number
targetAttempts number required
Max number of times to try transmitting
token string
tx string required
Raw transaction (hex)
txid string required
The on-chain transaction ID
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
txRequestId string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000
txType string
uniqueDoubleSpendPreventionIds array[string] required
Example: ["59cd72485007a239fb00282ed480da1f"]
user string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
value number
The total value (in base units) sent by this sendq transaction
valueString string required
The total value (in base units) sent by this sendq transaction represented as a String
Example: 200000
Match pattern: ^-?\d+$
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
nextBatchPrevId string

400 Response

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

500 Response

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