Get the lowest nonce pending transaction for a wallet

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.

Query Parameters

blockchain

enum<string>

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

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,

ARC-TESTNET,

MONAD,

MONAD-TESTNET

Example:

"MATIC-AMOY"

address

string

Filter by the blockchain address of the wallet. Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

walletId

string<uuid>

Filter by the wallet ID

Response

The lowest nonce transaction is fetched

data

object

required

Show child attributes

data.transaction

Transaction · object

required

Show child attributes

data.transaction.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.transaction.blockchain

enum<string>

required

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

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,

ARC-TESTNET,

MONAD,

MONAD-TESTNET

Example:

"MATIC-AMOY"

data.transaction.createDate

string<date-time>

required

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

Example:

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

data.transaction.state

enum<string>

required

Current state of the transaction.

Available options:

CANCELLED,

CONFIRMED,

COMPLETE,

DENIED,

FAILED,

INITIATED,

CLEARED,

QUEUED,

SENT,

STUCK

data.transaction.transactionType

enum<string>

required

Available options:

INBOUND,

OUTBOUND

data.transaction.updateDate

string<date-time>

required

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

Example:

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

data.transaction.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)

Example:

"burn(uint256)"

data.transaction.abiParameters

(string | integer | boolean | any[])[]

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.

Example:

["100", "1"]

data.transaction.amounts

string[]

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).

Example:

["6.62607015"]

data.transaction.amountInUSD

string

Transaction amount in USD decimal format.

data.transaction.blockHash

string

Identifier for the block that includes the transaction.

data.transaction.blockHeight

integer

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

data.transaction.contractAddress

string

The blockchain address of the contract to be executed.

Example:

"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"

data.transaction.custodyType

enum<string>

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

Available options:

DEVELOPER,

ENDUSER

data.transaction.destinationAddress

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

data.transaction.errorReason

string

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

data.transaction.errorDetails

string

Additional detail associated with the corresponding transaction's error reason

data.transaction.estimatedFee

object

The estimated fee for the transaction. For Get Transactions API, this will only be returned if transaction type is used in the request query parameters

Show child attributes

data.transaction.estimatedFee.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.

Example:

"21000"

data.transaction.estimatedFee.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.

data.transaction.estimatedFee.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.

Example:

"5.935224468"

data.transaction.estimatedFee.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.

Example:

"1.022783914"

data.transaction.estimatedFee.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.

Example:

"1.022783914"

data.transaction.estimatedFee.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. For blockchains with L1 data fees such as OP/BASE, the network fee is a combination of the Execution Gas Fee and the L1 Data Fee. Each blockchain might use different formula for network fee. Refer to each specific blockchain's documentation to understand how networkFee is calculated.

Example:

"0.0001246397138"

data.transaction.estimatedFee.networkFeeRaw

string

Similar to networkFee, networkFeeRaw is an estimation with lower buffer and thus should be closer to the actual on-chain expense. This field will only be returned in the estimation response.

Example:

"0.0001246397138"

data.transaction.estimatedFee.l1Fee

string

This fee represents the Layer 1 (L1) rollup charge associated with transactions on Layer 2 blockchains. The amount is expressed in the native currency, such as ETH. This field is relevant for Layer 2 blockchains utilizing a rollup mechanism and for specific account types, such as externally owned accounts (EOAs) on the Optimism (OP) blockchain.

Example:

"0.000000000000140021"

data.transaction.feeLevel

enum<string>

Defines the blockchain fee level which will be paid for the transaction e.g. LOW, MEDIUM, HIGH. For Get Transactions API, this will only be returned if transaction type is used in the request query parameters

Available options:

LOW,

MEDIUM,

HIGH

Example:

"MEDIUM"

data.transaction.firstConfirmDate

string<date-time>

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

Example:

"2021-05-18T00:00:00Z"

data.transaction.networkFee

string

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

data.transaction.networkFeeInUSD

string

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

data.transaction.nfts

string[]

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

Example:

[
  "[{\"ntfTokenId\":\"12321\"",
  "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1\"}",
  "{\"ntfTokenId\":\"12322\"",
  "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/2\"}]"
]

data.transaction.operation

enum<string>

Operation type of the transaction.

Available options:

TRANSFER,

CONTRACT_EXECUTION,

CONTRACT_DEPLOYMENT

