API Reference

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Circle Contracts

Templates

View / Update

Interact

Deploy / Import

Event Monitors

Modular Wallets

Transfers

UserOps

Wallets

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Travel Rule

List user operations

gethttps://api.circle.com/v1/w3s/buidl/userOps

Reference
Playground

Retrieve a list of all user operations that fit the specified parameters.

Query parameters

blockchain

string

Filter by the blockchain.

refId

string

Filter by the optional user-defined reference identifier.

senders

string

Filter by the senders.

state

string

Filter by the state.

txHash

string

Filter by the txHash.

userOpHash

string

Filter by the userOpHash.

from

date-time

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

date-time

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

pageBefore

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

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

1 to 50

Default is 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.

Response

200UserOpsResponse

Response Body

object

data

object

Required

Show 1 properties

userOperations

array of objects

Required

All user operations that match criteria.

Show 17 properties

string

Required

System-generated unique identifier of the resource.

refId

string

Reference or description used to identify the object.

actualGasCost

string

Actual gas cost of user operation.

actualGasUsed

string

Actual gas used of user operation.

blockDate

string

Date and time of block, in ISO-8601 UTC format.

blockHash

string

Blockchain generated identifier of block.

blockHeight

integer

Blockchain height of block.

blockchain

string

Required

Blockchain network of resource.

Allowed valuesETHETH-SEPOLIAMATICMATIC-AMOYARBARB-SEPOLIAUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

errorReason

string

Error reason of failed user operation.

Allowed valuesFAILED_ON_CHAINFAILED_REPLACED

revertReason

string

On-chain failed revert reason of user operation.

state

string

Required

State of user operation.

Allowed valuesSENTCONFIRMEDCOMPLETEFAILED

string

Address of user operation executed with.

txHash

string

Blockchain generated identifier of transaction.

userOpHash

string

Required

Generated identifier of user operation.

userOperation

object

Required

Show 17 properties

callData

string

Required

callGasLimit

string

factory

string

factoryData

string

initCode

string

maxFeePerGas

string

maxPriorityFeePerGas

string

nonce

string

Required

paymaster

string

paymasterAndData

string

paymasterData

string

paymasterPostOpGasLimit

string

paymasterVerificationGasLimit

string

preVerificationGas

string

sender

string

Required

signature

string

verificationGasLimit

string

createDate

string

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Date and time the resource was last updated, in ISO-8601 UTC format.

400Error

401NotAuthorizedResponse

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "userOperations": [
4      {
5        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6        "refId": "custom_ref_id",
7        "actualGasCost": "0.0015584763706281",
8        "actualGasUsed": "182385",
9        "blockDate": "2023-01-01T12:04:05Z",
10        "blockHash": "0x2eb19fd02850ff963efefbaa71dbcd4acb41a9c261c4f8961979db1b56d48704",
11        "blockHeight": 123456,
12        "blockchain": "MATIC-AMOY",
13        "errorReason": "FAILED_REPLACED",
14        "revertReason": "",
15        "state": "COMPLETE",
16        "to": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
17        "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
18        "userOpHash": "0x54d3cccda6ffa503bc1e554937fe67818b6ca1a5a05c7e66ebfa32bf27520152",
19        "userOperation": {
20          "callData": "",
21          "callGasLimit": "",
22          "factory": "",
23          "factoryData": "",
24          "initCode": "",
25          "maxFeePerGas": "",
26          "maxPriorityFeePerGas": "",
27          "nonce": "",
28          "paymaster": "",
29          "paymasterAndData": "",
30          "paymasterData": "",
31          "paymasterPostOpGasLimit": "",
32          "paymasterVerificationGasLimit": "",
33          "preVerificationGas": "",
34          "sender": "",
35          "signature": "",
36          "verificationGasLimit": ""
37        },
38        "createDate": "2023-01-01T12:04:05Z",
39        "updateDate": "2023-01-01T12:04:05Z"
40      }
41    ]
42  }
43}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy