Skip to main content
GET
/
quote
Returns a quote for an imperative swap
curl --request GET \
  --url https://quote-api.dflow.net/quote
{
  "contextSlot": 1,
  "inAmount": "<string>",
  "inputMint": "<string>",
  "minOutAmount": "<string>",
  "otherAmountThreshold": "<string>",
  "outAmount": "<string>",
  "outTransferFee": "<string>",
  "outputMint": "<string>",
  "platformFee": null,
  "priceImpactPct": "<string>",
  "requestId": "<string>",
  "routePlan": [
    {
      "data": "<string>",
      "inAmount": "<string>",
      "inputMint": "<string>",
      "inputMintDecimals": 1,
      "marketKey": "<string>",
      "outAmount": "<string>",
      "outputMint": "<string>",
      "outputMintDecimals": 1,
      "venue": "<string>"
    }
  ],
  "simulatedComputeUnits": 1,
  "slippageBps": 1
}

Query Parameters

​
inputMint
string
required

Base58-encoded input mint address

​
outputMint
string
required

Base58-encoded output mint address

​
amount
integer
required

Input amount as a scaled integer. For example, 1 SOL is 1000000000.

Required range: x >= 0
​
slippageBps

Max allowed slippage for the swap. Allowed values are:

  • a u16 which specifies the maximum allowed slippage in basis points
  • the string value "auto", where the server determines the maximum allowed slippage automatically Slippage tolerance specified in basis points
Required range: x >= 0
​
dexes
string

Comma-separated list of DEXes to include. If not specified, all DEXes will be included.

​
excludeDexes
string

Comma-separated list of DEXes to exclude. If not specified, all DEXes will be included.

​
platformFeeBps
integer

Optional platform fee in basis points. This should only be nonzero if the swap will collect the platform fee. The swap must specify a valid fee account and that fee account must be able to collect the fee mint at execution time.

Required range: x >= 0
​
platformFeeMode
enum<string>

Optional platform fee mode. If not specified, the default is outputMint.

Available options:
outputMint,
inputMint
​
sponsoredSwap
boolean

This should be specified as true if and only if the quote will be used for a sponsored swap. If true, then the quote will account for any additional token 2022 transfer fees that apply to the input and output mints for a sponsored swap.

​
destinationSwap
boolean

This should be specified as true if and only if the quote will be used for a destination token account swap. If true, then the quote will account for any additional token 2022 transfer fees that apply to the output mint for a destination token account swap.

​
onlyDirectRoutes
boolean

If true, only use single-leg routes

​
maxRouteLength
integer

If specified, the route will be limited to the specified number of legs. Ignored if only_direct_routes is true.

Required range: x >= 0

Response

Imperative swap quote

​
contextSlot
integer
required

Slot at which the request was evaluated

Required range: x >= 0
​
inAmount
string
required

Maximum input amount as a scaled integer. For example, 1 SOL is 1000000000.

​
inputMint
string
required

Base58-encoded input mint address

​
minOutAmount
string
required

Same as other_amount_threshold

​
otherAmountThreshold
string
required

Minimum output amount after all fees as a scaled integer. If the swap transaction doesn't produce at least this amount of the output token, the transaction will fail.

​
outAmount
string
required

Expected output amount after all fees as a scaled integer. For example, 1 SOL is 1000000000.

​
outputMint
string
required

Base58-encoded output mint address

​
priceImpactPct
string
required

Price impact of the swap. This is an estimate of the percentage difference between the expected price for the swap and the price for the same swap with the smallest input amount possible. For example, "0.01" means 1% price impact.

​
routePlan
object[]
required

Route that the swap will take

  • Option 1
  • Option 2
​
slippageBps
integer
required

Max allowed slippage % in basis points

Required range: x >= 0
​
outTransferFee
string

Transfer fee amount that was applied to the quote, if any

​
platformFee
object | null

Platform fee that was applied to the quote, if any

​
requestId
string

Identifier for the request

​
simulatedComputeUnits
integer | null

Compute units consumed by quote simulation

Required range: x >= 0