Skip to main content
GET
/
v1
/
w3s
/
contracts
/
monitors
Get Event Monitors
curl --request GET \
  --url https://api.circle.com/v1/w3s/contracts/monitors \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "eventMonitors": [
      {
        "id": "e3c998a5-bdf1-4f3e-812f-24da238c0fff",
        "blockchain": "ETH",
        "contractAddress": "0x6bc50ff08414717f000431558c0b585332c2a53d",
        "eventSignature": "Transfer(address indexed from, address indexed to, uint256 value)",
        "eventSignatureHash": "0xd3d3dd4b1fd3e53f94deb24e763485b4c925345c5abfa9ad529c67aa55a3b784",
        "isEnabled": true,
        "createDate": "2023-01-01T12:00:00Z",
        "updateDate": "2023-01-10T15:30:00Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

​
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support. A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Query Parameters

​
contractAddress
string

Filter contracts by address.

​
blockchain
enum<string>

Filter by blockchain. The blockchain network that the resource is to be created on or is currently on. Required along with sourceAddress if you don't provide walletId. The blockchain and walletId fields are mutually exclusive.

Available options:
ETH,
ETH-SEPOLIA,
MATIC,
MATIC-AMOY,
ARB,
ARB-SEPOLIA,
UNI,
UNI-SEPOLIA,
BASE,
BASE-SEPOLIA,
OP,
OP-SEPOLIA
Example:

"MATIC-AMOY"

​
eventSignature
string

Filter monitors by event signature.

​
from
string<date-time>

Queries items created since the specified date-time (inclusive) in ISO 8601 format.

Example:

"2023-01-01T12:04:05Z"

​
to
string<date-time>

Queries items created before the specified date-time (inclusive) in ISO 8601 format.

Example:

"2023-01-01T12:04:05Z"

​
pageBefore
string<uuid>

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageAfter.

​
pageAfter
string<uuid>

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageBefore.

​
pageSize
integer
default:10

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Required range: 1 <= x <= 50

Response

List of event monitors retrieved successfully.

​
data
object
required