Queries

balance

Returns the Balance! of a specific address for a given asset id.

args:

owner: Address!

The owner address.

assetId: AssetId!

The asset id.

balances

Returns a BalanceConnection! for an array of balances for each asset owned by a given address.

args:

filter: BalanceFilterInput!

A filter to specify the wallet owner address.

blob

Returns information about a certain Blob .

args:

id: BlobId

The transaction identifier for the blob.

block

Returns information about a certain Block . Accepts either the block id or block height as an argument.

args:

id: BlockId

The block id.

height: U64

The block height.

blocks

Returns a BlockConnection! for an array of all blocks produced.

chain

Returns ChainInfo! about the target Fuel network used for the API.

coin

Returns details about a specific Coin .

args:

utxoId: UtxoId!

A unique 32 byte identifier for the UTXO.

coins

Returns a CoinConnection! for an array of coins based on a given owner and/or asset id

args:

filter: CoinFilterInput!

A filter with the owner address and optionally the asset id.

coinsToSpend

Returns an array of spendable [[CoinType!]!]! per asset.

args:

owner: Address

The owner address of the coins.

queryPerAsset: [SpendQueryElementInput!]!

The list of requested asset resources. Several entries with the same asset id are not allowed.

excludedIds: ExcludeInput

The resources to exclude.

consensusParameters

Returns the ConsensusParameters for a given version.

args:

version: Int!

The version of the consensus parameters.

contract

Returns the Contract information for a given contract id.

args:

id: ContractId!

The contract id of the requested contract.

contractBalance

Returns the ContractBalance! for a given contract and asset id.

args:

contract: ContractId!

The contract that owns the balance.

asset: AssetId!

The asset id for the balance.

contractBalances

Returns a ContractBalanceConnection! for an array of balances for all assets owned by a given contract

args:

filter: ContractBalanceFilterInput!

A filter for the contract balances.

estimateGasPrice

Estimates the most expensive the gas price over a given block horizon, and returns EstimateGasPrice! .

args:

blockHorizon: U32!

The block horizon defines how many blocks in the future you are doing an estimate for.

estimatePredicates

Estimate the predicate gas and returns a Transaction! .

args:

tx: HexString!

The transaction hex string.

health

Returns true if the API is running or false if the API is down.

latestGasPrice

Returns the LatestGasPrice! of the latest block.

message

Returns the Message for a given message nonce.

args:

nonce: Nonce!

The message nonce.

messageProof

Returns the MessageProof for a given message id or transaction.

args:

transactionId: TransactionId!

The transaction id for the message.

nonce: Nonce

The message nonce.

commitBlockId: BlockId

The block id.

commitBlockHeight: U32

The block height.

messages

Returns a MessageConnection! for an array of messages for a given owner.

args:

owner: Address

The owner address of the messages.

messageStatus

Returns the MessageStatus for a given message Nonce .

args:

nonce: Nonce

The nonce of the message.

nodeInfo

Returns NodeInfo! about the current node.

relayedTransactionStatus

Returns RelayedTransactionStatus details for a given relayed transaction id.

args:

id: RelayedTransactionId!

The ID for the relayed transaction.

stateTransitionBytecodeByVersion

Returns StateTransitionBytecode details for a given version.

args:

version: Int!

The version of the state transition function..

stateTransitionBytecodeByRoot

Returns StateTransitionBytecode details for a given root.

args:

root: [HexString!]

The merkle root of the state transition bytecode.

transaction

Returns Transaction details for a given transaction id.

args:

id: TransactionId!

The ID for the transaction.

transactions

Returns a TransactionConnection! for an array of all transactions.

transactionsByOwner

Returns a TransactionConnection! for an array of all transactions from a given address.

args:

owner: Address!

The owner address of the transactions.