Quote

Source chain ID for the input token. Required. Use the numeric chain ID configured in xPath for the chain that holds fromToken.

Destination chain ID for the output token. Required. Use the numeric chain ID configured in xPath for the chain that holds toToken.

Input token identifier on fromChain. Required. Pass the chain-specific token address or mint address exactly as xPath stores it for that chain. [VERIFY] Confirm the canonical native-token placeholder, if any, for each supported chain.

Output token identifier on toChain. Required. Pass the chain-specific token address or mint address exactly as xPath stores it for that chain. [VERIFY] Confirm the canonical native-token placeholder, if any, for each supported chain.

Input amount to quote, encoded as a base-10 integer string in the token's smallest unit. Required. Example: 1000000 for 1 USDC when the token has 6 decimals.

Wallet address that will supply the input token for the route. Required. This value is forwarded into quote planning and echoed back in the response.

Maximum slippage tolerance for the quoted route, expressed as a percentage. Optional. Example: 1 means 1%. If omitted, xPath does not set a route-level slippage value in the response and downstream providers may apply their own defaults. [VERIFY] Confirm whether a planner-wide default slippage is enforced when this field is absent.

Integrator fee in basis points, where 100 = 1%. Optional. Must be a non-negative integer. If omitted, no explicit integrator fee is requested.

Restricts quoting to the listed provider keys. Optional. Accepts a repeated query parameter or a comma-separated list. Matching is case-insensitive in the planner. If omitted, all providers remain eligible unless excluded by excludeProvider.

Removes the listed provider keys from consideration. Optional. Accepts a repeated query parameter or a comma-separated list. Matching is case-insensitive in the planner. If omitted, no providers are explicitly excluded.

[VERIFY] Preferred provider hint. Optional. The /quote handler currently accepts this field but does not pass it into route planning, so it has no documented effect today.

Route ranking strategy. Optional. Supported values currently recognized by the handler are fastest, max_value, and suggested. fastest ranks by speed, max_value ranks by output value, and suggested uses balanced ranking. Any other value, or omission, falls back to max_value.

Integrator identifier associated with the request. Optional. When provided, xPath echoes this value back as integratorId in each returned route.

[VERIFY] Referrer identifier for partner attribution. Optional. The /quote handler currently accepts this field but does not use it during quote planning or route shaping.

[VERIFY] Destination-chain call data to associate with the route. Optional. The /quote handler currently accepts this field but does not use it while building quotes.

[VERIFY] Destination-chain gas limit hint, encoded as a string integer. Optional. The /quote handler currently accepts this field but does not use it while building quotes.

[VERIFY] Maximum acceptable price impact for route selection. Optional. The /quote handler currently accepts this field but does not enforce planner-side filtering with it.

[VERIFY] Simulation-only hint. Optional. The /quote handler currently accepts this flag but does not branch on it when generating quotes.

Enables multi-bridge route candidates during planning. Optional. If true, xPath may return routes that use more than one bridge hop. If omitted, the planner behaves as if this value were false.

Input token acquisition mode. Optional. xPath contract calldata supports 0 = direct transfer, 1 = native token, 2 = Permit2, and 3 = Permit2Witness. If omitted, downstream execution logic defaults to direct transfer semantics when needed.

Required xPath API key used for authenticated access and account-based rate limits. Missing or invalid keys return 401.