Return utxos and some helpful information regarding it.

GET 
/wallet/utxo-filter

Return utxos and some helpful information regarding it.

Request

Query Parameters

max_utxos integer

Maximum number of utxos to return. Default to MAX_INPUTS (255)

token string

Token to filter the utxos. If not sent, we select only HTR utxos.

filter_address string

Address to filter the utxos.

amount_smaller_than integer

Maximum limit of utxo amount to filter the utxos list. We will return only utxos that have an amount lower than this value. Integer representation of decimals, i.e. 100 = 1.00.

amount_bigger_than integer

Minimum limit of utxo amount to filter the utxos list. We will return only utxos that have an amount bigger than this value. Integer representation of decimals, i.e. 100 = 1.00.

maximum_amount integer

Limit the maximum total amount to return summing all utxos. Integer representation of decimals, i.e. 100 = 1.00.

only_available_utxos boolean

Get only available utxos, ignoring locked ones. Defaults to false.

Header Parameters

x-wallet-id stringrequired

Defines the key of the wallet on which the request will be executed.

Responses

200

Return utxos

application/json

Schema

Schema

any

success

Success

{
  "total_amount_available": 12000,
  "total_utxos_available": 2,
  "total_amount_locked": 6000,
  "total_utxos_locked": 1,
  "utxos": [
    {
      "address": "HNnK9wgUVL6Cjzs1K3jpoGgqQTXCqpAnW8",
      "amount": 6000,
      "tx_id": "00fff7a3c6eb95ec3343bffcfca9a3a0d3e243462ae7de1f200cdd76716140fb",
      "locked": false,
      "index": 0
    },
    {
      "address": "WYiD1E8n5oB9weZ8NMyM3KoCjKf1KCjWAZ",
      "amount": 6000,
      "tx_id": "0000002e785a6ab7cb9a863f66a862c86ca418025c92ef3bb9a7174d7fa31a20",
      "locked": true,
      "index": 0
    },
    {
      "address": "WYiD1E8n5oB9weZ8NMyM3KoCjKf1KCjWAZ",
      "amount": 6000,
      "tx_id": "0000002940428f55b1bdc9346b6b253e4a904bd45cc129736028b32c1e9e5d23",
      "locked": false,
      "index": 0
    }
  ]
}

wallet-not-ready

Wallet is not ready yet

{
  "success": false,
  "message": "Wallet is not ready.",
  "state": 1
}

invalid-parameter

Invalid parameter

{
  "success": false,
  "error": [
    {
      "value": "\"1\"",
      "msg": "Invalid value",
      "param": "max_utxos",
      "location": "query"
    }
  ]
}

no-wallet-id

No wallet id parameter

{
  "success": false,
  "message": "Parameter 'wallet-id' is required."
}

invalid-wallet-id

Wallet id parameter is invalid

{
  "success": false,
  "message": "Invalid wallet-id parameter."
}

Loading...