Create a swap quote

Create a swap quote, which includes the payload to sign as well as the transaction data needed to execute the swap. The developer is responsible for signing the payload and submitting the transaction to the network in order to execute the swap.

Authorizations

Authorization · string · header · required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Headers

X-Idempotency-Key · string

An optional UUID v4 request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our Idempotency docs for more information on using idempotency keys.

Required string length: 36

Body

application/json

network · enum<string> · required

The network on which to perform the swap.

Available options:

base,

ethereum,

arbitrum,

optimism

Example:

"base"

toToken · string · required

The 0x-prefixed contract address of the token to receive.

Example:

"0x7F5c764cBc14f9669B88837ca1490cCa17c31607"

fromToken · string · required

The 0x-prefixed contract address of the token to send.

Example:

"0x6B175474E89094C44Da98b954EedeAC495271d0F"

fromAmount · string · required

The amount of the fromToken to send in atomic units of the token. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.

Example:

"1000000000000000000"

taker · string · required

The 0x-prefixed address that holds the fromToken balance and has the Permit2 allowance set for the swap.

Example:

"0xAc0974bec39a17e36ba4a6b4d238ff944bacb478"

signerAddress · string

The 0x-prefixed Externally Owned Account (EOA) address that will sign the Permit2 EIP-712 permit message. This is only needed if taker is a smart contract.

Example:

"0x922f49447d8a07e3bd95bd0d56f35241523fbab8"

gasPrice · string

The target gas price for the swap transaction, in Wei. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. If not provided, the API will use an estimate based on the current network conditions.

Example:

"1000000000"

slippageBps · integer · default: 100

The maximum acceptable slippage of the toToken in basis points. If this parameter is set to 0, no slippage will be tolerated. If not provided, the default slippage tolerance is 100 bps (i.e., 1%).

Required range: 0 <= x <= 10000

Example:

100

Response

201

application/json

Successfully created swap quote.

CreateSwapQuoteResponse

A wrapper for the response of a swap quote operation.

permit2 · object | null · required

The approval object which contains the necessary fields to submit an approval for this transaction. Null if the fromToken is the native token or the transaction is a native token wrap / unwrap.

Show child attributes

transaction · object · required

The details of the transaction to be signed and submitted to execute the swap.

Show child attributes

blockNumber · string · required

The block number at which the liquidity conditions were examined.

Example:

"17038723"

toAmount · string · required

The amount of the toToken that will be received in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc.

Example:

"1000000000000000000"

toToken · string · required

The 0x-prefixed contract address of the token that will be received.

Example:

"0x7F5c764cBc14f9669B88837ca1490cCa17c31607"

fees · object · required

The estimated fees for the swap.

Show child attributes

Example:

{
  "gasFee": {
    "amount": "1000000000000000000",
    "token": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE"
  },
  "protocolFee": {
    "amount": "1000000000000000000",
    "token": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE"
  }
}

issues · object · required

An object containing potential issues discovered during validation that could prevent the swap from being executed successfully.

Show child attributes

Example:

{
  "allowance": {
    "currentAllowance": "1000000000",
    "spender": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
  },
  "balance": {
    "token": "0x6B175474E89094C44Da98b954EedeAC495271d0F",
    "currentBalance": "900000000000000000",
    "requiredBalance": "1000000000000000000"
  },
  "simulationIncomplete": false
}

liquidityAvailable · boolean · required

Whether sufficient liquidity is available to settle the swap. All other fields in the response will be empty if this is false.

Example:

true

minToAmount · string · required

The minimum amount of the toToken that must be received for the swap to succeed, in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc. This value is influenced by the slippageBps parameter.

Example:

"900000000000000000"

fromAmount · string · required

The amount of the fromToken that will be sent in this swap, in atomic units of the fromToken. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.

Example:

"1000000000000000000"

fromToken · string · required

The 0x-prefixed contract address of the token that will be sent.

Example:

"0x6B175474E89094C44Da98b954EedeAC495271d0F"