Euler

https://docs.euler.finance/
Admin
Euler is a modular lending protocol that enables the creation, curation, and use of customized...
Tokens:74,916
Snippets:630
Trust Score:9.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Quick start: clone, install, and run Euler Lite

Source: https://docs.euler.finance/build/euler-lite

Clones the euler-lite repository, installs dependencies with npm ci, copies the environment template, and starts the development server. The app will be available at http://localhost:3000.

```bash
git clone https://github.com/euler-xyz/euler-lite
cd euler-lite
npm ci
cp .env.example .env
# Fill in required values (see below)
npm run dev
```

--------------------------------

### Install all Euler skills

Source: https://docs.euler.finance/llms

Use this command to install the complete suite of Euler agent skills.

```bash
npx add-skill euler-xyz/agent-skills --skill euler-vaults --skill euler-irm-oracles --skill euler-earn --skill euler-advanced --skill euler-data
```

--------------------------------

### Install Euler V2 SDK

Source: https://docs.euler.finance/build/sdk

Install the stable release of the SDK using npm.

```bash
npm install @eulerxyz/euler-v2-sdk
```

--------------------------------

### Example API Requests

Source: https://docs.euler.finance/build/data-querying/euler-v3-api

Examples of basic curl requests to fetch chain information and vault data.

```bash
curl https://v3.euler.finance/v3/chains
curl "https://v3.euler.finance/v3/evk/vaults?chainId=1&limit=20"
```

--------------------------------

### Description example

Source: https://docs.euler.finance/curate/vaults/labeling

Example of a factual, maintainable description for an EVK lending product. Identifies the object and the party that configures it without implying endorsement.

```text
An EVK lending product for selected assets, configured by Example DAO.
```

--------------------------------

### Example ROE Calculation

Source: https://docs.euler.finance/use/return-on-equity

A practical example calculating ROE for $1,000 supplied at 7.5% APY and $800 borrowed at 4.5% APY.

```text
equity = $1,000 − $800 = $200
multiplier = $1,000 / $200 = 5
ROE = (($1,000 × 7.5%) − ($800 × 4.5%)) / $200
    = 19.5%
```

--------------------------------

### Authenticated API Request

Source: https://docs.euler.finance/build/data-querying/euler-v3-api

Example of using an API key via the X-API-Key header to increase rate limits.

```bash
curl -H "X-API-Key: your-key" \
  "https://v3.euler.finance/v3/tokens"
```

--------------------------------

### Build and preview commands

Source: https://docs.euler.finance/build/euler-lite

Commands to build the project and preview it locally. The preview command is commented as 'preview locally'.

```bash
npm run build
npm run preview   # preview locally
```

--------------------------------

### Install core vault skill

Source: https://docs.euler.finance/llms

Use this command to install the euler-vaults skill for agent operations.

```bash
npx add-skill euler-xyz/agent-skills --skill euler-vaults
```

--------------------------------

### Build and run liquidation bot with environment variables

Source: https://docs.euler.finance/build/liquidation-bot

Build the Rust binary and run it with required environment variables. The environment exports illustrate required names only and are not a recommended production secret-loading method. The bot is run from a directory containing the relevant config file.

```bash
cargo build --release

export CHAIN_ID=1
export RPC_URL_1="https://your-mainnet-rpc"
export SUBGRAPH_URL_PREFIX="https://your-subgraph-host/"
export EOA_ADDRESS="0xYourWalletAddress"
export EOA_PRIVATE_KEY="0xYourPrivateKey"

cd configs
../target/release/liquidation-bot-v3
```

--------------------------------

### Tags schema example

Source: https://docs.euler.finance/curate/vaults/labeling

Example of the tags schema used in metadata files. Tags can be set on a product, a vault entry, or in vaultOverrides. Other examples in use include "keyring" and "suppress high utilisation warning".

```json
{
  "tags": ["governance limited"]
}
```

--------------------------------

### Initialize Euler SDK

Source: https://docs.euler.finance/build/sdk

Configure the SDK with RPC URLs using the buildEulerSDK function.

```typescript
import { buildEulerSDK } from "@eulerxyz/euler-v2-sdk";
import { mainnet } from "viem/chains";

const sdk = await buildEulerSDK({
  config: {
    rpcUrls: {
      [mainnet.id]: "https://your-mainnet-rpc",
    },
  },
});
```

--------------------------------

### Configure RPC via Environment Variables

Source: https://docs.euler.finance/build/sdk

Alternative method to configure RPC URLs using environment variables.

```bash
EULER_SDK_RPC_URL_1=https://your-mainnet-rpc
```

--------------------------------

### GET /v3/tokens/{chainId}/{address}/price

Source: https://docs.euler.finance/build/data-querying/euler-v3-api

Fetches the current USD price for a single token on a specified chain.

```APIDOC
## GET /v3/tokens/{chainId}/{address}/price

### Description
Fetches the current USD price for a single token on a specified chain.

### Method
GET

### Endpoint
https://v3.euler.finance/v3/tokens/{chainId}/{address}/price

### Parameters
#### Path Parameters
- **chainId** (integer) - Required - The chain ID of the network.
- **address** (string) - Required - The token address (EIP-55 checksummed).

### Request Example
curl "https://v3.euler.finance/v3/tokens/1/0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0/price"

### Response
#### Success Response (200)
- **data** (object) - Price object.
  - **chainId** (integer) - Chain ID.
  - **address** (string) - Token address.
  - **symbol** (string) - Token symbol.
  - **decimals** (integer) - Token decimals.
  - **priceUsd** (number) - USD price.
  - **source** (string) - Source category: onchain, offchain, or hardcoded.
  - **timestamp** (string) - ISO-8601 UTC timestamp.

#### Response Example
{
  "data": {
    "chainId": 1,
    "address": "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0",
    "symbol": "wstETH",
    "decimals": 18,
    "priceUsd": 2323.31,
    "source": "offchain",
    "timestamp": "2026-07-14T16:11:24.895Z"
  }
}
```
Tokens:
Raw