Estimate a swap

GET

orchestration

estimate

Estimate a swap

curl --request GET \
  --url https://orchestration.flashnet.xyz/v1/orchestration/estimate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://orchestration.flashnet.xyz/v1/orchestration/estimate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://orchestration.flashnet.xyz/v1/orchestration/estimate"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "amountMode": "exact_in",
  "estimatedOut": "99000000",
  "feeAmount": "500000",
  "roundingFeeAmount": "0",
  "totalFeeAmount": "500000",
  "feeBps": 50,
  "feeAsset": "USDC",
  "route": [
    "BTC",
    "USDB",
    "USDC"
  ],
  "source": {
    "chain": "bitcoin",
    "asset": "BTC",
    "assetDisplayName": "Bitcoin",
    "assetDisplaySymbol": "BTC",
    "contractAddress": null,
    "decimals": 8,
    "chainId": null,
    "chainDisplayName": "Bitcoin",
    "chainIcon": "/btc.svg"
  },
  "destination": {
    "chain": "solana",
    "asset": "USDC",
    "assetDisplayName": "USDC",
    "assetDisplaySymbol": "USDC",
    "contractAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "decimals": 6,
    "chainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
    "chainDisplayName": "Solana",
    "chainIcon": "/chain-solana.svg"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Partner API key in the form Authorization: Bearer fn_....

Query Parameters

sourceChain

enum<string>

required

Available options:

arbitrum,

arc,

avalanche,

base,

bitcoin,

bsc,

ethereum,

hedera,

hypercore,

hyperevm,

lightning,

litecoin,

monad,

monero,

optimism,

plasma,

polygon,

robinhood,

sei,

solana,

spark,

tempo,

ton,

tron,

xrp,

zcash

sourceAsset

required

An AssetInput, or a token address. A quote whose source is an unlisted token requires refundAddress: a deposit that cannot be sold is refunded in kind there.

Available options:

AAPL,

AI,

AMD,

AMZN,

BNB,

BONER,

BTC,

CASHCAT,

COIN,

COST,

DAI,

DELTA,

DJT,

ETH,

GLD,

GME,

GOOGL,

GRAM,

HIMS,

HSUSD,

HYPE,

IF,

LTC,

META,

MON,

MSFT,

MSTR,

MU,

NVDA,

OUSD,

PIPEDOG,

PLTR,

POL,

PONS,

PYUSD,

PathUSD,

QQQ,

RDDT,

SHX,

SKHY,

SLV,

SNDK,

SOL,

SPCX,

SPY,

STONKBROKER,

TENDIES,

TRX,

TSLA,

TSM,

UP,

USDB,

USDC,

USDC.e,

USDG,

USDT,

USDe,

USD₮0,

USO,

WBNB,

WBTC,

WEN,

XMR,

XO,

XPL,

XRP,

ZEC,

cbBTC,

tBTC

destinationChain

enum<string>

required

Available options:

arbitrum,

arc,

avalanche,

base,

bitcoin,

bsc,

ethereum,

hedera,

hypercore,

hyperevm,

lightning,

litecoin,

monad,

monero,

optimism,

plasma,

polygon,

robinhood,

sei,

solana,

spark,

tempo,

ton,

tron,

xrp,

zcash

destinationAsset

required

An AssetInput, or a token address. An unlisted destination adds minAmountOut and fallback to the quote.

Available options:

AAPL,

AI,

AMD,

AMZN,

BNB,

BONER,

BTC,

CASHCAT,

COIN,

COST,

DAI,

DELTA,

DJT,

ETH,

GLD,

GME,

GOOGL,

GRAM,

HIMS,

HSUSD,

HYPE,

IF,

LTC,

META,

MON,

MSFT,

MSTR,

MU,

NVDA,

OUSD,

PIPEDOG,

PLTR,

POL,

PONS,

PYUSD,

PathUSD,

QQQ,

RDDT,

SHX,

SKHY,

SLV,

SNDK,

SOL,

SPCX,

SPY,

STONKBROKER,

TENDIES,

TRX,

TSLA,

TSM,

UP,

USDB,

USDC,

USDC.e,

USDG,

USDT,

USDe,

USD₮0,

USO,

WBNB,

WBTC,

WEN,

XMR,

XO,

XPL,

XRP,

ZEC,

cbBTC,

tBTC

amount

string

required

Pattern: ^[0-9]+$

amountMode

enum<string>

Available options:

exact_in,

exact_out

deliveryMode

enum<string>

Delivery mode; fixed requires exact_in and an eligible route with active partner terms. A route accepts fixed only where /v2/orchestration/routes reports fixedEligible (fixedTo); other routes return 400 fixed_delivery_unsupported_route. Fixed estimates are indicative; quotes validate exact-output affordability before returning deposit instructions. Fixed stablecoin routes to Solana USDC include recipient token-account creation costs upfront and preserve the quoted payout.

Available options:

variable,

fixed

recipientAddress

string

Destination recipient for validation and network costs; use the owner address for Solana tokens.

Minimum string length: 1

slippageBps

integer

Required range: 0 <= x <= 1000

affiliateErrorMode

enum<string>

Opt in to affiliate_not_found / affiliate_disabled for registered affiliate lookup failures. Omitted or legacy preserves invalid_request. HTTP 400 in either mode.

Available options:

legacy,

specific

sourcePaymentMode

enum<string>

Shielded is native ZEC exact-in variable only. No account or provider deposit is allocated by estimates.

Available options:

default,

shielded

routing

enum<string>

Available options:

best_return

allowedProviders

string

Shielded only: comma-separated near-intents and/or hyperunit, without duplicates.

maxEstimatedSettlementSeconds

integer

Shielded only: upper bound for eligible provider estimates.

Response

Quote estimate

estimatedOut

string

required

feeAmount

string

required

feeBps

integer

required

feeAsset

string

required

route

string[]

required

source

object

required

Show child attributes

destination

object

required

Show child attributes

sourcePaymentMode

enum<string>

Available options:

shielded

priceValidUntil

string<date-time>

Two-minute indicative pricing deadline. Execution reprices after verified receipt and must preserve lockedMinAmountOut.

execution

object

Show child attributes

amountMode

enum<string>

Available options:

exact_in,

exact_out

targetAmountOut

string

requiredAmountIn

string

maxAcceptedAmountIn

string

inputBufferBps

integer

deliveryMode

enum<string>

Available options:

fixed

roundingFeeAmount

string

totalFeeAmount

string

networkCostAmount

string

Quoted network cost in smallest units of networkCostAsset.

networkCostAsset

string

Asset used to pay the quoted network cost.

networkCostRequired

boolean

Whether the quoted network cost must be paid.

networkCosts

object[]

Itemized network costs and quote-time assumptions.

Option 1
Option 2
Option 3

Show child attributes

appFeeAmount

string

appFeePlatformCutAmount

string

appFees

object[]

Show child attributes

feeAssetDetails

object

Show child attributes

feeAmountUsd

string

totalFeeAmountUsd

string

minAmountOut

string

Unlisted destinations only: the least amount of the token, in its smallest units, the recipient receives when the swap succeeds. Enforced on chain at the recipient.

fallback

object

Unlisted destinations only: what the recipient receives if the swap into the token cannot deliver minAmountOut.

Show child attributes

⌘I

Estimate a swap

curl --request GET \
  --url https://orchestration.flashnet.xyz/v1/orchestration/estimate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://orchestration.flashnet.xyz/v1/orchestration/estimate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://orchestration.flashnet.xyz/v1/orchestration/estimate"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "amountMode": "exact_in",
  "estimatedOut": "99000000",
  "feeAmount": "500000",
  "roundingFeeAmount": "0",
  "totalFeeAmount": "500000",
  "feeBps": 50,
  "feeAsset": "USDC",
  "route": [
    "BTC",
    "USDB",
    "USDC"
  ],
  "source": {
    "chain": "bitcoin",
    "asset": "BTC",
    "assetDisplayName": "Bitcoin",
    "assetDisplaySymbol": "BTC",
    "contractAddress": null,
    "decimals": 8,
    "chainId": null,
    "chainDisplayName": "Bitcoin",
    "chainIcon": "/btc.svg"
  },
  "destination": {
    "chain": "solana",
    "asset": "USDC",
    "assetDisplayName": "USDC",
    "assetDisplaySymbol": "USDC",
    "contractAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "decimals": 6,
    "chainId": "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
    "chainDisplayName": "Solana",
    "chainIcon": "/chain-solana.svg"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Get started

Endpoints

Authorizations

Query Parameters

Response