order

Request for a base64-encoded unsigned swap transaction to be used in POST /ultra/v1/execute

Query Parameters

inputMint · string · default: So11111111111111111111111111111111111111112 · required

outputMint · string · default: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v · required

amount · string · default: 10000000 · required

taker · string · default: vBXNsd5SRtTPpW7GWv3wREA6Ztm2jCWp5eqqTsVhyG5

payer · string

• The public key of an account that will be used to cover 'gas-related' fees on behalf of the taker
• Gas related fees such as signature fees, priority fees and rent. Note that enabling this may result in different routing decisions.
• When payer is passed in, closeAuthority is required

closeAuthority · string

• The public key of an account to set as the close authority of ATAs created during the swap transaction. Only applies to non-wSOL ATAs that persist beyond the execution of the transaction.
• When payer is passed in, closeAuthority is required
• If the closeAuthority==taker, the taker is the close authority and no additional instructions will be added
• If the closeAuthority!==taker, the closeAuthority will be set by adding an instruction to the transaction to set the close authority

referralAccount · string

• Refer to Integrator Fees for more details

referralFee · number

• Refer to Integrator Fees for more details

Required range: 50 <= x <= 255

excludeRouters · enum<string>

Available options:

iris,

jupiterz,

dflow,

okx

excludeDexes · string

• Full list of DEXes here, for example: excludeDexes=Raydium,Orca+V2,Meteora+DLMM
• Important: This only excludes DEXes on the Iris router, does not apply to other routers
• For example:
  • Exclude Raydium: excludeRouters=<all-except-Iris> and excludeDexes=Raydium
  • Only include Meteora DLMM: excludeRouters=<all-except-Iris> and excludeDexes=<all-except-MeteoraDLMM>

Response

200

application/json

Successful response

mode · string · required

inputMint · string · required

outputMint · string · required

inAmount · string · required

outAmount · string · required

otherAmountThreshold · string · required

swapMode · string · required

slippageBps · number · required

priceImpactPct · string · required

• Please use priceImpact field instead, this is still available only for backwards compatibility

routePlan · object[] · required

Show child attributes

feeBps · number · required

• The fee includes either Ultra default fee or your integrator fee, depending on if referral and/or payer params are passed in
• If referralAccount, referralFee (and payer if passed in) are passed in, the fee will be the integrator fee only
• If no additional referral params are passed in, the fee will be the Ultra default fee only and can include additional fees for gasless support mechanism

signatureFeeLamports · number · required

• The number of lamports the taker, maker (JupiterZ's MM) or payer has to pay for the base network fee, if a valid transaction is returned.

prioritizationFeeLamports · number · required

• The number of lamports the taker, maker (JupiterZ's MM) or payer has to pay for higher priority landing, if a valid transaction is returned
• Includes priority fees and tips for services such as Jito, etc, if any

rentFeeLamports · number · required

• The number of lamports the taker or payer has to pay for account rent, if a valid transaction is returned
• Note that this value is just an estimate
• JupiterZ's MM currently does not cover for rent fees

swapType · string · required

• Deprecated, in favour of router

router · enum<string> · required

Available options:

iris,

jupiterz,

dflow,

okx

transaction · string | null · required

• Unsigned base-64 encoded transaction to be signed and used in /execute
• If taker is null, this field will be null.
• If the transaction field is empty, it is returned with errorCode and errorMessage such as Insufficient Funds

gasless · boolean · required

requestId · string · required

• Required to make a request to /execute

totalTime · number · required

taker · string | null · required

inUsdValue · number

outUsdValue · number

priceImpact · number

swapUsdValue · number

feeMint · string

platformFee · object

• This field shows the platform fee only, does not include fee for gas
• Platform fee can either be the Ultra default fee or your integrator fee

Show child attributes

signatureFeePayer · string | null

• The public key of the account that will cover the signature fee, it can be either taker, maker (JupiterZ's MM) or payer if passed in

prioritizationFeePayer · string | null

• The public key of the account that will cover the prioritization fee, it can be either taker, maker (JupiterZ's MM) or payer if passed in

rentFeePayer · string | null

• The public key of the account that will cover the rent fee, it can be either taker or payer if passed in
• JupiterZ's MM currently does not cover for rent fees

quoteId · string

maker · string

expireAt · string

errorCode · enum<number>

• This field will be present if taker is defined and transaction is an empty string
• It is unique for each error scenarios

Available options:

1,

2,

3

errorMessage · enum<string>

• This field will be present if taker is defined and transaction is an empty string
• This field can still return despite having a valid order/quote
• This is meant for display purposes only and it is discouraged to match these error messages as they could be parameterized

Available options:

Insufficient funds,

Top up `${solAmount}` SOL for gas,

Minimum `${swapAmount}` for gasless