utxos

Helper endpoint that lets you ask the payment service for the current UTXOs sitting at a particular Cardano address. (READ access required)

Gets UTXOs (internal)

get/utxos

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/utxos
  • Auth: API key in header token

Query parameters

addressstring required

The address to get the UTXOs for

network'Preprod' | 'Mainnet' required

The Cardano network

countinteger

The number of UTXOs to get

pageinteger

The page number to get

order'Asc' | 'Desc'

The order to get the UTXOs in

Response

UTXOs

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "Utxos": [
      {
        "txHash": "tx_hash",
        "address": "addr1qx2ej34k567890",
        "Amounts": [
          {
            "unit": "",
            "quantity": 10000000
          }
        ],
        "outputIndex": 1,
        "block": "1",
        "dataHash": "data_hash",
        "inlineDatum": "inline_datum",
        "referenceScriptHash": "reference_script_hash"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.