Skip to main content

sui_getTransactionBlock RPC Method

Return the transaction response object.

Updated on
Dec 10, 2024

sui_getTransactionBlock RPC Method

Parameters

digest
string
REQUIRED
The digest of the queried transaction
TransactionBlockResponseOptions
object
Optional settings to configure the details returned for an object
showBalanceChanges
boolean
Whether to show balance changes. Default is false
showEffects
boolean
Whether to show transaction effects. Default is false
showEvents
boolean
Whether to show transaction events. Default is false
showInput
boolean
Whether to show transaction input data. Default is false
showObjectChanges
boolean
Whether to show object changes. Default is false
showRawEffects
boolean
Whether to show raw transaction effects. Default is false
showRawInput
boolean
Whether to show BCS-encoded transaction input data. Default is false

Returns

result
object
The result object containing transaction and effects details
digest
string
The digest of the queried transaction
transaction
object
Contains the transaction data and related metadata
data
object
Details of the transaction data
messageVersion
string
The version of the transaction message
transaction
object
Details of the transaction itself
kind
string
The type of transaction, such as ProgrammableTransaction
inputs
array
Inputs used in the transaction
type
string
The type of the input (e.g., object, pure)
objectType
string
The type of object (if applicable, e.g., immOrOwnedObject, sharedObject)
objectId
string
The ID of the object
version
string
The version of the object
digest
string
The digest associated with the object
valueType
string
The type of value for pure inputs (e.g., u64, address)
value
string
The value for pure inputs
initialSharedVersion
string
The initial version of a shared object
mutable
boolean
Indicates if the shared object is mutable
transactions
array
List of operations in the transaction
MergeCoins
array
Merges coins into a single coin
Input
integer
Reference to the input index for the coin to merge
MoveCall
object
Details of a Move module call
package
string
The ID of the package where the module is defined
module
string
The name of the module being called
function
string
The function within the module being called
type_arguments
array
Type arguments provided to the function
arguments
array
Arguments passed to the function
Input
integer
Reference to the input index
TransferObjects
array
Transfers objects to a new owner
NestedResult
array
Nested result index reference
Input
integer
Reference to the input index for the object to transfer
sender
string
The address of the transaction sender
gasData
object
Details of the gas payment and budget
payment
array
Details of the gas payment objects
objectId
string
The ID of the payment object
version
string
The version of the payment object
digest
string
The digest associated with the payment object
owner
string
The owner of the gas payment objects
price
string
The price of gas in the transaction
budget
string
The gas budget for the transaction
txSignatures
array
Signatures for the transaction
effects
object
Details about transaction effects
messageVersion
string
Version of the effect message
status
object
Execution status of the transaction
status
string
Status of the transaction, e.g., success
gasUsed
object
Details of gas used for the transaction
computationCost
string
Cost for computation
storageCost
string
Cost for storage
storageRebate
string
Rebate for storage
nonRefundableStorageFee
string
Non-refundable fee for storage
modifiedAtVersions
array
List of objects modified in this transaction
objectId
string
The ID of the modified object
sequenceNumber
string
The version of the modified object
sharedObjects
array
List of shared objects involved in the transaction
objectId
string
The ID of the shared object
version
integer
The version of the shared object
digest
string
The digest of the shared object
transactionDigest
string
The digest of the transaction
created
array
List of objects created during the transaction
owner
object
Owner of the created object
AddressOwner
string
Address of the owner
reference
object
Reference details of the created object
objectId
string
The ID of the created object
version
integer
The version of the created object
digest
string
The digest of the created object
mutated
array
List of objects mutated during the transaction
owner
object
Owner of the mutated object
AddressOwner
string
Address of the owner
reference
object
Reference details of the mutated object
objectId
string
The ID of the mutated object
version
integer
The version of the mutated object
digest
string
The digest of the mutated object
deleted
array
List of objects deleted during the transaction
objectId
string
The ID of the deleted object
version
integer
The version of the deleted object
digest
string
The digest of the deleted object
gasObject
object
Details of the gas object used for the transaction
owner
object
Owner of the gas object
AddressOwner
string
Address of the owner
reference
object
Reference details of the gas object
objectId
string
The ID of the gas object
version
integer
The version of the gas object
digest
string
The digest of the gas object
eventsDigest
string
Digest of events emitted during the transaction
dependencies
array
List of dependencies of the transaction
events
array
List of events emitted during the transaction
id
object
Identifier of the event
txDigest
string
The transaction digest associated with the event
eventSeq
string
The sequence number of the event
packageId
string
The ID of the package associated with the event
transactionModule
string
The module in the transaction where the event was emitted
sender
string
The address of the sender who emitted the event
type
string
The type of the event
parsedJson
object
The parsedJson object contains structured details about the event, including trade specifics and order details.
base_asset_quantity_filled
string
The quantity of the base asset that has been filled in the transaction.
base_asset_quantity_remaining
string
The remaining quantity of the base asset that is yet to be filled.
is_bid
boolean
A flag indicating whether the transaction is a bid (true) or an ask (false).
maker_address
string
The blockchain address of the maker involved in the trade.
maker_client_order_id
string
The client-provided order identifier for the maker's transaction.
maker_rebates
string
The rebates or rewards provided to the maker for their part in the trade.
order_id
string
The unique identifier for the order associated with the trade.
original_quantity
string
The original quantity of the asset as specified in the order.
owner
string
The identifier for the owner associated with the trade
quantity
string
The quantity of the asset involved in the trade
pool_id
string
The identifier for the liquidity pool associated with the trade.
price
string
The price at which the trade was executed.
taker_address
string
The blockchain address of the taker involved in the trade.
taker_client_order_id
string
The client-provided order identifier for the taker's transaction.
taker_commission
string
The commission charged to the taker for the trade.
bcs
string
BCS-encoded data of the event
timestampMs
string
The timestamp of the transaction in milliseconds
checkpoint
string
The checkpoint ID associated with the transaction
Request
1
curl --location 'https://docs-demo.sui-mainnet.quiknode.pro/' \
2
--header 'Content-Type: application/json' \
3
--data '{
4
  "jsonrpc": "2.0",
5
  "id": 1,
6
  "method": "sui_getTransactionBlock",
7
  "params": [
8
    "8NB8sXb4m9PJhCyLB7eVH4onqQWoFFzVUrqPoYUhcQe2",
9
    {
10
      "showInput": true,
11
      "showRawInput": false,
12
      "showEffects": true,
13
      "showEvents": true,
14
      "showObjectChanges": false,
15
      "showBalanceChanges": false,
16
      "showRawEffects": false
17
    }
18
  ]
19
}
20
'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free