data.transaction.refId

string

Optional reference or description used to identify the transaction.

Example:

"grouptransaction123"

data.transaction.sourceAddress

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

data.transaction.tokenId

string<uuid>

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.transaction.txHash

string

Blockchain generated identifier of the transaction.

Example:

"0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d"

data.transaction.userId

string

Unique system generated identifier for the user.

Required string length: 5 - 50

Example:

"ext_user_id_1"

data.transaction.walletId

string<uuid>

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.transaction.transactionScreeningEvaluation

object

This field is optional and applicable to Compliance Engine customers only. Screening decision detail about matched rule, actions to take, and all related risk signals.

Show child attributes

data.transaction.transactionScreeningEvaluation.screeningDate

string<date-time>

required

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

Example:

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

data.transaction.transactionScreeningEvaluation.ruleName

string

Name of the matched rule found in screening.

Example:

"Low Gambling Risk (Owner)"

data.transaction.transactionScreeningEvaluation.actions

enum<string>[]

Actions to take for the decision.

An action to to take for the decision.

Available options:

APPROVE,

REVIEW,

FREEZE_WALLET,

DENY

Example:

["REVIEW"]

data.transaction.transactionScreeningEvaluation.reasons

object[]

Risk signals found include source, value, and type of the signal. It also contains risk score and risk category.

Show child attributes

data.transaction.transactionScreeningEvaluation.reasons.source

enum<string>

required

Source of the risk signal.

Available options:

ADDRESS,

BLOCKCHAIN,

ASSET

Example:

"ADDRESS"

data.transaction.transactionScreeningEvaluation.reasons.sourceValue

string

required

Value of the source. For example, if source is “ADDRESS”. The source value would be an blockchain address.

Example:

"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c"

data.transaction.transactionScreeningEvaluation.reasons.riskScore

enum<string>

required

Risk score of the signal.

Available options:

UNKNOWN,

LOW,

MEDIUM,

HIGH,

SEVERE,

BLOCKLIST

Example:

"LOW"

data.transaction.transactionScreeningEvaluation.reasons.riskCategories

enum<string>[]

required

List of risk categories for the signal.

The category of the associated risk of the blockchain address.

Available options:

SANCTIONS,

CSAM,

ILLICIT_BEHAVIOR,

GAMBLING,

TERRORIST_FINANCING,

UNSUPPORTED,

FROZEN,

OTHER,

HIGH_RISK_INDUSTRY,

PEP,

TRUSTED,

HACKING,

HUMAN_TRAFFICKING,

SPECIAL_MEASURES

Example:

["GAMBLING"]

data.transaction.transactionScreeningEvaluation.reasons.type

enum<string>

required

Type of the signal.

Available options:

OWNERSHIP,

COUNTERPARTY,

INDIRECT

Example:

"OWNERSHIP"

data.feeInfo

LowestNonceTransactionFeeInfo · object

required

Show child attributes

data.feeInfo.newHighEstimatedFee

object

required

The latest HIGH estimated fee for the transaction.

Show child attributes

data.feeInfo.newHighEstimatedFee.gasLimit

string

Example:

"21000"

data.feeInfo.newHighEstimatedFee.gasPrice

string

data.feeInfo.newHighEstimatedFee.maxFee

string

Example:

"5.935224468"

data.feeInfo.newHighEstimatedFee.priorityFee

string

Example:

"1.022783914"

data.feeInfo.newHighEstimatedFee.baseFee

string

Example:

"1.022783914"

data.feeInfo.newHighEstimatedFee.networkFee

string

Example:

"0.0001246397138"

data.feeInfo.newHighEstimatedFee.networkFeeRaw

string

Similar to networkFee, networkFeeRaw is an estimation with lower buffer and thus should be closer to the actual on-chain expense. This field will only be returned in the estimation response.

Example:

"0.0001246397138"

data.feeInfo.newHighEstimatedFee.l1Fee

string

Example:

"0.000000000000140021"

data.feeInfo.feeDifferenceAmount

string

required

Difference between new HIGH estimation and transaction's existing estimated fee, in native token amount unit, for example ETH

Example:

"0.1"

API Overview

Configurations

Developer-Controlled

User-Controlled

Modular

Compliance Engine

Get the lowest nonce pending transaction for a wallet

Authorizations

Query Parameters

Response