getFlowQuote

getFlowQuote

Fetches a conversion quote for a flow. The quote includes the amounts, fees, estimated time, and an expiry. Call this after attaching a source.

When to call

Call getFlowQuote when executionState is source_attached, quoted, or signing. Calling it from quoted refreshes the quote. Calling it from signing returns the flow to quoted, so do not reuse the previous signing payload.

Before restoring or retrying a flow, call getFlow and check its current state.

If the flow is initiated, attach a source first. Do not call getFlowQuote after broadcasted or source_confirmed; poll the existing flow instead. If the flow is cancelled, expired, or failed, create a new flow for another attempt. Calling from any unsupported state returns 409.

Usage

import { getFlowQuote } from '@dynamic-labs-sdk/client';

const flow = await getFlowQuote({
  flowId: 'your-flow-id',
  fromTokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
});

console.log('Send:', flow.quote.fromAmount);
console.log('Receive:', flow.quote.toAmount);
console.log('Fees:', flow.quote.fees?.totalFeeUsd);

Parameters

Parameter	Type	Description
flowId	string	The flow ID.
fromTokenAddress	string (optional)	Token contract address (EVM) or mint (Solana) the sender is paying with. Defaults to the native token for the chain set during source attachment. Use 0x0000000000000000000000000000000000000000 for native ETH, or 11111111111111111111111111111111 for native SOL.
fromChainId	string (optional)	Override the chain ID recorded at source attachment. The chain family (fromChainName) is locked at attachment: to switch families, call attachFlowSource again.
slippage	number (optional)	Slippage tolerance as a decimal (e.g., 0.005 for 0.5%).

Returns

Promise<Flow>: the updated flow with quote populated:

type FlowTokenInfo = {
  symbol: string;
  decimals: number;
  name?: string;
  logoURI?: string;
};

type FlowQuote = {
  version: number;
  fromAmount: string;
  toAmount: string;
  fromTokenInfo?: FlowTokenInfo;
  toTokenInfo?: FlowTokenInfo;
  estimatedTimeSec?: number;
  fees?: {
    totalFeeUsd?: string;
    gasEstimate?: {
      usdValue: string;
      nativeValue: string;
      nativeSymbol: string;
    };
  };
  createdAt: string;
  expiresAt: string;
};

fromAmount/toAmount are raw integer strings in the token’s smallest unit. Use fromTokenInfo.decimals/toTokenInfo.decimals to convert to a human-readable value (e.g. "1500000" with decimals: 6 is 1.5).

Quotes expire in 60 seconds. If the quote expires before you submit, call getFlowQuote again.

Examples

Quote with a specific ERC-20 token

import { getFlowQuote } from '@dynamic-labs-sdk/client';

const flow = await getFlowQuote({
  flowId: 'your-flow-id',
  fromTokenAddress: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913', // USDC on Base
});

Quote with native ETH

import { getFlowQuote } from '@dynamic-labs-sdk/client';

const flow = await getFlowQuote({
  flowId: 'your-flow-id',
  fromTokenAddress: '0x0000000000000000000000000000000000000000',
});

Deposit address source

For deposit address flows, flow.depositAddress is the address the user sends funds to. We recommend displaying it as a QR code and encoding the amount from flow.quote.fromAmount so wallets can pre-fill both fields on scan. fromAmount is a raw integer string in the token’s smallest unit — divide by 10 ** flow.quote.fromTokenInfo.decimals to get the decimal amount for URI schemes that expect one (e.g., bitcoin:, solana:). See the deposit address section of the JS SDK guide for a buildDepositUri helper that handles BTC, SOL, EVM (EIP-681), and TRON URI formats.

Quote with slippage tolerance

import { getFlowQuote } from '@dynamic-labs-sdk/client';

const flow = await getFlowQuote({
  flowId: 'your-flow-id',
  fromTokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
  slippage: 0.005,
});

React

useGetFlowQuote is a mutation hook. Call mutate to request a quote on demand:

import { useGetFlowQuote } from '@dynamic-labs-sdk/react-hooks';

function QuoteButton({ flowId }) {
  const { mutate: getQuote, data: flow, isPending } = useGetFlowQuote();

  return (
    <div>
      <button
        onClick={() => getQuote({ flowId, fromTokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' })}
        disabled={isPending}
      >
        {isPending ? 'Quoting...' : 'Get Quote'}
      </button>
      {flow?.quote && (
        <p>Send {flow.quote.fromAmount} → Receive {flow.quote.toAmount}</p>
      )}
    </div>
  );
}

Related

• Fireblocks Flow JavaScript SDK guide - End-to-end flow guide
• attachFlowSource - Attach a wallet or exchange source
• submitFlowTransaction - Submit for signing and broadcast
• prepareFlowSigning - Prepare signing (advanced)