Build Path

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fromChain*integer

Source chain ID for the input token. Required.

Formatint64

Range0 <= value

toChain*integer

Destination chain ID for the output token. Required.

Formatint64

Range0 <= value

fromToken*string

Input token identifier on fromChain. Required. Pass the chain-specific token address or mint address exactly as xPath stores it.

toToken*string

Output token identifier on toChain. Required. Pass the chain-specific token address or mint address exactly as xPath stores it.

Amount*string

Input amount to build against, encoded as a base-10 integer string in the input token's smallest unit. Required.

Sender*string

Wallet address that will submit or sign the execution transaction. Required.

Integrator?|

Optional integrator identifier to carry through execution metadata.

Referrer?|

Optional referrer identifier for partner attribution.

acquisitionMode?|

Input token acquisition mode. Optional. Typical values are 0 for direct transfer, 1 for native token, and Permit2-based modes for signed execution flows.

Formatint32

Range0 <= value

allowMultiBridge?|

Enables multi-bridge route candidates during execution planning. Optional.

allowedPriceImpact?|

Maximum acceptable price impact for the built route. Optional. Expressed as a percentage value.

Formatdouble

destinationCallData?|

Optional destination-chain calldata to associate with the built route when supported by the integration.

destinationGasLimit?|

Optional destination-chain gas limit hint, encoded as a string integer.

excludeProvider?array<>

Optional list of provider keys to exclude when selecting or reconstructing the execution route.

feeBps?|

Optional integrator fee in basis points, where 100 = 1%.

Formatint32

Range0 <= value

includeProvider?array<>

Optional allowlist of provider keys to use while building execution calldata.

minOutputAmount?|

Optional minimum acceptable output amount, encoded as a base-10 integer string in the output token's smallest unit.

path?array<>|

Optional ordered route hint list, such as ["1inch-cctp"], to steer execution through a specific provider combination.

priorityProvider?|

Optional preferred provider key to bias route construction toward a specific integration.

routeMode?|

Optional route ranking strategy, such as fastest, max_value, or suggested.

simulation?|

If true, requests simulation-aware build output when supported by the executor. Optional.

slippage?|

Maximum slippage tolerance for the built route, expressed as a percentage. Optional.

Formatdouble

receiver?|

Recipient address for the output asset. Optional. If omitted, the execution flow falls back to the sender or route default.

Response Body

`application/json`

curl -X POST "https://api.xpath.rath.fi/build-path" \  -H "Content-Type: application/json" \  -d '{    "fromChain": 0,    "toChain": 0,    "fromToken": "string",    "toToken": "string",    "Amount": "string",    "Sender": "string"  }'

{
  "code": 0,
  "data": {
    "allowanceTarget": "string",
    "chain": 0,
    "data": "string",
    "expiry": 0,
    "gasLimit": "string",
    "simulation": true,
    "to": "string"
  },
  "message": "string"
}

Empty

Build Path

Request Body

Response Body

200application/json

500

`application/json`