Query Parameters
- inputMintstringREQUIRED
Input token mint address
- outputMintstringREQUIRED
Output token mint address
- amountintegerREQUIRED
Raw amount to swap (before decimals). Input amount if swapMode is ExactIn, output amount if swapMode is ExactOut
- slippageBpsinteger
Slippage threshold in basis points. If the output token amount exceeds the slippage then the swap transaction will fail. Default is 50
- swapModestring
The swap mode. Possible values include: ExactIn, ExactOut. The default value is set to ExactIn. ExactOut is for supporting use cases where you need an exact token amount, like payments
- dexesarray
Only the DEXes that you want to include. Separate them with commas. If you want to route directly to the GooseFX Gamma API, you can set the dexes to 'Gamma' without any additional dexes.
- excludeDexesarray
The DEXes that you want to exclude. Separate them with commas.
- restrictIntermediateTokensboolean
Restrict intermediate tokens to a top token set that has stable liquidity. This will help to ease potential high slippage error rate when swapping with minimal impact on pricing. Default is true
- onlyDirectRoutesboolean
Direct Routes limits Jupiter routing to single hop routes only. By default, it is set to false
- asLegacyTransactionboolean
Instead of using versioned transaction, this will use the legacy transaction. By default, it is set to false
- platformFeeBpsinteger
If you want to charge the user a fee, you can specify the fee in BPS. Fee % is taken out of the output token
- maxAccountsinteger
Rough estimate of the max accounts to be used for the quote, so that you can compose with your own accounts. Default is 64
- instructionVersionstring
The version of instruction to use in the swap program, defaults to V1. Options are: V1 or V2
- dynamicSlippageboolean
No longer applicable. Default is false
Returns
- inputMintstring
The source token's mint address
- inAmountstring
The amount of the source token being swapped
- outputMintstring
The destination token's mint address
- outAmountstring
Calculated output amount from the routing engine. Value includes platform fees and DEX fees, excluding slippage
- otherAmountThresholdstring
Calculated minimum output amount after accounting for slippageBps on the outAmount value
- swapModestring
Indicates the swap mode
- slippageBpsinteger
Slippage tolerance in basis points
- platformFeeobject
The platform Fee object which contains the following fields:
- amountstring
The amount of the platform fee
- feeBpsinteger
The fee percentage in basis points
- priceImpactPctstring
The percentage of price impact due to the swap
- routePlanarray
An array containing detailed information about each step of the swap process
- swapInfoobject
Detailed information about a specific swap step
- ammKeystring
The key identifying the Automated Market Maker (AMM) responsible for the swap
- labelstring
A label or identifier for the AMM
- inputMintstring
The mint address of the token being swapped from in this step
- outputMintstring
The mint address of the token being received in this step
- inAmountstring
The amount of the token being swapped from in this step
- outAmountstring
The amount of the token being received after the swap in this step
- feeAmountstring
The amount of fee charged for this step of the swap
- feeMintstring
The mint address of the token used for paying fees in this step
- percentinteger
The percentage allocation of the swap for this step
- bpsinteger
The basis points allocation of the swap for this step
- instructionVersionstring
The version of instruction used in the swap program. Possible values: V1 or V2, or null
- contextSlotinteger
A contextual identifier
- timeTakeninteger
Time taken for the request to be processed
1{2"inputMint": "So11111111111111111111111111111111111111112",3"inAmount": "1000000000",4"outputMint": "EKpQGSJtjMFqKZ9KQanSqYXRcF8fBopzLHYxdM65zcjm",5"outAmount": "277873995",6"otherAmountThreshold": "276484626",7"swapMode": "ExactIn",8"slippageBps": 50,9"platformFee": null,10"priceImpactPct": "0",11"routePlan": [12{13"swapInfo": {14"ammKey": "Gkt4BpMRFxhhrrVMQsewM74ggriAbxyN2yUYDD9qt1NV",15"label": "Lifinity V2",16"inputMint": "So11111111111111111111111111111111111111112",17"outputMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",18"inAmount": "1000000000",19"outAmount": "151723380",20"feeAmount": "50000",21"feeMint": "So11111111111111111111111111111111111111112"22},23"percent": 10024},25{26"swapInfo": {27"ammKey": "BuMSijp24Vg28YVi3Y8WRjpRuBdMUTYuYn1BxgoRe3yR",28"label": "ZeroFi",29"inputMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",30"outputMint": "EKpQGSJtjMFqKZ9KQanSqYXRcF8fBopzLHYxdM65zcjm",31"inAmount": "151723380",32"outAmount": "277873995",33"feeAmount": "0",34"feeMint": "11111111111111111111111111111111"35},36"percent": 10037}38],39"scoreReport": null,40"contextSlot": 335660308,41"timeTaken": 0.003340617,42"swapUsdValue": "151.61720367660802477109744292",43"simplerRouteUsed": false,44"mostReliableAmmsQuoteReport": {45"info": {}46}47}
1{2"inputMint": "So11111111111111111111111111111111111111112",3"inAmount": "1000000000",4"outputMint": "EKpQGSJtjMFqKZ9KQanSqYXRcF8fBopzLHYxdM65zcjm",5"outAmount": "277873995",6"otherAmountThreshold": "276484626",7"swapMode": "ExactIn",8"slippageBps": 50,9"platformFee": null,10"priceImpactPct": "0",11"routePlan": [12{13"swapInfo": {14"ammKey": "Gkt4BpMRFxhhrrVMQsewM74ggriAbxyN2yUYDD9qt1NV",15"label": "Lifinity V2",16"inputMint": "So11111111111111111111111111111111111111112",17"outputMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",18"inAmount": "1000000000",19"outAmount": "151723380",20"feeAmount": "50000",21"feeMint": "So11111111111111111111111111111111111111112"22},23"percent": 10024},25{26"swapInfo": {27"ammKey": "BuMSijp24Vg28YVi3Y8WRjpRuBdMUTYuYn1BxgoRe3yR",28"label": "ZeroFi",29"inputMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",30"outputMint": "EKpQGSJtjMFqKZ9KQanSqYXRcF8fBopzLHYxdM65zcjm",31"inAmount": "151723380",32"outAmount": "277873995",33"feeAmount": "0",34"feeMint": "11111111111111111111111111111111"35},36"percent": 10037}38],39"scoreReport": null,40"contextSlot": 335660308,41"timeTaken": 0.003340617,42"swapUsdValue": "151.61720367660802477109744292",43"simplerRouteUsed": false,44"mostReliableAmmsQuoteReport": {45"info": {}46}47}