🖖
Watcher API
  • Welcome
  • Use-cases
  • Quick Start
  • Reference
    • API Reference
      • Tokens
      • DeFi Strategies
      • Risk-triggers
Powered by GitBook
On this page
  • Get strategies for the token
  • Get strategies for a token.
  • Get health status by strategy id
  • Get health status for deFi(s) inside of the strategy.
  • Get health status by strategy name
  • Get health status for deFi(s) inside of the strategy.
  1. Reference
  2. API Reference

DeFi Strategies

Strategies within deFi

Get strategies for the token

Get strategies for a token.

GET https://api.web3watcher.fi/v1/strategies/bytoken/{token_symbol}

The method returns the list of strategies for your token.

Request Body

Name
Type
Description

token_symbol*

string

The symbol (name) of the token

offset

int

the number of strategies displayed per page

pagination

int

num of page

token_amount

int

the amount of token to invest

period

int

period of investment in days

stop_criteria

[string]

Criteria to not include some strategy categories

{
    "status":"200",
    "message":"Success",
    "result":[
        {
        "strategy_name":"lido_curve",
        "strategy_id":"389201",
        "strategy_category":"liqSt_dex",
        "defi_in":[
                {
                "defi_name":"lido",
                "defi_contract":"0xae7ab96520de3a18e5e111b5eaab095312d7fe84",
                },
                {
                "defi_name":"curve",
                "defi_contract":"0xD533a949740bb3306d119CC777fa900bA034cd52",
                },
        ],
        "current_apy": 0.04,
        "breackdown_apy":[
                {
                "token_symbol": "stETH",
                "current_apy": 0.038,
                },
                {
                "token_symbol": "crv",
                "current_apy": 0.02,
                },
        ],
        "current_risk_rating": "AB",
        "current_available_liquidity_token": 30000,
        "tokens_in": [
                {
                "token_symbol": "eth",
                },
        ],
        "tokens_out": [
                {
                "token_symbol": "stEth",
                },
                {
                "token_symbol": "crv",
                },
        ],
        },
    ],
    "offset": 1,
    "pagination": 1,
}
{
    "status":"401",
    "message":"Permission denied",
    "result":[],
    "offset": 1,
    "page": 1,
}

Get health status by strategy id

Get health status for deFi(s) inside of the strategy.

GET https://api.web3watcher.fi/v1/strategies/health/{strategy_id}/

The method returns the current health state of the strategy though deFi risk metrics.

Request Body

Name
Type
Description

strategy_id*

string

The id of the strategy

offset

int

the number of risk factors per page

pagination

int

num of page

track_deFi

[string]

the list of deFi to receive risk factors by each of them

{
    "status":"200",
    "message":"Success",
    "result": {
        "strategy_name":"lido_curve",
        "strategy_id":"389201",
        "strategy_category":"liqSt_dex",
        "current_apy": 0.04,
        "breackdown_apy":[
                {
                "token_symbol": "stETH",
                "current_apy": 0.038,
                },
                {
                "token_symbol": "crv",
                "current_apy": 0.02,
                },
        ],
        "current_risk_rating": "AB",
        "current_available_liquidity_token": 30000,
        "tokens_in": [
                {
                "token_symbol": "eth",
                },
        ],
        "tokens_out": [
                {
                "token_symbol": "stEth",
                },
                {
                "token_symbol": "crv",
                },
        ],
        "risk_factors":[
                {
                "deFi_name": "curve",
                "factor_name": "f_whales",
                "factor_score": 90,
                "factor_score_change": -2,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_santiment",
                "factor_score": 90,
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_deposit_price",
                "factor_score": "87",
                "factor_score_change": +1,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_apy",
                "factor_score": "90",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_stop_withdraw",
                "factor_score": "92",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_reward_liquiduty",
                "factor_score": "83",
                "factor_score_change": -4,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_token_backing",
                "factor_score": "81",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_flashloan",
                "factor_score": "75",
                "factor_score_change": -15,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_spec_addrs_change",
                "factor_score": "95",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_proxy",
                "factor_score": "95",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_oracle",
                "factor_score": "89",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_dao",
                "factor_score": "75",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_audit",
                "factor_score": "95",
                "factor_score_change": 0,
                },
        },
    "offset": 99,
    "pagination": 1,
}
{
    "status":"401",
    "message":"Permission denied",
    "result":[],
    "offset": 99,
    "page": 1,
}

Get health status by strategy name

Get health status for deFi(s) inside of the strategy.

GET https://api.web3watcher.fi/v1/strategies/health/{strategy_name}

The method returns the current health state of the strategy though deFi risk metrics.

Request Body

Name
Type
Description

strategy_name*

string

The name of the strategy

offset

int

the number of risk factors per page

pagination

int

num of page

track_deFi

[string]

the list of deFi to receive risk factors by each of them

{
    "status":"200",
    "message":"Success",
    "result": {
        "strategy_name":"lido_curve",
        "strategy_id":"389201",
        "strategy_category":"liqSt_dex",
        "current_apy": 0.04,
        "breackdown_apy":[
                {
                "token_symbol": "stETH",
                "current_apy": 0.038,
                },
                {
                "token_symbol": "crv",
                "current_apy": 0.02,
                },
        ],
        "current_risk_rating": "AB",
        "current_available_liquidity_token": 30000,
        "tokens_in": [
                {
                "token_symbol": "eth",
                },
        ],
        "tokens_out": [
                {
                "token_symbol": "stEth",
                },
                {
                "token_symbol": "crv",
                },
        ],
        "risk_factors":[
                {
                "deFi_name": "curve",
                "factor_name": "f_whales",
                "factor_score": 90,
                "factor_score_change": -2,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_santiment",
                "factor_score": 90,
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_deposit_price",
                "factor_score": "87",
                "factor_score_change": +1,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_apy",
                "factor_score": "90",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_stop_withdraw",
                "factor_score": "92",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_reward_liquiduty",
                "factor_score": "83",
                "factor_score_change": -4,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_token_backing",
                "factor_score": "81",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_flashloan",
                "factor_score": "75",
                "factor_score_change": -15,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_spec_addrs_change",
                "factor_score": "95",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_proxy",
                "factor_score": "95",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_oracle",
                "factor_score": "89",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_dao",
                "factor_score": "75",
                "factor_score_change": 0,
                },
                {
                "deFi_name": "curve",
                "factor_name": "f_audit",
                "factor_score": "95",
                "factor_score_change": 0,
                },
        },
    "offset": 99,
    "pagination": 1,
}
{
    "status":"401",
    "message":"Permission denied",
    "result":[],
    "offset": 99,
    "page": 1,
}
PreviousTokensNextRisk-triggers

Last updated 1 year ago