API

Get all vaults

get

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.

Responses

200

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

application/json

idstringRequired

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

Example: ethereum-dvsteth

chain_idintegerRequired

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

Example: 1

addressstringRequired

The smart contract address of the vault on the blockchain

Example: 0x5E362eb2c0706Bd1d134689eC75176018385430B

symbolstringRequired

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

Example: DVstETH

decimalsintegerRequired

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

Example: 18

namestringRequired

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

Example: Decentralized Validator Vault

layerstringOptional

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

Example: lido_simple_dvt

withdraw_avg_time_secondsintegerOptional

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

Example: 345600

collectorstringOptional

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

Example: 0x240Fbe0790D5B25366BF88EE14AE8Dde72BfE312

pricenumberOptional

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

Example: 3519.90723976

aprnumber · nullableOptional

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

Example: 2.886142857142857

tvl_usdnumberOptional

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

Example: 24991702.73953098

tvl_base_tokenstringOptional

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

Example: 7177311992681062422621

limit_usdnumberOptional

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

Example: 48398724.54674784

limit_base_tokenstringOptional

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

Example: 13899522963290482556503

total_supplystringOptional

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

Example: 7100102655321765400668

get

/v1/vaults

HTTPcURLJavaScriptPython

GET /v1/vaults HTTP/1.1
Host: points.mellow.finance
Accept: */*

200

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

[
  {
    "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

get

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

Responses

200

Successful response containing DeFi protocol integrations

application/json

chain_idintegerRequired

The blockchain network ID where the protocol is integrated

vault_addressstringRequired

The address of the vault contract

defi_protocol_addressstringRequired

The address of the DeFi protocol contract

user_mellow_pointsstringRequired

Points allocated in the Mellow protocol

user_symbiotic_pointsstringRequired

Points allocated in the Symbiotic protocol

user_referal_pointsstringRequired

Points earned through referrals

user_vault_balancestringRequired

Balance in the vault in smallest units

namestring · nullableOptional

Name of the protocol integration

protocolstring · nullableOptional

Protocol identifier

pool_idstring · nullableOptional

Unique identifier for the liquidity pool

urlstring · nullableOptional

URL to the protocol's interface

booststring · nullableOptional

Boost multiplier for points earning

get

/v1/defi/protocols

HTTPcURLJavaScriptPython

GET /v1/defi/protocols HTTP/1.1
Host: points.mellow.finance
Accept: */*

200

Successful response containing DeFi protocol integrations

[
  {
    "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

get

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.

Path parameters

user_addressstringRequired

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

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

Responses

200

Successful response containing user's positions across all vaults

application/json

chain_idintegerRequired

The blockchain network ID where the vault is deployed

user_addressstringRequired

The Ethereum address of the user

user_mellow_pointsstringRequired

Points earned by the user in the Mellow protocol

user_symbiotic_pointsstringRequired

Points earned by the user in the Symbiotic protocol

user_referal_pointsstringRequired

Points earned by the user through referrals

user_vault_balancenumberRequired

User's balance in the vault in smallest units

timestampintegerRequired

Unix timestamp of when the data was last updated

vault_addressstringRequired

The smart contract address of the vault

500

Internal server error

text/plain

get

/v1/users/{user_address}

HTTPcURLJavaScriptPython

GET /v1/users/{user_address} HTTP/1.1
Host: points.mellow.finance
Accept: */*

[
  {
    "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

get

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

Path parameters

user_addressstringRequired

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

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

Responses

200

Successful response containing user's positions in DeFi protocols

application/json

chain_idintegerRequired

The blockchain network ID where the protocol is integrated

vault_addressstringRequired

The address of the vault contract

defi_protocol_addressstringRequired

The address of the DeFi protocol contract

user_mellow_pointsstringRequired

Points earned in the Mellow protocol

user_symbiotic_pointsstringRequired

Points earned in the Symbiotic protocol

user_referal_pointsstringRequired

Points earned through referrals

user_vault_balancestringRequired

User's balance in the vault in smallest units

timestampintegerRequired

Unix timestamp of when the data was last updated

namestring · nullableOptional

Name of the protocol integration

protocolstring · nullableOptional

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

pool_idstring · nullableOptional

Unique identifier for the liquidity pool

urlstring · nullableOptional

URL to the protocol's interface for this position

booststring · nullableOptional

Boost multiplier for points earning

500

Internal server error

text/plain

get

/v1/defi/users/{user_address}

HTTPcURLJavaScriptPython

GET /v1/defi/users/{user_address} HTTP/1.1
Host: points.mellow.finance
Accept: */*

[
  {
    "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"
  }
]