Build Transaction

curl --request GET \
  --url https://api.jup.ag/swap/v2/build \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.jup.ag/swap/v2/build', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jup.ag/swap/v2/build",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jup.ag/swap/v2/build"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.jup.ag/swap/v2/build")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "inputMint": "<string>",
  "outputMint": "<string>",
  "inAmount": "<string>",
  "outAmount": "<string>",
  "otherAmountThreshold": "<string>",
  "swapMode": "<string>",
  "slippageBps": 123,
  "priceImpactPct": "<string>",
  "routePlan": [
    {
      "swapInfo": {
        "ammKey": "<string>",
        "label": "<string>",
        "inputMint": "<string>",
        "outputMint": "<string>",
        "inAmount": "<string>",
        "outAmount": "<string>"
      },
      "percent": 123,
      "bps": 123,
      "usdValue": 123
    }
  ],
  "computeBudgetInstructions": [
    {
      "programId": "<string>",
      "accounts": [
        {
          "pubkey": "<string>",
          "isWritable": true,
          "isSigner": true
        }
      ],
      "data": "<string>"
    }
  ],
  "setupInstructions": [
    {
      "programId": "<string>",
      "accounts": [
        {
          "pubkey": "<string>",
          "isWritable": true,
          "isSigner": true
        }
      ],
      "data": "<string>"
    }
  ],
  "swapInstruction": {
    "programId": "<string>",
    "accounts": [
      {
        "pubkey": "<string>",
        "isWritable": true,
        "isSigner": true
      }
    ],
    "data": "<string>"
  },
  "cleanupInstruction": {
    "programId": "<string>",
    "accounts": [
      {
        "pubkey": "<string>",
        "isWritable": true,
        "isSigner": true
      }
    ],
    "data": "<string>"
  },
  "otherInstructions": [
    {
      "programId": "<string>",
      "accounts": [
        {
          "pubkey": "<string>",
          "isWritable": true,
          "isSigner": true
        }
      ],
      "data": "<string>"
    }
  ],
  "tipInstruction": {
    "programId": "<string>",
    "accounts": [
      {
        "pubkey": "<string>",
        "isWritable": true,
        "isSigner": true
      }
    ],
    "data": "<string>"
  },
  "addressesByLookupTableAddress": {},
  "transactionVersion": 0,
  "computeUnitPrice": "<string>",
  "blockhashWithMetadata": {
    "blockhash": [
      123
    ],
    "lastValidBlockHeight": 123,
    "fetchedAt": {
      "secs_since_epoch": 123,
      "nanos_since_epoch": 123
    }
  }
}

{
  "error": "<string>"
}

GET

build

Build Transaction

curl --request GET \
  --url https://api.jup.ag/swap/v2/build \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.jup.ag/swap/v2/build', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jup.ag/swap/v2/build",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jup.ag/swap/v2/build"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.jup.ag/swap/v2/build")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "inputMint": "<string>",
  "outputMint": "<string>",
  "inAmount": "<string>",
  "outAmount": "<string>",
  "otherAmountThreshold": "<string>",
  "swapMode": "<string>",
  "slippageBps": 123,
  "priceImpactPct": "<string>",
  "routePlan": [
    {
      "swapInfo": {
        "ammKey": "<string>",
        "label": "<string>",
        "inputMint": "<string>",
        "outputMint": "<string>",
        "inAmount": "<string>",
        "outAmount": "<string>"
      },
      "percent": 123,
      "bps": 123,
      "usdValue": 123
    }
  ],
  "computeBudgetInstructions": [
    {
      "programId": "<string>",
      "accounts": [
        {
          "pubkey": "<string>",
          "isWritable": true,
          "isSigner": true
        }
      ],
      "data": "<string>"
    }
  ],
  "setupInstructions": [
    {
      "programId": "<string>",
      "accounts": [
        {
          "pubkey": "<string>",
          "isWritable": true,
          "isSigner": true
        }
      ],
      "data": "<string>"
    }
  ],
  "swapInstruction": {
    "programId": "<string>",
    "accounts": [
      {
        "pubkey": "<string>",
        "isWritable": true,
        "isSigner": true
      }
    ],
    "data": "<string>"
  },
  "cleanupInstruction": {
    "programId": "<string>",
    "accounts": [
      {
        "pubkey": "<string>",
        "isWritable": true,
        "isSigner": true
      }
    ],
    "data": "<string>"
  },
  "otherInstructions": [
    {
      "programId": "<string>",
      "accounts": [
        {
          "pubkey": "<string>",
          "isWritable": true,
          "isSigner": true
        }
      ],
      "data": "<string>"
    }
  ],
  "tipInstruction": {
    "programId": "<string>",
    "accounts": [
      {
        "pubkey": "<string>",
        "isWritable": true,
        "isSigner": true
      }
    ],
    "data": "<string>"
  },
  "addressesByLookupTableAddress": {},
  "transactionVersion": 0,
  "computeUnitPrice": "<string>",
  "blockhashWithMetadata": {
    "blockhash": [
      123
    ],
    "lastValidBlockHeight": 123,
    "fetchedAt": {
      "secs_since_epoch": 123,
      "nanos_since_epoch": 123
    }
  }
}

