Get Outputs

Querying outputs allows you to retrieve specific information about transactions or assets on the Tangle. You can verify the status of transactions, track the movement of assets, and gather relevant details such as transaction history, ownership, or other metadata. You can query for any output type using the following functions:

Rust

• Client.basic_output_ids()
• Client.alias_output_ids()
• Client.foundry_output_ids()
• Client.nft_output_ids()

Typescript (Node.js)

• Client.basicOutputIds()
• Client.aliasOutputIds()
• Client.nftOutputIds()
• Client.foundryOutputIds()

Python

• Client.basic_output_ids()
• Client.alias_output_ids()
• Client.foundry_output_ids()
• Client.nft_output_ids()

Client in Wallet

If you are using a wallet you can always get the client by calling the client()/getClient()/get_client() method

Example Code

Rust

The following code example will:

1. Create a Client that will connect to the node defined in your .env file's NODE_URL variable.

sdk/examples/how_tos/client/get_outputs.rs

loading...

See full example on GitHub

2. Query the node for basic outputs with the specified QueryParameters using the Client.basic_output_ids() function.

sdk/examples/how_tos/client/get_outputs.rs

loading...

See full example on GitHub

3. Get the outputs retrieved in the previous step using the Client.get_outputs() function.

sdk/examples/how_tos/client/get_outputs.rs

loading...

See full example on GitHub

Typescript (Node.js)

The following code example will:

1. Create a Client that will connect to the node defined in your .env file's NODE_URL variable.

bindings/nodejs/examples/how_tos/client/get-outputs.ts

loading...

See full example on GitHub

2. Query the node for basic outputs with the specified QueryParameters using the Client.basicOutputIds() function.

bindings/nodejs/examples/how_tos/client/get-outputs.ts

loading...

See full example on GitHub

3. Get the outputs retrieved in the previous step using the Client.getOutputs() function.

bindings/nodejs/examples/how_tos/client/get-outputs.ts

loading...

See full example on GitHub

Python

The following code example will:

1. Create a Client that will connect to the node defined in your .env file's NODE_URL variable.

bindings/python/examples/how_tos/client/get_outputs.py

loading...

See full example on GitHub

2. Query the node for basic outputs with the specified QueryParameters using the Client.basic_output_ids() function.

bindings/python/examples/how_tos/client/get_outputs.py

loading...

See full example on GitHub

3. Get the outputs retrieved in the previous step using the Client.get_outputs() function.

bindings/python/examples/how_tos/client/get_outputs.py

loading...

See full example on GitHub

Full Example Code

Rust

sdk/examples/how_tos/client/get_outputs.rs

loading...

See full example on GitHub

Typescript (Node.js)

bindings/nodejs/examples/how_tos/client/get-outputs.ts

loading...

See full example on GitHub

Python

bindings/python/examples/how_tos/client/get_outputs.py

loading...

See full example on GitHub

Expected Output

Rust

First output of query:
ID: OutputId(0x57a796e9b8c5fc96c330fa45c2658f37d04f631eedc85d8e1e23434ca599eb8c0000)
OutputWithMetadata {
    output: BasicOutput {
        amount: 12310426,
        native_tokens: NativeTokens(
            [],
        ),
        unlock_conditions: UnlockConditions(
            [
                AddressUnlockCondition(
                    Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3),
                ),
            ],
        ),
        features: Features(
            [],
        ),
    },
    metadata: OutputMetadata {
        block_id: BlockId(0x2a006e26f54f1221b4fa5738bf2b3501a0a2e7085ff8dcc03d0700f75bbcc43c),
        output_id: OutputId(0x57a796e9b8c5fc96c330fa45c2658f37d04f631eedc85d8e1e23434ca599eb8c0000),
        is_spent: false,
        milestone_index_spent: None,
        milestone_timestamp_spent: None,
        transaction_id_spent: None,
        milestone_index_booked: 5300818,
        milestone_timestamp_booked: 1684939216,
        ledger_index: 5794425,
    },
}

Typescript (Node.js)

First output of query:
ID:  0x57a796e9b8c5fc96c330fa45c2658f37d04f631eedc85d8e1e23434ca599eb8c0000
OutputResponse {
  metadata: {
    blockId: '0x2a006e26f54f1221b4fa5738bf2b3501a0a2e7085ff8dcc03d0700f75bbcc43c',
    transactionId: '0x57a796e9b8c5fc96c330fa45c2658f37d04f631eedc85d8e1e23434ca599eb8c',
    outputIndex: 0,
    isSpent: false,
    milestoneIndexBooked: 5300818,
    milestoneTimestampBooked: 1684939216,
    ledgerIndex: 5794505
  },
  output: BasicOutput {
    type: 3,
    amount: '12310426',
    unlockConditions: [ [AddressUnlockCondition] ]
  }
}

Python

First output of query:
ID: 0x57a796e9b8c5fc96c330fa45c2658f37d04f631eedc85d8e1e23434ca599eb8c0000
{
    "metadata": {
        "blockId": "0x2a006e26f54f1221b4fa5738bf2b3501a0a2e7085ff8dcc03d0700f75bbcc43c",
        "transactionId": "0x57a796e9b8c5fc96c330fa45c2658f37d04f631eedc85d8e1e23434ca599eb8c",
        "outputIndex": 0,
        "isSpent": false,
        "milestoneIndexBooked": 5300818,
        "milestoneTimestampBooked": 1684939216,
        "ledgerIndex": 5794538
    },
    "output": {
        "type": 3,
        "amount": "12310426",
        "unlockConditions": [
            {
                "type": 0,
                "address": {
                    "type": 0,
                    "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3"
                }
            }
        ]
    }
}