suix_queryEvents RPC Method
Parameters
query
object
REQUIRED
The event query criteria. To know more visit here: https://docs.sui.io/guides/developer/sui-101/using-events#event-filters
EventID
object
The event object which contains the following fields:
eventSeq
string
The event sequence number
txDigest
string
The transaction digest hash
limit
integer
Maximum number of items per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified
descending_order
boolean
Query result ordering, default to false (ascending order), oldest record first
Returns
result
object
The result object which encapsulates the response data from the query, including details about events, pagination, and metadata
data
array
An array containing details about each event, including transaction information, module metadata, and parsed JSON data
id
object
The unique identifier for the event, comprising details like transaction digest and event sequence number
txDigest
string
The transaction digest, a unique string identifier for the transaction
eventSeq
string
The sequence number of the event within the transaction
packageId
string
The identifier for the package related to the event
transactionModule
string
The name of the transaction module where the event occurred
sender
string
The address of the sender who initiated the transaction
type
string
The type of event (e.g., transfer, creation, or modification)
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
The bytecode serialization (BCS) representation of the event data
timestampMs
string
The timestamp of the event in milliseconds since the epoch
nextCursor
object
Cursor information for paginating through events, specifying where to start for the next query
txDigest
string
The transaction digest to continue querying from
eventSeq
string
The sequence number of the event to continue querying from
hasNextPage
boolean
A flag indicating whether there are more events to query in the next page
Request
1curl --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": "suix_queryEvents",7"params": [8{9"MoveModule": {10"package": "0x158f2027f60c89bb91526d9bf08831d27f5a0fcb0f74e6698b9f0e1fb2be5d05",11"module": "deepbook_utils",12"type": "0xdee9::clob_v2::DepositAsset<0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN>"13}14},15null,163,17false18]19}'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free