Skip to main content
GET
/
order
order
curl --request GET \
  --url https://lite-api.jup.ag/ultra/v1/order
{
  "mode": "<string>",
  "inputMint": "<string>",
  "outputMint": "<string>",
  "inAmount": "<string>",
  "outAmount": "<string>",
  "otherAmountThreshold": "<string>",
  "swapMode": "<string>",
  "slippageBps": 123,
  "inUsdValue": 123,
  "outUsdValue": 123,
  "priceImpact": 123,
  "swapUsdValue": 123,
  "priceImpactPct": "<string>",
  "routePlan": [
    {
      "swapInfo": {
        "ammKey": "<string>",
        "label": "<string>",
        "inputMint": "<string>",
        "outputMint": "<string>",
        "inAmount": "<string>",
        "outAmount": "<string>",
        "feeAmount": "<string>",
        "feeMint": "<string>"
      },
      "percent": 123,
      "bps": 123
    }
  ],
  "feeMint": "<string>",
  "feeBps": 123,
  "signatureFeeLamports": 123,
  "prioritizationFeeLamports": 123,
  "rentFeeLamports": 123,
  "swapType": "<string>",
  "router": "aggregator",
  "transaction": "<string>",
  "gasless": true,
  "requestId": "<string>",
  "totalTime": 123,
  "taker": "<string>",
  "quoteId": "<string>",
  "maker": "<string>",
  "expireAt": "<string>",
  "platformFee": {
    "amount": "<string>",
    "feeBps": 123
  },
  "errorCode": 1,
  "errorMessage": "Insufficient funds"
}

Query Parameters

​
inputMint
string
required
​
outputMint
string
required
​
amount
string
required
​
taker
string
​
referralAccount
string
​
referralFee
number
Required range: 50 <= x <= 255
​
excludeRouters
enum<string>
Available options:
metis,
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 Metis router, does not apply to other routers
  • For example:
    • Exclude Raydium: excludeRouters=<all-except-Metis> and excludeDexes=Raydium
    • Only include Meteora DLMM: excludeRouters=<all-except-Metis> and excludeDexes=<all-except-MeteoraDLMM>
​
payer
string
  • The address of an external gas payer to pay for the network fees and rent on behalf of the taker
  • Refer to Integrator Gas Payer for more details

Response

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
​
feeBps
number
required
​
signatureFeeLamports
number
required
  • The number of lamports the taker has to pay as a base network fee, if a valid transaction is returned. This may be 0 if the transaction is gasless, in which case the gas payer will cover this fee.
​
prioritizationFeeLamports
number
required
  • The number of lamports the taker has to pay for higher priority landing, if a valid transaction is returned. Includes priority fees and tips for services such as Jito, if any. This may be 0 if the transaction is gasless, in which case the gas payer will cover this fee.
​
rentFeeLamports
number
required
  • The number of lamports the taker has to pay for rent, if a valid transaction is returned. This may be 0 if the transaction is gasless, in which case the gas payer will cover this fee. Note that this value is just an estimate.
​
swapType
string
required
  • Deprecated, in favour of router
​
router
enum<string>
required
Available options:
aggregator,
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. Else, it will either be a valid base64 encoded transaction or the empty string
​
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
​
quoteId
string
​
maker
string
​
expireAt
string
​
platformFee
object
​
errorCode
enum<number>
  • This field will be present if taker is defined and transaction is the 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 the 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
⌘I