Create quote

Firm price for 2 minutes plus a deposit address. Paying the address creates the order. Fresh quotes and successful idempotency replays screen the effective recipient, refund and fee addresses with Hermod; replays use frozen quote terms. Hermod starts in log-only mode and rejects hits with the existing sanctioned_address response only when enforcement is enabled. OFAC screening remains independently enforced. A screening rejection does not overwrite the successful quote or start a replacement quote. HyperCore source routes are unavailable until independent deposit verification is supported; HyperCore destinations remain supported.

POST

orchestration

quote

Create quote

curl --request POST \
  --url https://orchestration.flashnet.xyz/v1/orchestration/quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "sourceChain": "base",
  "sourceAsset": "USDC",
  "destinationChain": "spark",
  "destinationAsset": "BTC",
  "amount": "50000000",
  "recipientAddress": "RECIPIENT_ADDRESS"
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    sourceChain: 'base',
    sourceAsset: 'USDC',
    destinationChain: 'spark',
    destinationAsset: 'BTC',
    amount: '50000000',
    recipientAddress: 'RECIPIENT_ADDRESS'
  })
};

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

import requests

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

payload = {
    "sourceChain": "base",
    "sourceAsset": "USDC",
    "destinationChain": "spark",
    "destinationAsset": "BTC",
    "amount": "50000000",
    "recipientAddress": "RECIPIENT_ADDRESS"
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amountMode": "exact_in",
  "estimatedOut": "99000000",
  "feeAmount": "500000",
  "roundingFeeAmount": "0",
  "totalFeeAmount": "500000",
  "feeBps": 50,
  "feeAsset": "USDC",
  "route": [
    "BTC",
    "USDB",
    "USDC"
  ],
  "quoteId": "q_7e450ab4-935b-4f8d-a6c4-4987a3cd2831",
  "depositAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "amountIn": "100000",
  "expiresAt": "2026-09-12T12:02:00.000Z",
  "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>"
  }
}