{
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Get API key via https://developers.jup.ag/portal

Query Parameters

inputMint

string

required

The mint address of the input token

outputMint

string

required

The mint address of the output token

amount

string

required

The amount to swap in the smallest unit of the input token

taker

string

required

Public key of the user initiating the swap.

slippageBps

default:50

Slippage tolerance in basis points. Defaults to 50.

Available options:

rtse

mode

enum<string>

Quoting mode. "fast" trades quote optimality for reduced latency.

Available options:

fast

dexes

string

Comma-separated list of DEXes to restrict routing to.
Labels are case sensitive (SolFi, not solfi). An unrecognised label is not a validation error: it returns 400 {"error": "No routes found"}, indistinguishable from a pair with no liquidity.
Mutually exclusive with excludeDexes. Passing both returns 400 {"error": "dexes and excludeDexes are mutually exclusive"}.
Full list of DEXes here using the /program-id-to-label endpoint.

excludeDexes

string

Comma-separated list of DEXes to exclude.
Labels are case sensitive (SolFi, not solfi).
Mutually exclusive with dexes.
Full list of DEXes here using the /program-id-to-label endpoint.

platformFeeBps

integer

Platform fee in basis points. If positive, feeAccount is required.

Required range: 0 <= x <= 10000

feeAccount

string

Token account to collect platform fees. Required if platformFeeBps is positive.

maxAccounts

integer

Maximum number of accounts for the swap route. Defaults to 64.

Required range: 1 <= x <= 64

payer

string

Account that pays transaction fees and rent. Defaults to taker when not passed in.

wrapAndUnwrapSol

boolean

Whether to wrap/unwrap SOL. Defaults to true.

destinationTokenAccount

string

SPL token account to receive output tokens.
Mutually exclusive with nativeDestinationAccount.

nativeDestinationAccount

string

Native SOL account to receive output.
Mutually exclusive with destinationTokenAccount.

blockhashSlotsToExpiry

integer

Number of slots until the blockhash expires. Defaults to 150.

Required range: 1 <= x <= 300

tipAmount

string

SOL tip amount in lamports. Adds a tip instruction for use with /submit. The tip payer is the taker (or payer if specified).

computeUnitPricePercentile

Percentile of compute unit price to use. Named levels: "medium" (25th), "high" (50th), "veryHigh" (75th), or a number 0-10000 in basis points.

Available options:

medium,

high,

veryHigh

forJitoBundle

boolean

default:false

Set to true if the transaction will be submitted as part of a Jito bundle. This excludes DEXes that are incompatible with Jito bundles.

transactionVersion

enum<string>

default:0

The Solana transaction version to build for, "0" or "1". Defaults to "0". "1" returns v1 instructions: computeBudgetInstructions is empty and addressesByLookupTableAddress is {} (v1 inlines accounts, no lookup tables). Set the compute budget, including the returned computeUnitPrice, on the message config. Build with a v1-capable SDK (@solana/kit v8 or later).

Available options:

0,

1

Response

Quote with raw swap instructions

inputMint

string

outputMint

string

inAmount

string

outAmount

string

otherAmountThreshold

string

Minimum output amount after slippage

swapMode

string

slippageBps

number

priceImpactPct

string

Price impact of the swap as a decimal ratio (e.g. "0.001" = 0.1%)

routePlan

object[]

Show child attributes

computeBudgetInstructions

object[]

Compute unit price instruction (does not include compute unit limit). Empty when transactionVersion is "1"; use computeUnitPrice on the message config instead.

Show child attributes

setupInstructions

object[]

Pre-swap setup instructions (e.g. create ATAs)

Show child attributes

swapInstruction

object

Show child attributes

cleanupInstruction

object | null

Post-swap cleanup instruction

Show child attributes

otherInstructions

object[]

Show child attributes

tipInstruction

object | null

Show child attributes

addressesByLookupTableAddress

object | null

Address lookup table mappings for v0 transactions. Empty object ({}) when transactionVersion is "1" (v1 inlines accounts, no lookup tables).

Show child attributes

transactionVersion

enum<number>

The Solana transaction version these instructions are for, 0 or 1, matching the transactionVersion request parameter.

Available options:

0,

1

computeUnitPrice

string

Present when transactionVersion is "1". Compute unit price in micro-lamports, to set on the message config.

blockhashWithMetadata

object

Show child attributes

Swap

Meta-Aggregator

Metis (Onchain Router)

Advanced

Routing Integration

Guides

Migration

Build Transaction

Authorizations

Query Parameters

Response