# Pool

##  Gets the data from clients pool.

<mark style="color:blue;">`GET`</mark> `https://api.myapi.com/get-pool-by-pool-address/:pool-address`

**All parameters are required, send 0 incase if it is Not Applicable**

#### Request Body

| Name                                              | Type      | Description                                                                                                                             |
| ------------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| current\_supply<mark style="color:red;">\*</mark> | float/int | The current supply of the pool .                                                                                                        |
| nav<mark style="color:red;">\*</mark>             | float/int | <p>The latest pool nav</p><p><strong>Validation:</strong> The current nav should not be less than or more than 20% of previous nav.</p> |
| tenure<mark style="color:red;">\*</mark>          | float/int | The tenure of the proxy token in months.                                                                                                |
| issue\_size<mark style="color:red;">\*</mark>     | float/int | The issue size of the proxy token.                                                                                                      |
| senior\_apy<mark style="color:red;">\*</mark>     | float/int | senior apy of pool.                                                                                                                     |
| junior\_apy<mark style="color:red;">\*</mark>     | float/int | junior apy of the pool.                                                                                                                 |
| token\_price<mark style="color:red;">\*</mark>    | float/int | price of the proxy token.                                                                                                               |
| senior\_tranche<mark style="color:red;">\*</mark> | float/int | senior tranche of the pool.                                                                                                             |
| junior\_tranche<mark style="color:red;">\*</mark> | float/int | junior tranche of the pool.                                                                                                             |
| is\_active<mark style="color:red;">\*</mark>      | Boolean   | indicates if the pool is active or not.                                                                                                 |
| reward\_rate<mark style="color:red;">\*</mark>    | float/int | <p>can be 0 or the reward rate of the pool.</p><p></p><p></p>                                                                           |

{% tabs %}
{% tab title="200 Pool successfully created" %}
Example

{% code overflow="wrap" %}

```javascript
{
    "current_supply": 2200,
    "nav": 1100.0,
    "tenure": 1.0,
    "issue_size": 2420000,
    "senior_apy": 5.0,
    "junior_apy": 8.0,
    "token_price": 1000.0,
    "senior_tranche": 1000000.0,
    "junior_tranche": 1000000.0,
    "is_active": true
}
```

{% endcode %}
{% endtab %}

{% tab title="404: Not Found Pool API Validations Failed. Recheck the API fields' types" %}

<pre class="language-json"><code class="lang-json"><strong>{error: "Pool API Validations Failed. Recheck the API fields' types."}
</strong></code></pre>

{% endtab %}
{% endtabs %}

### Blocksscan Api  rendered from investment token address provided in the Pool Form.

{% hint style="danger" %}
When Token Form is submitted, following apis are called from blocksscan and stored in database. Please check that API are rendering data properly, else validation error is thrown.
{% endhint %}

## To fetch the token symbol of the investment token address

<mark style="color:blue;">`GET`</mark> `https://xdc.blocksscan.io/api/tokens/token_address`

You can check your api data from blockscsan <https://xdc.blocksscan.io/docs/#/Tokens/get_api_tokens__hash_>

#### Request Body

| Name                                     | Type   | Description      |
| ---------------------------------------- | ------ | ---------------- |
| symbol<mark style="color:red;">\*</mark> | String | The token symbol |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://yodaplus.gitbook.io/tradefinex-api/tradefinex/pool.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.