API

PreviousEmergency withdrawal guide (advanced)NextMELLOW ALM

Last updated 8 days ago

Get all vaults

Retrieves comprehensive information about all available vaults in the Mellow Protocol ecosystem. Each vault represents a smart contract that manages liquidity across different DeFi protocols. The response includes vault configurations, associated tokens, current performance metrics, and operational parameters.

GEThttps://points.mellow.finance/v1/vaults

Response

Successful response containing an array of all active vaults with their complete details

Body

id*string

Unique identifier for the vault, typically combining the network and vault type

Example: "ethereum-dvsteth"

chain_id*integer

The blockchain network ID where the vault is deployed (e.g., 1 for Ethereum mainnet)

Example: 1

address*string

The smart contract address of the vault on the blockchain

Example: "0x5E362eb2c0706Bd1d134689eC75176018385430B"

symbol*string

The trading symbol of the vault's LP token, used for identification in interfaces

Example: "DVstETH"

decimals*integer

The number of decimal places used for the vault's LP token calculations and display

Example: 18

name*string

Human-readable name of the vault that describes its purpose or strategy

Example: "Decentralized Validator Vault"

layerstring

The protocol layer or strategy type that the vault implements (e.g., lido_simple_dvt, symbiotic)

Example: "lido_simple_dvt"

pointsarray of object

Array of point allocations for different protocols or systems integrated with this vault

base_tokenobject

The primary token that the vault uses for valuations and calculations

underlying_tokensarray of object

List of tokens that the vault manages or holds as part of its strategy

deposit_tokensarray of object

List of tokens that users can deposit into the vault for participation

withdraw_tokensarray of object

List of tokens that users can receive when withdrawing from the vault

withdraw_avg_time_secondsinteger

Average time in seconds it takes to process a withdrawal from the vault

Example: 345600

collectorstring

The address of the fee collector contract that receives protocol fees from the vault

Example: "0x240Fbe0790D5B25366BF88EE14AE8Dde72BfE312"

pricenumber

Current price of the vault's LP token in terms of the base currency

Example: 3519.90723976

aprnullable number

Annual Percentage Rate (APR) representing the vault's yearly yield, can be null if not applicable

Example: 2.886142857142857

tvl_usdnumber

Total Value Locked in the vault converted to USD, representing the total assets under management

Example: 24991702.73953098

tvl_base_tokenstring

Total Value Locked expressed in the base token's smallest units (considering decimals)

Example: "7177311992681062422621"

limit_usdnumber

Maximum USD value that can be deposited into the vault (deposit cap)

Example: 48398724.54674784

limit_base_tokenstring

Maximum amount of base tokens that can be deposited into the vault, expressed in smallest units

Example: "13899522963290482556503"

total_supplystring

Total supply of the vault's LP tokens in circulation, expressed in smallest units

Example: "7100102655321765400668"

Request

const response = await fetch('https://points.mellow.finance/v1/vaults', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "ethereum-dvsteth",
    "chain_id": 1,
    "address": "0x5E362eb2c0706Bd1d134689eC75176018385430B",
    "symbol": "DVstETH",
    "decimals": 18,
    "name": "Decentralized Validator Vault",
    "layer": "lido_simple_dvt",
    "points": [
      {
        "id": "mellow",
        "value": "17049600.467"
      }
    ],
    "base_token": {
      "address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
      "symbol": "WETH",
      "decimals": 18
    },
    "underlying_tokens": [
      {
        "address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
        "symbol": "WETH",
        "decimals": 18
      }
    ],
    "deposit_tokens": [
      {
        "address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
        "symbol": "WETH",
        "decimals": 18
      }
    ],
    "withdraw_tokens": [
      {
        "address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
        "symbol": "WETH",
        "decimals": 18
      }
    ],
    "withdraw_avg_time_seconds": 345600,
    "collector": "0x240Fbe0790D5B25366BF88EE14AE8Dde72BfE312",
    "price": 3519.90723976,
    "apr": 2.886142857142857,
    "tvl_usd": 24991702.73953098,
    "tvl_base_token": "7177311992681062422621",
    "limit_usd": 48398724.54674784,
    "limit_base_token": "13899522963290482556503",
    "total_supply": "7100102655321765400668"
  }
]

Get DeFi protocol integrations

Retrieves information about all DeFi protocol integrations and their points distribution across different chains.

GEThttps://points.mellow.finance/v1/defi/protocols

Response

Successful response containing DeFi protocol integrations

Body

chain_id*integer

The blockchain network ID where the protocol is integrated

vault_address*string

The address of the vault contract

defi_protocol_address*string

The address of the DeFi protocol contract

user_mellow_points*string

Points allocated in the Mellow protocol

user_symbiotic_points*string

Points allocated in the Symbiotic protocol

user_referal_points*string

Points earned through referrals

