Skip to main content
GET
/
v1
/
w3s
/
transactions
List transactions
curl --request GET \
  --url https://api.circle.com/v1/w3s/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'X-User-Token: <x-user-token>'
{
  "data": {
    "transactions": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "abiFunctionSignature": "burn(uint256)",
        "abiParameters": [
          "100",
          "1"
        ],
        "amounts": [
          "6.62607015"
        ],
        "amountInUSD": "<string>",
        "blockHash": "<string>",
        "blockHeight": 123,
        "blockchain": "MATIC-AMOY",
        "contractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
        "createDate": "2023-01-01T12:04:05Z",
        "custodyType": "DEVELOPER",
        "destinationAddress": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
        "errorReason": "<string>",
        "errorDetails": "<string>",
        "estimatedFee": {
          "gasLimit": "21000",
          "gasPrice": "<string>",
          "maxFee": "5.935224468",
          "priorityFee": "1.022783914",
          "baseFee": "1.022783914",
          "networkFee": "0.0001246397138",
          "networkFeeRaw": "0.0001246397138"
        },
        "feeLevel": "MEDIUM",
        "firstConfirmDate": "2021-05-18T00:00:00Z",
        "networkFee": "<string>",
        "networkFeeInUSD": "<string>",
        "nfts": [
          "[{\"ntfTokenId\":\"12321\"",
          "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1\"}",
          "{\"ntfTokenId\":\"12322\"",
          "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/2\"}]"
        ],
        "operation": "TRANSFER",
        "refId": "grouptransaction123",
        "sourceAddress": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
        "state": "CANCELLED",
        "tokenId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "transactionType": "INBOUND",
        "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
        "updateDate": "2023-01-01T12:04:05Z",
        "userId": "ext_user_id_1",
        "walletId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "transactionScreeningEvaluation": {
          "ruleName": "Low Gambling Risk (Owner)",
          "actions": [
            "REVIEW"
          ],
          "screeningDate": "2023-01-01T12:04:05Z",
          "reasons": [
            {
              "source": "ADDRESS",
              "sourceValue": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
              "riskScore": "LOW",
              "riskCategories": [
                "GAMBLING"
              ],
              "type": "OWNERSHIP"
            }
          ]
        }
      }
    ]
  }
}

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-User-Token
string
required

Unique system generated JWT session token for specific user.

​
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Example:

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

Query Parameters

​
blockchain
enum<string>

Filter by blockchain.

Available options:
ETH,
ETH-SEPOLIA,
AVAX,
AVAX-FUJI,
MATIC,
MATIC-AMOY,
SOL,
SOL-DEVNET,
ARB,
ARB-SEPOLIA,
NEAR,
NEAR-TESTNET,
EVM,
EVM-TESTNET,
UNI,
UNI-SEPOLIA,
BASE,
BASE-SEPOLIA,
OP,
OP-SEPOLIA,
APTOS,
APTOS-TESTNET
Example:

"MATIC-AMOY"

​
destinationAddress
string

Filter by the destination address.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

​
includeAll
boolean

Return all recourses with monitored and non-monitored tokens.

Example:

true

​
operation
enum<string>

Filter by the operation of the transaction.

Available options:
TRANSFER,
CONTRACT_EXECUTION
​
state
enum<string>

Filter by the state of the transaction.

Available options:
CANCELLED,
CONFIRMED,
COMPLETE,
DENIED,
FAILED,
INITIATED,
CLEARED,
QUEUED,
SENT
​
txHash
string

Filter on the transaction hash of the transaction.

Example:

"0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d"

​
txType
enum<string>

Filter by on the transaction type.

Available options:
INBOUND,
OUTBOUND
​
userId
string

Filter by user's system generated identifiers.

Required string length: 5 - 50
​
walletIds
string

Filter by the wallet IDs, this parameter is a comma separated list of ids.

​
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
​
order
enum<string>
default:DESC

Specifies the sort order of the collection by CreateDate.

Valid values:

  • ASC – Sort results in ascending order.
  • DESC – Sort results in descending order (default).
Available options:
ASC,
DESC

Response

Transactions retrieved

​
data
object