listTransactions

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Smart Contract Platform

Templates

View / Update

Interact

Deploy / Import

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

List transactions

GEThttps://api.circle.com/v1/w3s/transactions

Lists all transactions. Includes details such as status, source/destination, and transaction hash.

Header parameters

X-User-Token

string

Required

Unique system generated JWT session token for specific user.

Query parameters

blockchain

string

Filter by blockchain.

destinationAddress

string

Filter by the destination address.

includeAll

boolean

Return all recourses with monitored and non-monitored tokens.

operation

string

Filter by the operation of the transaction.

state

string

Filter by the state of the transaction.

txHash

string

Filter on the transaction hash of the transaction.

txType

string

Filter by on the transaction type.

userId

string

Filter by user's system generated identifiers.

walletIds

string

Filter by the wallet IDs of the transaction.

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

200TransactionsResponse

Response Body

object

data

object

Show 1 properties

transactions

array of objects

Show 31 properties

string

Required

System-generated unique identifier of the resource.

abiFunctionSignature

string

The contract ABI function signature or callData field is required for interacting with the smart contract. The ABI function signature cannot be used simultaneously with callData. e.g. burn(uint256)

abiParameters

array of strings, integers, booleans, arrays

The contract ABI function signature parameters for executing the contract interaction. Supported parameter types include string, integer, boolean, and array. These parameters should be used exclusively with the abiFunctionSignature and cannot be used with callData.

option 1: string

option 2: integer

option 3: boolean

option 4: array

amounts

array of strings

Transfer amounts in decimal number format, at least one element is required for transfer. For ERC721 token transfer, the amounts field is required to be ["1"] (array with "1" as the only element).

amountInUSD

string

Transaction amount in USD decimal format.

blockHash

string

Identifier for the block that includes the transaction.

blockHeight

integer

Block height of the transaction, representing the number of blockchain confirmations.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

contractAddress

string

The blockchain address of the contract to be executed.

createDate

string

Required

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

custodyType

string

Describes who controls the digital assets in a wallet: either the end-user or the developer.

destinationAddress

string

The destination blockchain address for the transaction.

errorReason

string

Description of the error. Only present for transactions in FAILED state.

errorDetails

string

Additional detail associated with the corresponding transaction's error reason

estimatedFee

object

Show 6 properties

gasLimit

string

The maximum units of gas to use for the transaction. Required if feeLevel is not provided. Estimates for this limit can be obtained through the POST /transactions/transfer/estimateFee API. GasLimit override (only supported for EOA wallets): Using gasLimit together with feeLevel, the provided gasLimit is required to be greater or equal to feeLevel estimation and will override the estimation's gasLimit.

gasPrice

string

For blockchains without EIP-1559 support, the maximum price of gas, in gwei, to use per each unit of gas (see gasLimit). Requires gasLimit. Cannot be used with feeLevel, priorityFee, or maxFee. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

maxFee

string

For blockchains with EIP-1559 support, the maximum price per unit of gas (see gasLimit), in gwei. Requires priorityFee, and gasLimit to be present. Cannot be used with feeLevel or gasPrice. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

priorityFee

string

For blockchains with EIP-1559 support, the “tip”, in gwei, to add to the base fee as an incentive for validators. Please note that the maxFee and gasLimit parameters are required alongside the priorityFee. The feeLevel and gasPrice parameters cannot be used with the priorityFee. Estimations for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

baseFee

string

For blockchains with EIP-1559 support, the estimated base fee represents the minimum fee required for a transaction to be included in a block on the blockchain. It is measured in gwei and compensates for the computational resources validators consume to process the transaction. The base fee is supplemented by a separate "tip" called the priority fee, which acts as an extra incentive for validators to prioritize the transaction. The priority fee is added to the base fee to calculate the final transaction fee.

networkFee

string

The estimated network fee is the maximum amount of cryptocurrency (such as ETH, ARB, or SOL) that you will pay for your transaction. This fee depends on the parameters you set, including Gas Limit, Priority Fee, and Max Fee. It compensates for the computational resources that validators consume to process the transaction. It is measured in native token such as ETH, SOL. Each blockchain might use different formula for network fee. Refer to each specific blockchain's documentation to understand how networkFee is calculated.

feeLevel

object

firstConfirmDate

string

Date the transaction was first confirmed in a block. ISO-8601 UTC date/time.

networkFee

string

Gas fee, in native token, paid to the network for the transaction.

networkFeeInUSD

string

Gas fee, in USD, paid to the network for the transaction.

nfts

array of strings

List of Nfts, in JSON string format, associated with the transaction.

operation

string

Operation type of the transaction.

refId

string

Optional reference or description used to identify the transaction.

sourceAddress

string

The source address of the transaction.

state

string

Required

Current state of the transaction.

tokenId

string

System generated identifier of the token. Excluded with tokenAddress and tokenBlockchain.

transactionType

string

Required

txHash

string

Blockchain generated identifier of the transaction.

updateDate

string

Required

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

userId

string

Unique system generated identifier for the user.

walletId

string

Unique system generated identifier of the wallet. Required when source Address and blockchain is not provided. Mutually exclusive. For contract deploys this wallet ID will be used as the source.

transactionScreeningEvaluation

object

defaultError

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "transactions": [
4      {
5        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6        "abiFunctionSignature": "burn(uint256)",
7        "abiParameters": [],
8        "amounts": [],
9        "amountInUSD": "",
10        "blockHash": "",
11        "blockHeight": 0,
12        "blockchain": "MATIC-AMOY",
13        "contractAddress": "",
14        "createDate": "2023-01-01T12:04:05Z",
15        "custodyType": "DEVELOPER",
16        "destinationAddress": "",
17        "errorReason": "",
18        "errorDetails": "",
19        "estimatedFee": {
20          "gasLimit": "21000",
21          "gasPrice": "",
22          "maxFee": "5.935224468",
23          "priorityFee": "1.022783914",
24          "baseFee": "1.022783914",
25          "networkFee": "0.0001246397138"
26        },
27        "feeLevel": {},
28        "firstConfirmDate": "",
29        "networkFee": "",
30        "networkFeeInUSD": "",
31        "nfts": [],
32        "operation": "TRANSFER",
33        "refId": "grouptransaction123",
34        "sourceAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
35        "state": "INITIATED",
36        "tokenId": "",
37        "transactionType": "INBOUND",
38        "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
39        "updateDate": "2023-01-01T12:04:05Z",
40        "userId": "ext_user_id_1",
41        "walletId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
42        "transactionScreeningEvaluation": {}
43      }
44    ]
45  }
46}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy