# suix_queryEvents

> For the complete documentation index, see [llms.txt](/docs/llms.txt).

POST https://sui-mainnet.g.alchemy.com/v2/{apiKey}

Returns a paginated list of events that match the given query criteria. You can filter by sender, package, module, event type, and more. Supports pagination and ordering.


Reference: https://www.alchemy.com/docs/chains/sui/sui-api-endpoints/suix-query-events

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| query | object | Yes | The event query criteria (e.g., MoveModule, Sender). |
| cursor | object | No | Optional paging cursor, an EventID { txDigest, eventSeq } object. |
| limit | integer | No | Maximum number of events to return. |
| descending_order | boolean | No | Whether to return results in descending order. |

## Result

**result** (object): A page of matched events.

## Example

### Request

```json
{
  "jsonrpc": "2.0",
  "method": "suix_queryEvents",
  "params": [
    {
      "MoveModule": {
        "package": "0x0000000000000000000000000000000000000000000000000000000000000002",
        "module": "deepbook_utils",
        "type": "0xdee9::clob_v2::DepositAsset<0x8da140bad1be69f7e64abf9f494b094dd3a77242577cab0ad658c9436bed225e::coin::COIN>"
      }
    },
    null,
    3,
    false
  ],
  "id": 1
}
```

### Response

```json
{
  "jsonrpc": "2.0",
  "result": {
    "data": [],
    "nextCursor": null,
    "hasNextPage": false
  },
  "id": 1
}
```

## Code Examples

### cURL

```bash
curl --request POST \
  --url https://sui-mainnet.g.alchemy.com/v2/docs-demo \
  --header 'Content-Type: application/json' \
  --data '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "suix_queryEvents",
  "params": [
    {
      "MoveModule": {
        "package": "0x0000000000000000000000000000000000000000000000000000000000000002",
        "module": "deepbook_utils",
        "type": "0xdee9::clob_v2::DepositAsset<0x8da140bad1be69f7e64abf9f494b094dd3a77242577cab0ad658c9436bed225e::coin::COIN>"
      }
    },
    {
      "txDigest": "string",
      "eventSeq": "string"
    },
    3,
    false
  ]
}'
```

### JavaScript

```javascript
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 1,
    method: 'suix_queryEvents',
    params: [
      {
        MoveModule: {
          package: '0x0000000000000000000000000000000000000000000000000000000000000002',
          module: 'deepbook_utils',
          type: '0xdee9::clob_v2::DepositAsset<0x8da140bad1be69f7e64abf9f494b094dd3a77242577cab0ad658c9436bed225e::coin::COIN>'
        }
      },
      {txDigest: 'string', eventSeq: 'string'},
      3,
      false
    ]
  })
};

fetch('https://sui-mainnet.g.alchemy.com/v2/docs-demo', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://sui-mainnet.g.alchemy.com/v2/docs-demo"

payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "suix_queryEvents",
    "params": [
        { "MoveModule": {
                "package": "0x0000000000000000000000000000000000000000000000000000000000000002",
                "module": "deepbook_utils",
                "type": "0xdee9::clob_v2::DepositAsset<0x8da140bad1be69f7e64abf9f494b094dd3a77242577cab0ad658c9436bed225e::coin::COIN>"
            } },
        {
            "txDigest": "string",
            "eventSeq": "string"
        },
        3,
        False
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

### Go

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sui-mainnet.g.alchemy.com/v2/docs-demo"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"suix_queryEvents\",\n  \"params\": [\n    {\n      \"MoveModule\": {\n        \"package\": \"0x0000000000000000000000000000000000000000000000000000000000000002\",\n        \"module\": \"deepbook_utils\",\n        \"type\": \"0xdee9::clob_v2::DepositAsset<0x8da140bad1be69f7e64abf9f494b094dd3a77242577cab0ad658c9436bed225e::coin::COIN>\"\n      }\n    },\n    {\n      \"txDigest\": \"string\",\n      \"eventSeq\": \"string\"\n    },\n    3,\n    false\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

### Java

```java
HttpResponse<String> response = Unirest.post("https://sui-mainnet.g.alchemy.com/v2/docs-demo")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"suix_queryEvents\",\n  \"params\": [\n    {\n      \"MoveModule\": {\n        \"package\": \"0x0000000000000000000000000000000000000000000000000000000000000002\",\n        \"module\": \"deepbook_utils\",\n        \"type\": \"0xdee9::clob_v2::DepositAsset<0x8da140bad1be69f7e64abf9f494b094dd3a77242577cab0ad658c9436bed225e::coin::COIN>\"\n      }\n    },\n    {\n      \"txDigest\": \"string\",\n      \"eventSeq\": \"string\"\n    },\n    3,\n    false\n  ]\n}")
  .asString();
```

### C#

```csharp
using RestSharp;


var options = new RestClientOptions("https://sui-mainnet.g.alchemy.com/v2/docs-demo");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"suix_queryEvents\",\n  \"params\": [\n    {\n      \"MoveModule\": {\n        \"package\": \"0x0000000000000000000000000000000000000000000000000000000000000002\",\n        \"module\": \"deepbook_utils\",\n        \"type\": \"0xdee9::clob_v2::DepositAsset<0x8da140bad1be69f7e64abf9f494b094dd3a77242577cab0ad658c9436bed225e::coin::COIN>\"\n      }\n    },\n    {\n      \"txDigest\": \"string\",\n      \"eventSeq\": \"string\"\n    },\n    3,\n    false\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

```


## OpenRPC Method Specification

```yaml
name: suix_queryEvents
summary: Query events using filter criteria
description: |
  Returns a paginated list of events that match the given query criteria. You can filter by sender, package, module, event type, and more. Supports pagination and ordering.
params:
  - name: query
    required: true
    description: The event query criteria (e.g., MoveModule, Sender).
    schema:
      type: object
  - name: cursor
    required: false
    description: Optional paging cursor, an EventID { txDigest, eventSeq } object.
    schema:
      type: object
      description: A unique identifier for an event, composed of a transaction digest and event sequence number.
      required:
        - txDigest
        - eventSeq
      properties:
        txDigest:
          type: string
        eventSeq:
          type: string
  - name: limit
    required: false
    description: Maximum number of events to return.
    schema:
      type: integer
  - name: descending_order
    required: false
    description: Whether to return results in descending order.
    schema:
      type: boolean
result:
  name: result
  description: A page of matched events.
  schema:
    type: object
    required:
      - data
      - nextCursor
      - hasNextPage
    properties:
      data:
        type: array
        description: A list of results.
        items:
          type: object
      nextCursor:
        description: Cursor for fetching the next page.
        type: string
        nullable: true
      hasNextPage:
        type: boolean
examples:
  - name: Query MoveModule events
    params:
      - name: query
        value:
          MoveModule:
            package: '0x0000000000000000000000000000000000000000000000000000000000000002'
            module: deepbook_utils
            type: 0xdee9::clob_v2::DepositAsset<0x8da140bad1be69f7e64abf9f494b094dd3a77242577cab0ad658c9436bed225e::coin::COIN>
      - name: cursor
        value: null
      - name: limit
        value: 3
      - name: descending_order
        value: false
    result:
      name: result
      value:
        data: []
        nextCursor: null
        hasNextPage: false
```
