# Piteas SDK/API

<figure><img src="https://837816655-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2I48Qo28z4hEze9K5nIk%2Fuploads%2Fznihi68DSravwdoz4BWV%2Fpt2.jpg?alt=media&#x26;token=1430df58-2c5b-4c0a-a695-b08e30202694" alt=""><figcaption></figcaption></figure>

Piteas has an offchain model for its dex aggregator. Unlike traditional aggregator models, it doesn't create routes through API calls; the entire process is managed offchain by pathfinder, which then provides the call data response to the UI.

It is open for access to Piteas' main app, widget app, and some partner protocols. We don't have our own RPC service; quote/request data is fetched entirely through native Pulsechain RPC using our algorithms. Therefore, the number of quote requests needs to be limited. So, if you're looking to run an arbitrage bot, Piteas API is not suitable for you at this stage. However, if you have a project or product and require API access, please provide us with the following information for consideration:

* Brief information about your product.
* Estimated number of API requests covering daily, hourly, and minute intervals.
* If it involves integration for a portal, the number of users.

You can send this request form via Telegram/Twitter to initiate the integration/negotiation process.

***

### Piteas Public API - SDK <mark style="color:green;">Beta</mark> Release

Piteas SDK beta release has been published. Please note that this version may contain errors and is in the development stage. Ensure you consider request limits.

{% hint style="success" %}
To execute the swap process, sending the **calldata** on **methodParameters** from the response data to the [**PiteasRouter** ](https://docs.piteas.io/contracts)is sufficient. Adjust the necessary value data and gas estimate settings according to your conditions. Please also take a look at the router contract because the arguments in the response are defined for the conditions in the contract.
{% endhint %}

#### API Limits

The SDK version is in the beta stage, so please avoid sending more than **10 requests per minute**. Exceeding this limit may result in your blockage and cause access issues for one hour. Limits will be adjusted after the beta version.

***

### The first release of the Piteas API/SDK Monorepo is live! 🚀

Developers can now easily explore and integrate the Piteas API to create innovative products—freely and effortlessly!

The **Piteas API/SDK Monorepo** provides a comprehensive development environment to interact with the Piteas API. It offers two modes of operation: **Basic** and **Advanced**, designed to cater to developers of varying needs and expertise.

#### Explore now: <https://github.com/piteasio/piteas-api-monorepo>

{% embed url="<https://github.com/piteasio/piteas-api-monorepo>" %}

***

### Request Example and API parameters

> Example URL for 1,000,000 PLS to DAI :arrow\_down\_small:\
> \
> https\://**sdk.piteas.io**/quote?tokenInAddress=PLS\&tokenOutAddress=0xefD766cCb38EaF1dfd701853BFCe31359239F305\&amount=1000000000000000000000000\&allowedSlippage=0.50

## Swap Quote Parameters

<mark style="color:blue;">`GET`</mark> `https://sdk.piteas.io/quote`

Get swap quote on Piteas SDK on Pulsechain

#### Query Parameters

| Name                                              | Type    | Description                                                                                             |
| ------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------- |
| tokenInAddress<mark style="color:red;">\*</mark>  | string  | <p>Example: 0x2A06a971fE6ffa002fd242d437E3db2b5cC5B433<br>Use <strong>PLS</strong> for native token</p> |
| tokenOutAddress<mark style="color:red;">\*</mark> | string  | <p>Example: 0x2A06a971fE6ffa002fd242d437E3db2b5cC5B433<br>Use <strong>PLS</strong> for native token</p> |
| amount<mark style="color:red;">\*</mark>          | integer | Amount with decimals                                                                                    |
| allowedSlippage<mark style="color:red;">\*</mark> | float   | Default: **0.5**                                                                                        |
| account                                           | string  | <p>Receiver address.<br>Not required and default account is msg.sender.</p>                             |

{% tabs %}
{% tab title="200: OK Quote Success" %}

```json
{
  "srcToken": {
    "address": "0xA1077a294dDE1B09bB078844df40758a5D0f9a27",
    "symbol": "WPLS",
    "decimals": 18,
    "chainId": 369
  },
  "destToken": {
    "address": "0xefD766cCb38EaF1dfd701853BFCe31359239F305",
    "symbol": "DAI",
    "decimals": 18,
    "chainId": 369
  },
  "srcAmount": "0xd3c21bcecceda1000000",
  "destAmount": "0x2e33260eb8b008f09",
  "gasUseEstimate": 4025000,
  "gasUseEstimateUSD": 0.033025699048724835,
  "methodParameters": {
    "calldata": "...",
    "value": "0xd3c21bcecceda1000000"
  },
  "route": {
    "paths": [
      [...],
      [...],
      [...]
    ],
    "swaps": [
      {...},
      {...},
      {...}
    ]
  }
}
```

{% endtab %}

{% tab title="429: Too Many Requests Limit Error" %}
Please note that you cannot send more than **10 requests within 1 minute**. If you exceed this limit and encounter a 429 error, you will be **blocked** by the SDK manager for **one hour**.
{% endtab %}

{% tab title="500: Internal Server Error Server Issue" %}
If the pathfinder encounters issues resolving some routes, and this error persists multiple times, it means that quotes cannot be provided for the selected route.
{% endtab %}

{% tab title="403: Forbidden Blocked IPs" %}
IP address may be blacklisted due to requests made for malicious purposes. If access issues are occurring due to this error, please contact our development team immediately.
{% endtab %}
{% endtabs %}

A standard code use with ether.js to send a transaction to PiteasRouter:

```
const tx = await signer.sendTransaction({
    to: '0x6BF228eb7F8ad948d37deD07E595EfddfaAF88A6',
    value: quote.methodParameters.value,
    data: quote.methodParameters.calldata,
});
```