Quickstart
Discover the deployment, request an exact-input quote and understand the next step.
1. Check configuration
curl https://api.pathagg.xyz/api/v1/config
curl https://api.pathagg.xyz/api/v1/sources
curl https://api.pathagg.xyz/api/v1/tokensConfiguration identifies the native and wrapped tokens, executor, fees and routing limits. Sources lists deployment IDs, factories and pool families. The starter token catalog is a starting point, not a complete inventory of HyperEVM tokens.
2. Request a quote
This example quotes 0.1 HYPE into USDC. HYPE has 18 decimals, so amountIn is the integer string 100000000000000000. The zero address represents native HYPE in this API. A wallet connection is not required for a quote.
curl https://api.pathagg.xyz/api/v1/quote \
-H 'Content-Type: application/json' \
-d '{
"chainId": 999,
"tokenIn": "0x0000000000000000000000000000000000000000",
"tokenOut": "0xb88339cb7199b77e23db6e890353e22632ba630f",
"amountIn": "100000000000000000",
"slippageBps": 50,
"maxHops": 3,
"maxSplits": 2
}'Path uses POST with a JSON body. slippageBps: 50 means 0.5%. The endpoint requires contract addresses, not token symbols. If RPC state cannot be verified at the requested block, the request fails rather than using a price from a different block.
3. Read the response
| Field | Use |
|---|---|
| quoteId | Reference the server-held winning route when building a swap. |
| amountOut / minimumReceived | Expected gross output and the token minimum used for settlement protection. |
| stateBlockNumber / stateBlockHash | The exact chain snapshot behind the quote. |
| expiresAt | Unix seconds. At most 15 seconds; snapshot age can shorten this lifetime. |
| rankingBasis / gasConversion | Whether gas value can be compared in output-token units. |
| simulation.status | Quote responses are not-performed; pool checks are not full sender simulation. |
| engine | fast uses qualified cached state; verified uses RPC-backed routing. |
| coverage / warnings | Search boundaries, synchronous RPC counts and availability caveats. |
4. Integrate the wallet flow
After settlement is activated, build an unsigned transaction from the reviewed quote. Handle exact ERC20 approval when required, refresh after approval, recheck the transaction, then request a wallet signature on HyperEVM 999.