Get a quote

GetQuote prices a trade and persists it. The quote_hash it returns is what the deposit carries, so call it once the user is ready to act. For prices that update as the user types, use PreviewQuote, which is identical minus the persistence and the addresses.

Request

Field	Required	Notes
`src_chain`, `dst_chain`	yes	Lowercase chain names. Equal values produce a same-chain swap quote.
`src_token`, `dst_token`	yes	Token addresses from the catalog.
`trade_type`	yes	Which side `amount` fixes and whether the output is guaranteed. See Trade types.
`amount`	yes	Decimal string in base units: source token’s for exact input, destination token’s for expected output.
`recipient`	yes	Destination address. Must match the destination chain’s address format.
`refund_address`	yes	Source-chain address a refund is paid to.
`depositor`	no	Source-chain wallet that will sign the deposit. Defaults to `refund_address`. Set it when another wallet deposits: a Solana deposit that swaps first is built for this wallet.
`gas_drop`	yes	Native asset to deliver on the destination, in base units. Empty string for none.
`slippage_bps`	no	Slippage for the whole route: `min_amount_out` is `amount_out` less this. Omit to let the operator pick a tier for each leg. See Slippage.
`src_slippage_bps`	no	Floor for the source swap leg. Applies only when `slippage_bps` is omitted.
`referrers`	no	Referrer addresses and their basis points. Request the quote with your API key: a keyless quote validates the list, then drops it and charges no referrer fee. See Referral program.
`gasless`	no	Price the quote for a relayed, signature-only deposit. See Sponsoring gas.
`sponsor_fees`	no	With `gasless`, charge the relay gas to your partner funding balance. Requires an API key. See Sponsoring gas.
`sponsor_gas_max`	no	With `sponsor_fees`, the most relay gas your balance covers, in base units of the source chain’s native asset. The rest comes out of the user’s output. See Sponsoring gas.

TypeScript SDK
Wire

import { TradeType, quoteOf, isSameChainSwap } from "@mayanfinance/blink-sdk";

const response = await blink.getQuote({
  srcChain: "arbitrum",
  dstChain: "solana",
  srcToken: src.address,
  dstToken: dst.address,
  tradeType: TradeType.EXACT_INPUT,
  amount: "25000000",
  recipient: userAddress,
  refundAddress: userAddress,
  gasDrop: "2000000",
  referrers: [{ address: myFeeAddress, bps: 10 }],
});

const quote = quoteOf(response);
if (!quote) throw new Error("no quote");

grpcurl \
  -H "x-api-key: $BLINK_API_KEY" \
  -d '{
    "src_chain": "arbitrum",
    "dst_chain": "solana",
    "src_token": "0x...",
    "dst_token": "EPjF...",
    "trade_type": "TRADE_TYPE_EXACT_INPUT",
    "amount": "25000000",
    "recipient": "EPjF...",
    "refund_address": "0x...",
    "gas_drop": "2000000",
    "referrers": [{ "address": "0x...", "bps": 10 }]
  }' \
  $BLINK_HOST blink.v1.BlinkApi/GetQuote

Response

QuoteResponse is a oneof: cross_chain or same_chain_swap. Both carry the fields below (cross_chain adds the gasless fields, see GetQuote), so read the case and branch on execution, not on shape.

Field	Use
`quote_hash`	Bind the deposit to it. Store it before signing.
`amount_in`	The deposit amount. Echoes the request for exact input; the solved input for expected output.
`amount_out`	Expected output, already net of every fee.
`min_amount_out`	Guaranteed floor. Show it alongside the expected output.
`slippage_bps`	The `slippage_bps` you sent, or, when omitted, the gap between `amount_out` and `min_amount_out`.
`is_guaranteed`	On `cross_chain`, whether `amount_out` is committed. See Guaranteed quotes.
`fee_breakdown`	Itemized costs. See Fees.
`router_address`	The contract to deposit into. Use this, not a hardcoded address.
`order_params`	The full bound parameter set, needed to build the deposit.
`expires_at`	Expiry timestamp, 30 minutes after issuance. Re-quote past it; the SDK’s `isQuoteExpired(quote)` checks it, and the chain adapters refuse to build deposit steps for an expired quote when `expiresAt` is passed in the options.
`amount_in_usd_micros`, `amount_out_usd_micros`	Notional values for display. Optional; absent when a price is unavailable.

Preview while typing

PreviewQuote takes the same economic inputs and omits recipient and refund_address. It returns amount_out, min_amount_out, slippage_bps, fee_breakdown, and the same_chain_swap and is_guaranteed flags, without writing anything.

const preview = await blink.previewQuote({
  srcChain: "arbitrum",
  dstChain: "solana",
  srcToken: src.address,
  dstToken: dst.address,
  tradeType: TradeType.EXACT_INPUT,
  amount: "25000000",
  gasDrop: "",
});

Debounce it against the amount field, then call GetQuote when the user commits.

Quoting from the output side

When the user edits the buy field instead of the sell field, quote with TRADE_TYPE_EXPECTED_OUTPUT and pass the desired payout as amount, in the destination token’s base units. The response’s amount_in is the deposit that achieves it; render it in the sell field and build the deposit from order_params as usual. See Trade types for how it is priced and the 50 bps slippage default.

Refresh before signing

A quote’s price is fixed when it is issued and does not track the market. Re-quote if the user has been sitting on a confirmation screen: refreshing costs one request, while a stale quote either prices badly or, if the market moved past a floor, fails to fill and refunds. A common pattern is to re-quote on an interval while a confirmation screen is open, and to block the deposit button during the refresh so the hash being signed is always the one displayed.

Source swaps

When src_token differs from lock_token in the returned params, the deposit has to route through an aggregator on the source chain. That routing is not in the quote; on EVM and Solana fetch it with GetSwapInstructions at deposit time so it is fresh. See Deposit on EVM. On Sui the user opens a swap intent and the relayer routes it; see Deposit on Sui.

Failures

Quote failures split cleanly. INVALID_ARGUMENT means the request itself is wrong (unsupported pair, size outside the accepted band, gas drop over the cap) and retrying it unchanged will fail again. UNAVAILABLE means the operator cannot price right now (insufficient inventory, a stale price feed, an aggregator that did not respond) and the same request may succeed shortly after. See Error handling.

Get started

Build a swap

Extend

Request

Response

Preview while typing

Quoting from the output side

Refresh before signing

Source swaps

Failures

​Request

​Response

​Preview while typing

​Quoting from the output side

​Refresh before signing

​Source swaps

​Failures

Request

Response

Preview while typing

Quoting from the output side

Refresh before signing

Source swaps

Failures