Skip to main content

Protocol API

This endpoint retrieves protocol-wide statistics, including the current APY, number of depositors, epoch details, TVL (Total Value Locked), and more.

Overview

Endpoint
GET https://app.solayer.org/api/info
Description
  • This endpoint returns a JSON object that contains various protocol-level data, such as APY, epoch start/end times, the sSOL conversion ratio, token TVL, and more.
Authentication
  • Not required

Response Parameters

Below is an example JSON response and the description of each field.

Field Descriptions:

FieldTypeDescription
apyNumberCurrent annual percentage yield (APY) of the protocol.
depositorsNumberTotal number of depositors.
epochNumberThe current epoch number.
epoch_diff_timeStringRemaining (or elapsed) time for the current epoch (e.g., 33h46m8s).
epoch_end_timeNumberUnix timestamp (in milliseconds) when the current epoch ends.
epoch_start_timeNumberUnix timestamp (in milliseconds) when the current epoch started.
ssol_holdersNumberNumber of sSOL token holders.
ssol_to_solNumberConversion ratio from sSOL to SOL (e.g., 1 sSOL = ssol_to_sol SOL).
ssud_apyNumberAPY for the sSUD token.
ssud_holdersNumberNumber of sSUD token holders.
token_tvl_usdObjectKey-value pairs representing each token’s TVL in USD.
tvl_solNumberTotal TVL of the protocol denominated in SOL.
tvl_usdNumberTotal TVL of the protocol in USD.
Inside token_tvl_usd, each key (for example, sBBSOL, sBNSOL, sBSOL, etc.) corresponds to a specific token’s TVL in USD.

Example Usage

curl -X GET "https://app.solayer.org/api/info"
Sample Response:
{
  "apy": 8.99,
  "depositors": 302924,
  "epoch": 747,
  ...
}