Skip to main content
POST
Create quote

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,
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

TON is a legacy input alias for ton:GRAM only; responses use GRAM.

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,
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,
XPL,
XRP,
ZEC,
cbBTC,
tBTC
destinationChain
enum<string>
required
Available options:
arbitrum,
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

TON is a legacy input alias for ton:GRAM only; responses use GRAM.

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,
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,
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
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; read fixed-delivery destinations from /v2/orchestration/routes.

Available options:
variable,
fixed
refundChain
enum<string>
Available options:
arbitrum,
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.

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
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

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
depositMemo
string

Memo or tag required with the deposit when present.

lightningReceiveRequestId
string
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.

sweepFeeAmount
string
appFeeAmount
string
appFeePlatformCutAmount
string
appFees
object[]
feeAssetDetails
object
feeAmountUsd
string
totalFeeAmountUsd
string
readToken
string

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