REST APIWallet & TransactWallet

GET

Path Params

  • coin string required
    A cryptocurrency symbol or token ticker symbol

    at least 1 characters

  • walletId string required

    at least 1 characters · matches ^[0-9a-f]{32}$

Query Params

  • limit string number
    Limit the number of results.

    >= 0 · <= 2000

    Defaults to 25

  • prevId string
    Only return results created after this ID

    at least 1 characters

  • chains array of strings
    Filter by chains. May be given mutiple times
  • minConfirms string number
    The minimum number of confirmations for the unspents
  • enforceMinConfirmsForChange boolean
    Whether to enforce the minimum number of confirmations for change outputs
  • minValue string
    The minimum value of unspents to return (in base units, e.g. satoshis)

    at least 1 characters

  • maxValue string
    The maximum value of unspents to return (in base units, e.g. satoshis)

    at least 1 characters

  • unspentIds array of strings
    Canton: filter to specific IMS unspent contract ids (repeat param or comma-separated). Ignored for other chains that use this route.
  • token string
    Canton: filter UTXOs by token name (e.g. "canton:usd1"). Omit to return native coin UTXOs only (default, backwards compatible). Ignored for other chains that use this route.

    at least 1 characters

Responses

200
OK

Response Body

object

  • unspents array of objects required
    unspents object
    • chain number
      The chain of the UTXO
    • index number
      The index of the UTXO
    • redeemScript string
      The redeem script of the UTXO
    • witnessScript string
      The witness script of the UTXO
    • id string
      The ID of the UTXO
    • address string
      The address of the UTXO
    • value number
      The value of the UTXO
    • blockHeight number
      The block this Unspent was created in
    • coinbase boolean
      True if this unspent came from the coinbase transaction
  • nextBatchPrevId string
    The ID from where the results can continue
  • coin string
    A cryptocurrency symbol or token ticker symbol
  • bumpFee string number
    fee bump
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id