SDK Explorer

Lists all transactions.

Parameters
input
object
Required

Defines the parameters for querying a list of transactions.

option 1:
userId
string
Required

Unique system-generated identifier for the user.

blockchain
string

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

Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAEVMEVM-TESTNETMATICMATIC-AMOYNEARNEAR-TESTNETOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA
destinationAddress
string

Filters transactions based on their destination address.

includeAll
boolean

Determines whether the query should include all tokens. If set to true, results will include all tokens.

state
string

Current state of the transaction.

Allowed valuesCANCELLEDCOMPLETECONFIRMEDDENIEDFAILEDINITIATEDPENDING_RISK_SCREENINGQUEUEDSENT
txHash
string

Filters for a specific transaction hash.

txType
string

Filters transactions based on their type.

Allowed valuesINBOUNDOUTBOUND
walletIds
array of strings

Filters transactions based on the owning wallets. Input should be an array of walletIds.

from
string

Start time of the query, inclusive.

pageAfter
string

Used to return items after the specified item exclusively. SHOULD NOT be used in conjunction with pageBefore.

pageBefore
string

Used to return items before the specified item exclusively. SHOULD NOT be used in conjunction with pageAfter.

pageSize
number

The number of items to return.

to
string

End time of the query, inclusive. Defaults to the current time.

option 2:
userToken
string
Required

The JSON Web Token (JWT) representing the user.

blockchain
string

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

Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAEVMEVM-TESTNETMATICMATIC-AMOYNEARNEAR-TESTNETOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA
destinationAddress
string

Filters transactions based on their destination address.

includeAll
boolean

Determines whether the query should include all tokens. If set to true, results will include all tokens.

state
string

Current state of the transaction.

Allowed valuesCANCELLEDCOMPLETECONFIRMEDDENIEDFAILEDINITIATEDPENDING_RISK_SCREENINGQUEUEDSENT
txHash
string

Filters for a specific transaction hash.

txType
string

Filters transactions based on their type.

Allowed valuesINBOUNDOUTBOUND
walletIds
array of strings

Filters transactions based on the owning wallets. Input should be an array of walletIds.

from
string

Start time of the query, inclusive.

pageAfter
string

Used to return items after the specified item exclusively. SHOULD NOT be used in conjunction with pageBefore.

pageBefore
string

Used to return items before the specified item exclusively. SHOULD NOT be used in conjunction with pageAfter.

pageSize
number

The number of items to return.

to
string

End time of the query, inclusive. Defaults to the current time.

Responses
Example
1const response = await client.listTransactions({
2  userToken: 'dummy-user-token',
3})
4console.log(response.data?.transactions)
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.