API

YO protocol API

Anyone can use the API to fetch historical information at the protocol or address-level.

Protocol-level data

Get a snapshot of the current TVL, yield, underlying pools and allocation of the protocol vaults.

get

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json; charset=utf-8

Responses

application/json

all ofOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/vault HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/json; charset=utf-8

200Success

{
  "data": [
    {}
  ],
  "message": "text",
  "statusCode": 200
}

Check the status of pending redeem requests for a given YO vault on a given blockchain.

get

Path parameters

vaultAddressstringRequired

networkstring · enumRequiredAvailable options:

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json; charset=utf-8

Responses

application/json

all ofOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/vault/pending-redeems/{network}/{vaultAddress} HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/json; charset=utf-8

200Success

{
  "data": {
    "raw": 1,
    "formatted": "text"
  },
  "message": "text",
  "statusCode": 200
}

Fetch the historical realized yield of a specific YO vault.

get

Path parameters

vaultAddressstringRequired

networkstring · enumRequiredAvailable options:

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json; charset=utf-8

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/vault/yield/timeseries/{network}/{vaultAddress} HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/json; charset=utf-8

200Success

No content

Fetch the historical TVL of a specific YO vault

get

Path parameters

vaultAddressstringRequired

networkstring · enumRequiredAvailable options:

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json; charset=utf-8

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/vault/tvl/timeseries/{network}/{vaultAddress} HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/json; charset=utf-8

200Success

No content

User-level data

Fetch the historical deposits and withdrawals of a specific address for a specific YO vault on a specific blockchain.

get

Path parameters

vaultAddressstringRequired

userAddressstringRequired

networkstring · enumRequiredAvailable options:

Query parameters

limitnumberOptional

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json; charset=utf-8

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/history/user/{network}/{vaultAddress}/{userAddress} HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/json; charset=utf-8

200Success

No content