> For the complete documentation index, see [llms.txt](https://swapnet-1.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://swapnet-1.gitbook.io/docs/get-started/using-the-rest-api.md).

# Using the REST API

To get a swap quote, make a GET request to the swap endpoint with the required parameters:

```bash
curl "https://app.swap-net.xyz/api/v1.0/swap\
?chainId=999\
&sellToken=0xb8ce59fc3717ada4c02eadf9682a9e934f625ebb\
&buyToken=0x5555555555555555555555555555555555555555\
&sellAmount=10000000000\
&useRfq=true\
&includeCalldata=true\
&userAddress=0x11b86991c6218b36c1d19d4a2e9eb0ce3606eb49\
&slippageTolerance=0.01\
&router=swapnet-router\
&apiKey=<Your API Key>"
```

### Response Format

The API returns a JSON response with the following structure:

```json
{
    "aggregator": "swapnet",
    "router": "swapnet-router",
    "sell": {
        "referenceId": 1,
        "amount": "10000000000"
    },
    "buy": {
        "referenceId": 0,
        "amount": "170261032657489111452"
    },
    "nativeTokenUsdPrice": 58.75669929845798,
    "tokens": [...],
    "routes": [...],
    "routerAddress": "0x616000e384Ef1C2B52f5f3A88D57a3B64F23757e",
    "calldata": "0x873955400000000000...",
    "gasLimit": "1200000"
}
```

### Understanding the Response

The response contains several key components:

* **Routing Information**: Fields like `sell`, `buy`, `tokens`, and `routes` construct the graph-based routing plan, which can be encoded for any router contract.
* **Ready-to-Use Data**: When `includeCalldata` is set to `true` in the request, the API provides:
  * `calldata`: Pre-encoded transaction data for the specified router
  * `routerAddress`: Target router contract address
  * `gasLimit`: Suggested gas limit for the transaction