{
  "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_....

Headers

X-Idempotency-Key

string

required

Minimum string length: 1

Body

application/json

Unknown top-level fields are ignored rather than rejected.

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

Amount in smallest units of the source asset, or destination asset for exact_out; stablecoin exact_out amounts require whole cents.

Pattern: ^[0-9]+$

recipientAddress

string

required

Destination recipient; use the owner address for Solana tokens, or a Lightning address or compatible BOLT11 invoice for Lightning.

Minimum string length: 1

sourcePaymentMode

enum<string>

Opt in to Orchard funding for zcash:ZEC, exact_in and variable only. Omitted/default preserves transparent funding. Requires an admitted partner and refund address.

Available options:

default,

shielded

executionPolicy

object

Shielded provider policy; ignored for legacy funding.

Show child attributes

amountMode

enum<string>

exact_out pins the destination amount and requires whole cents for stablecoins.

Available options:

exact_in,

exact_out

deliveryMode

enum<string>

Delivery mode; new fixed delivery requires exact_in and an enabled reviewed XChain route with active partner terms. Canonical fixed delivery is unavailable; disabled XChain admission never falls back to canonical. 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

flexibleAmount

boolean

lightning:BTC exact-in variable only: mint an amountless invoice. amount prices an indicative size; the order runs on whatever amount is paid.

descriptionHash

string

lightning:BTC sources only: SHA-256 hex of your LNURL-pay metadata string. The minted BOLT11 carries it as the description hash (h tag) instead of a memo, for wallets that still verify LUD-06. Rejected on other sources.

Pattern: ^[0-9a-fA-F]{64}$

includeCalldata

boolean

Include transaction calldata to fund the order. Supported for EVM native and ERC-20 sources only; unsupported sources return calldata_unsupported_source. Defaults to false.

refundChain

enum<string>

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

refundAddress

string

Source-chain refund address where required by the route; sanctioned addresses are rejected. Required when sourceAsset is an unlisted token (invalid_request otherwise): a deposit that cannot be sold is refunded there in the source token. For zcash:ZEC sources, a supplied nonblank refund address must be a checksum-valid mainnet transparent t1 or t3 address; invalid targets return invalid_refund_address before pricing.

Minimum string length: 1

slippageBps

integer

Slippage tolerance in basis points, subject to the route minimum.

Required range: 0 <= x <= 1000

appFees

object[]

Inline app fees, requiring a server key or dashboard session.

Required array length: 1 - 16 elements

Show child attributes

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. Changing this field requires a new idempotency key.

Available options:

legacy,

specific

affiliateId

string

Registered affiliate ID for accrued fees, also accepted from client keys.

affiliateIds

(string | object)[]

Registered affiliate IDs or fee overrides; mutually exclusive with appFees, with overrides requiring a server key or dashboard session.

Required array length: 1 - 16 elements

Registered affiliate ID or { affiliateId, feeBps } override.

Minimum string length: 1

tag

string | null

Your own reporting label, such as an integrator ID. Every order this quote funds carries it, and the dashboard filters and groups by it. Self-reported: anyone holding the key that creates the quote chooses it.

Pattern: ^[A-Za-z0-9._:-]{1,64}$

Response

Quote created

quoteId

string

required

depositAddress

string

required

amountIn

string

required

estimatedOut

string

required

feeAmount

string

required

totalFeeAmount

string

required

feeAsset

string

required

feeBps

integer

required

route

string[]

required

expiresAt

string

required

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

funding

object

Show child attributes

reviewedAssets

object[]

Exact immutable reviewed token identities frozen by the native quote. Omitted for legacy or invalid snapshots; caller metadata cannot set these pins.

Required array length: 1 - 32 elements

Show child attributes

transaction

object

Unsigned deposit transfer, returned only with includeCalldata=true on supported EVM sources. No approval is needed. This funds the deposit; it does not execute the swap.

Show child attributes

depositMemo

string

Memo or tag required with the deposit when present.

lightningReceiveRequestId

string

flexibleAmount

enum<boolean>

The invoice is amountless. amountIn and estimatedOut price the indicative amount and are rescaled to the amount actually paid.

Available options:

true

amountMode

enum<string>

Available options:

exact_in,

exact_out

targetAmountOut

string

requiredAmountIn

string

maxAcceptedAmountIn

string

inputBufferBps

integer

deliveryMode

enum<string>

Available options:

fixed

priceLockMode

enum<string>

Action required when the locked price can no longer be honored.

Available options:

strict_requote,

approval_required

lockedMinAmountOut

string

Minimum locked destination amount in smallest units.

roundingFeeAmount

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

sweepFeeAmount

string

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

source

object

Show child attributes

destination

object

Show child attributes

tag

string | null

The request's tag; null when none was sent.

readToken

string

Client-key read token for this quote and its order, including private ZeroConf outcomes.

⌘I

Create quote

curl --request POST \
  --url https://orchestration.flashnet.xyz/v1/orchestration/quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "sourceChain": "base",
  "sourceAsset": "USDC",
  "destinationChain": "spark",
  "destinationAsset": "BTC",
  "amount": "50000000",
  "recipientAddress": "RECIPIENT_ADDRESS"
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    sourceChain: 'base',
    sourceAsset: 'USDC',
    destinationChain: 'spark',
    destinationAsset: 'BTC',
    amount: '50000000',
    recipientAddress: 'RECIPIENT_ADDRESS'
  })
};

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

import requests

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

payload = {
    "sourceChain": "base",
    "sourceAsset": "USDC",
    "destinationChain": "spark",
    "destinationAsset": "BTC",
    "amount": "50000000",
    "recipientAddress": "RECIPIENT_ADDRESS"
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amountMode": "exact_in",
  "estimatedOut": "99000000",
  "feeAmount": "500000",
  "roundingFeeAmount": "0",
  "totalFeeAmount": "500000",
  "feeBps": 50,
  "feeAsset": "USDC",
  "route": [
    "BTC",
    "USDB",
    "USDC"
  ],
  "quoteId": "q_7e450ab4-935b-4f8d-a6c4-4987a3cd2831",
  "depositAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "amountIn": "100000",
  "expiresAt": "2026-09-12T12:02:00.000Z",
  "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>"
  }
}

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

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

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

Get started

Endpoints

Create quote

Authorizations

Headers

Body

Response