user_vault_balance*string

Balance in the vault in smallest units

namenullable string

Name of the protocol integration

protocolnullable string

Protocol identifier

pool_idnullable string

Unique identifier for the liquidity pool

urlnullable string

URL to the protocol's interface

boostnullable string

Boost multiplier for points earning

Request

const response = await fetch('https://points.mellow.finance/v1/defi/protocols', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "chain_id": 48900,
    "vault_address": "0x5fD13359Ba15A84B76f7F87568309040176167cd",
    "defi_protocol_address": "0x7d8311839eB44Dd5194abd2dd3998722455A24E0_0x9eFdE41A87fa4dD47BAa584954e8Abd5b8bdBfE7",
    "user_mellow_points": "6223.551000000001",
    "user_symbiotic_points": "6223.549319787699",
    "user_referal_points": "0.0",
    "user_vault_balance": "5035533496859123083549",
    "name": "inwstETHs amphrETH",
    "protocol": "Zircuit",
    "pool_id": "pool-zircuit-l2-staking-inwsteths-amphreth",
    "url": "https://app.zircuit.com/liquidity-hub",
    "boost": "2"
  }
]

Get user's vaults positions

Retrieves detailed information about a specific user's positions across all Mellow Protocol vaults. This includes their liquidity provisions, earned profits, and current holdings as a Liquidity Provider.

GEThttps://points.mellow.finance/v1/users/{user_address}

Path parameters

user_address*string

Ethereum address of the user (must be a valid Ethereum address)

Example: "0x1234567890123456789012345678901234567890"

Pattern: ^0x[a-fA-F0-9]{40}$

Response

Successful response containing user's positions across all vaults

Body

chain_id*integer

The blockchain network ID where the vault is deployed

user_address*string

The Ethereum address of the user

user_mellow_points*string

Points earned by the user in the Mellow protocol

user_symbiotic_points*string

Points earned by the user in the Symbiotic protocol

user_referal_points*string

Points earned by the user through referrals

user_vault_balance*number

User's balance in the vault in smallest units

timestamp*integer

Unix timestamp of when the data was last updated

vault_address*string

The smart contract address of the vault

Request

const response = await fetch('https://points.mellow.finance/v1/users/{user_address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "chain_id": 1,
    "user_address": "0x7F43fDe12A40dE708d908Fb3b9BFB8540d9Ce444",
    "user_mellow_points": "0",
    "user_symbiotic_points": "0",
    "user_referal_points": "0",
    "user_vault_balance": 10000000000000,
    "timestamp": 1737151835,
    "vault_address": "0x7F43fDe12A40dE708d908Fb3b9BFB8540d9Ce444"
  }
]

Get user's vaults DeFi positions

Retrieves detailed information about a user's positions across all integrated DeFi protocols, including points earned, balances, and protocol-specific details.

GEThttps://points.mellow.finance/v1/defi/users/{user_address}

Path parameters

user_address*string

Ethereum address of the user (must be a valid Ethereum address)

Example: "0xDB611d682cb1ad72fcBACd944a8a6e2606a6d158"

Pattern: ^0x[a-fA-F0-9]{40}$

Response

Successful response containing user's positions in DeFi protocols

Body

chain_id*integer

The blockchain network ID where the protocol is integrated

vault_address*string

The address of the vault contract

defi_protocol_address*string

The address of the DeFi protocol contract

user_mellow_points*string

Points earned in the Mellow protocol

user_symbiotic_points*string

Points earned in the Symbiotic protocol

user_referal_points*string

Points earned through referrals

user_vault_balance*string

User's balance in the vault in smallest units

timestamp*integer

Unix timestamp of when the data was last updated

namenullable string

Name of the protocol integration

protocolnullable string

Protocol identifier (e.g., Uniswap v3, Pendle, Gearbox)

pool_idnullable string

Unique identifier for the liquidity pool

urlnullable string

URL to the protocol's interface for this position

boostnullable string

Boost multiplier for points earning

Request

const response = await fetch('https://points.mellow.finance/v1/defi/users/{user_address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "chain_id": 1,
    "vault_address": "0x4f3Cc6359364004b245ad5bE36E6ad4e805dC961",
    "defi_protocol_address": "0x104b3E3ACD2396a7292223B5778Ea1caCdB68ec9",
    "user_mellow_points": "94678.511",
    "user_symbiotic_points": "92911.0138859653",
    "user_referal_points": "0.0",
    "user_vault_balance": "0",
    "timestamp": 1737403835,
    "name": "urLRT / wstETH",
    "protocol": "Uniswap v3",
    "pool_id": "pool-uniswap-urlrt-wsteth",
    "url": "https://app.uniswap.org/explore/pools/ethereum/0x104b3E3ACD2396a7292223B5778Ea1caCdB68ec9",
    "boost": "3"
  }
]