platform.getUTXOs

Gets the UTXOs that reference a given set of addresses.

Signature​

platform.getUTXOs(
    {
        addresses: []string,
        limit: int, //optional
        startIndex: { //optional
            address: string,
            utxo: string
        },
        sourceChain: string, //optional
        encoding: string, //optional
    },
) -> 
{
    numFetched: int,
    utxos: []string,
    endIndex: {
        address: string,
        utxo: string
    },
    encoding: string,
}
  • utxos is a list of UTXOs such that each UTXO references at least one address in addresses.

  • At most limit UTXOs are returned. If limit is omitted or greater than 1024, it is set to 1024.

  • This method supports pagination. endIndex denotes the last UTXO returned. To get the next set of UTXOs, use the value of endIndex as startIndex in the next call.

  • If startIndex is omitted, will fetch all UTXOs up to limit.

  • When using pagination (ie when startIndex is provided), UTXOs are not guaranteed to be unique across multiple calls. That is, a UTXO may appear in the result of the first call, and then again in the second call.

  • When using pagination, consistency is not guaranteed across multiple calls. That is, the UTXO set of the addresses may have changed between calls.

  • encoding specifies the format for the returned UTXOs. Can be either "cb58" or "hex" and defaults to "cb58".

Example

Request

curl -X POST --data '{
    "jsonrpc":"2.0",
    "id"     :1,
    "method" :"platform.getUTXOs",
    "params" :{
        "addresses":["P-avax1we3sf3tg7v6kccw92xsg9m7u8cxjsyxqacw0e6", "P-avax1tnuesf6cqwnjw7fxjyk7lhch0vhf0v95wj5jvy"],
        "limit":5,
        "encoding": "cb58"
    }
}' -H 'content-type:application/json;' https://ava-mainnet.blastapi.io/<project-id>/ext/P

Result

{
    "jsonrpc": "2.0",
    "result": {
        "numFetched": "0",
        "utxos": [],
        "endIndex": {
            "address": "P-avax1we3sf3tg7v6kccw92xsg9m7u8cxjsyxqacw0e6",
            "utxo": "11111111111111111111111111111111LpoYY"
        },
        "encoding": "cb58"
    },
    "id": 1
}

Last updated