GetSwapInstructions

Error

A valid request URL is required to generate request examples

{
  "router_address": "<string>",
  "src_token": "<string>",
  "amount_in": "<string>",
  "bridge_token": "<string>",
  "min_bridge_out": "<string>",
  "evm": {
    "aggregator": "<string>",
    "swap_calldata": "<string>",
    "value": "<string>"
  },
  "svm": {
    "setup": [
      {
        "program_id": "<string>",
        "accounts": [
          {
            "pubkey": "<string>",
            "is_signer": true,
            "is_writable": true
          }
        ],
        "data": "<string>"
      }
    ],
    "swap": {
      "program_id": "<string>",
      "accounts": [
        {
          "pubkey": "<string>",
          "is_signer": true,
          "is_writable": true
        }
      ],
      "data": "<string>"
    },
    "cleanup": [
      {
        "program_id": "<string>",
        "accounts": [
          {
            "pubkey": "<string>",
            "is_signer": true,
            "is_writable": true
          }
        ],
        "data": "<string>"
      }
    ],
    "lookup_tables": [
      {
        "address": "<string>",
        "addresses": [
          "<string>"
        ]
      }
    ]
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {}
  ]
}

GET

quotes

{quote_hash}

instructions

Error

A valid request URL is required to generate request examples

{
  "router_address": "<string>",
  "src_token": "<string>",
  "amount_in": "<string>",
  "bridge_token": "<string>",
  "min_bridge_out": "<string>",
  "evm": {
    "aggregator": "<string>",
    "swap_calldata": "<string>",
    "value": "<string>"
  },
  "svm": {
    "setup": [
      {
        "program_id": "<string>",
        "accounts": [
          {
            "pubkey": "<string>",
            "is_signer": true,
            "is_writable": true
          }
        ],
        "data": "<string>"
      }
    ],
    "swap": {
      "program_id": "<string>",
      "accounts": [
        {
          "pubkey": "<string>",
          "is_signer": true,
          "is_writable": true
        }
      ],
      "data": "<string>"
    },
    "cleanup": [
      {
        "program_id": "<string>",
        "accounts": [
          {
            "pubkey": "<string>",
            "is_signer": true,
            "is_writable": true
          }
        ],
        "data": "<string>"
      }
    ],
    "lookup_tables": [
      {
        "address": "<string>",
        "addresses": [
          "<string>"
        ]
      }
    ]
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {}
  ]
}

rpc GetSwapInstructions(SwapInstructionsRequest) returns (SwapInstructions)

Builds a fresh route for a quote that has a source swap leg — one where order_params.src_token differs from order_params.bridge_token_src. Call it immediately before sending the deposit; routing reflects pool state at build time.

Request

string

required

Hash returned by GetQuote.

Response

string

Contract the deposit call goes to: the ApsisRouter on EVM chains, the program id on Solana.

string

Input token.

string

Input amount, base units.

string

Output token of the swap. For a cross-chain quote this is the asset that bridges; for a same-chain quote it is the destination token.

string

Floor the swap output is checked against on chain.

The payload is a oneof matching the source chain’s VM.

EVM: `evm`

string

Aggregator the router will call. Allowlisted on the contract.

string

0x hex calldata to pass through.

string

Transaction value to attach. Non-zero only when the source token is the chain’s native asset.

Solana: `svm`

SvmInstruction[]

Instructions to run before the swap, such as creating token accounts.

SvmInstruction

The aggregator swap instruction. The deposit wraps it in the program’s deposit_swap instruction, which runs the swap and checks the output against min_bridge_out.

SvmInstruction[]

Instructions to run after the swap.

SvmLookupTable[]

Address lookup tables to attach to the versioned transaction.

Each SvmInstruction carries program_id, accounts (pubkey, is_signer, is_writable), and base64 data.

Using it

On EVM, map the fields straight onto the router call:

const swap = await apsis.getSwapInstructions({ quoteHash });
if (swap.payload.case !== "evm") throw new Error("expected evm instructions");
const evm = swap.payload.value;

await wallet.sendTransaction({
  to: swap.routerAddress,
  value: BigInt(evm.value),
  data: encodeFunctionData({
    abi: routerAbi,
    functionName: "depositWithSwap",
    args: [
      quoteHash,
      swap.srcToken,
      BigInt(swap.amountIn),
      evm.aggregator,
      evm.swapCalldata,
      swap.bridgeToken,
      BigInt(swap.minBridgeOut),
    ],
  }),
});

On Solana, buildSvmSwapDeposit in the SDK assembles the versioned transaction from the payload. Same-chain quotes on EVM use the same instructions with swapAndForward instead; see Same-chain swaps.

Errors

Code	Message	When
`INVALID_ARGUMENT`	`quote is not a source swap`	The quote’s source token is already the bridge token. No instructions exist.
`INVALID_ARGUMENT`	`invalid quote hash`	Not a 32-byte hex hash.
`NOT_FOUND`	`quote not found or expired`	No stored quote with that hash.
`UNAVAILABLE`	`aggregator error`	The aggregator failed or returned no route.
`UNAVAILABLE`	`source route output below committed minimum`	The live route no longer clears the floor committed in the quote. Re-quote.

The last one means the market moved after the quote was issued. Getting a new quote is the correct response; retrying the instructions will keep failing while the route is worse than what was promised.

Authorizations

x-api-key

string

header

required

Path Parameters

quote_hash

string

required

Response

Exactly one of evm, svm is set.

router_address

string

src_token

string

amount_in

string

bridge_token

string

min_bridge_out

string

evm

object

Show child attributes

svm

object

Show child attributes

Reference

Blockchain

GetSwapInstructions

Request

Response

EVM: `evm`

Solana: `svm`

Using it

Errors

Authorizations

Path Parameters

Response

​Request

​Response

​EVM: evm

​Solana: svm

​Using it

​Errors

Authorizations

Path Parameters

Response

Request

Response

EVM: `evm`

Solana: `svm`

Using it

Errors