> For the complete documentation index, see [llms.txt](https://docs.3adao.org/3a-protocol/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.3adao.org/3a-protocol/technical-documentation/smart-contracts/api.md).

# API

## Retrieves core protocol contract addresses

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/chain`

{% tabs %}
{% tab title="200: OK JSON Format" %}

```json
{
"jsonData": {
"lastResortLiquidation": "0xF126bB7C214B1cDBde7f4296Da2Da5Fc99e34F27",
"auctionManager": "0xc3E52ebA21517c59BEdA53A1C760fdf2fb2C0025",
"vaultFactory": "0x050FAc481D26BDd477e121c04e5b059eDFd9F42f",
"liquidationRouter": "0xd14A6F345E44B8c061b63f6A79DA47F148082F54",
"a3aToken": "0x5D402E1Cf27769de037fDed4CdC1Aff2B0ce2208",
"mintableTokenOwner": "0xfd9f0EEa6a617C2D0Ab9656Fd6cf8aC5ED53Fd0C",
"stabilityPool": "0xaE5756207501459a9A72F2e4d06B219e146918dB",
"stableCoin": "0x25D50b4A9C4301ED18F832dD0ca002b3006D5ef0",
"a3aStaking": "0xED6aBF8eb45921E3ec462cD09e9DcDc13b4BA82A",
"rpc": "https://rpc.buildbear.io/urban-zam-wesell-f93d4545",
"chainId": "10801"
}
}
```

{% endtab %}
{% endtabs %}

## Get overall protocol statistics

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/protocolStats`

{% tabs %}
{% tab title="200: OK JSON Format" %}

```json
{
"vaults": 68,
"totalDebt": "500.0",
"tvl": "1208.31",
"uniqueUsers": 0,
"borrowRate": "0.005",
"redemptionRate": "0.005",
"maxTokensPerVault": "5"
}
```

{% endtab %}
{% endtabs %}

## Retrieves core protocol supported collaterals

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/collaterals`

Also retrieves collateral settings such as \
\- MCR: Minimum Collateralization Ratio (%)\
\- MLR: Minimum Liquidation Ratio (%)

{% tabs %}
{% tab title="200: OK JSON Format" %}

```json
[
{
"tokenName": "WMATIC",
"address": "0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270",
"mcr": 120,
"mlr": 110,
"decimals": 18,
"price": "/collaterals/price/0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270"
},
{
"tokenName": "USDC",
"address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
"mcr": 110,
"mlr": 105,
"decimals": 6,
"price": "/collaterals/price/0x2791bca1f2de4661ed88a30c99a7a9449aa84174"
},
{
"tokenName": "WETH",
"address": "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619",
"mcr": 120,
"mlr": 110,
"decimals": 18,
"price": "/collaterals/price/0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619"
}
]
```

{% endtab %}
{% endtabs %}

## Retrieves collateral price via the core protocol oracles

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/collaterals/price/:collateralAddress`

#### Path Parameters

| Name                                                 | Type   | Description              |
| ---------------------------------------------------- | ------ | ------------------------ |
| :collateralAddress<mark style="color:red;">\*</mark> | String | ERC20 collateral address |

{% tabs %}
{% tab title="200: OK JSON Format" %}

```json
{
"priceInWei": "516830542125875495",
"priceHuman": "0.516830542125875495"
}
```

{% endtab %}
{% endtabs %}

## Retrieves the full list of core protocol contract ABIs

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/abi/list`

{% tabs %}
{% tab title="200: OK JSON Format" %}

```json
[
"/abi/A3A",
"/abi/A3AStaking",
"/abi/AuctionManager",
"/abi/ChainlinkPriceFeed",
"/abi/ConvertedPriceFeed",
"/abi/LastResortLiquidation",
"/abi/LiquidationRouter",
"/abi/MintableToken",
"/abi/MintableTokenOwner",
"/abi/StabilityPool",
"/abi/TokenToPriceFeed",
"/abi/Vault",
"/abi/VaultDeployer",
"/abi/VaultFactory",
"/abi/VaultFactoryHelper"
]
```

{% endtab %}
{% endtabs %}

## Retrieves a specific ABI of the input contract, along with its deployed address

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/abi/`

Example: **`/abi/A3A`**

#### Path Parameters

| Name                                           | Type   | Description     |
| ---------------------------------------------- | ------ | --------------- |
| contractName<mark style="color:red;">\*</mark> | String | target contract |

{% tabs %}
{% tab title="200: OK JSON Format" %}

```json
{
"address": "0xED6aBF8eb45921E3ec462cD09e9DcDc13b4BA82A",
"abi": [ .... ]
} 
```

{% endtab %}
{% endtabs %}

## Get vaults list and detailed informations

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/vaults`

If no vault address is provided, it will return the full list of opened vaults in the protocol.

To get a specific vault details, use **`/vaults/0x....00`**

#### Path Parameters

| Name         | Type   | Description          |
| ------------ | ------ | -------------------- |
| vaultAddress | String | target Vault address |

{% tabs %}
{% tab title="200: OK Full vaults list" %}

```json
[
{
"address": "0x4956538616174ba7b407921AB0Fb0Cce2558EEeF",
"url": "/vaults/0x4956538616174ba7b407921AB0Fb0Cce2558EEeF"
},
{
"address": "0x129AB949Ad24420e840c3de87FA9684BF8A30930",
"url": "/vaults/0x129AB949Ad24420e840c3de87FA9684BF8A30930"
}
]
```

{% endtab %}

{% tab title="200: OK Vault details" %}

```json
{
"address": "0x4956538616174ba7b407921AB0Fb0Cce2558EEeF",
"collaterals": [
"0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270"
],
"vaultName": "MyVault",
"owner": "0x717596024e386BA5c2fb40c3c6DA27e9abD86047",
"debt": "0.0",
"healthFactor": "",
"liquidationFactor": "",
"liquidationThreshold": "46.98459473871595409",
"borrowable": "43.069211843822957916",
"tvl": "51.6830542125875495",
"collateralInfo": [
{
"address": "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270",
"amount": "100.0",
"price": "0.516830542125875495",
"valueInEur": "51.6830542125875495",
"decimals": 18,
"symbol": "WMATIC",
"isRedeemable": false
}
]
}
```

{% endtab %}
{% endtabs %}

## Get all vaults that can be redeemed against

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/redeemableVaults`

If any vault can be redeemed against, it will also provide which collateral can be redeemed for EURO3

## Get all liquidatable vaults

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/liquidatableVaults`

## Get all vaults owned by a specific address

<mark style="color:blue;">`GET`</mark> `https://api-testnet.3adao.org/vaultsByUser/:address`

If no vault address is provided, it will return the full list of opened vaults in the protocol.

To get a specific vault details, use **`/vaults/0x....00`**

#### Path Parameters

| Name     | Type   | Description          |
| -------- | ------ | -------------------- |
| :address | String | target owner address |

{% tabs %}
{% tab title="200: OK Full vaults list" %}

```json
[
{
"address": "0x4956538616174ba7b407921AB0Fb0Cce2558EEeF",
"url": "/vaults/0x4956538616174ba7b407921AB0Fb0Cce2558EEeF"
},
{
"address": "0x129AB949Ad24420e840c3de87FA9684BF8A30930",
"url": "/vaults/0x129AB949Ad24420e840c3de87FA9684BF8A30930"
},
{
"address": "0x28E2dd0a5B54091f47ca379342646A96654A7356",
"url": "/vaults/0x28E2dd0a5B54091f47ca379342646A96654A7356"
},
{
"address": "0x90b3B5f5cefcE34e9B0cBa1A1d8102A3561872D5",
"url": "/vaults/0x90b3B5f5cefcE34e9B0cBa1A1d8102A3561872D5"
}
]
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.3adao.org/3a-protocol/technical-documentation/smart-contracts/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.