Reporting API

Reporting API is a collection of APIs Platforms use to get information about Liquid Collective Protocol Service Fees.

List high-level protocol info

List high-level protocol info for a given date

GET//eth/v0/protocol/{date}

Path parameters

date*string

Date filter by year, month or day (eg. 2023, 2023-12, 2023-12-31). Note: times are UTC

Query parameters

Response

200400401403500

OK

Body

application/json

a_srr_7dnumber

conversion_ratenumber

datestring

gross_fee_lsethnumber

gross_fee_ratenumber

oracle_reportstring

rewards_ethnumber

total_lseth_supplynumber

total_protocol_active_keys_countinteger

total_protocol_burns_lsethnumber

total_protocol_mints_lsethnumber

Request

JavaScriptCurl

const response = await fetch('//eth/v0/protocol/{date}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "a_srr_7d": 3.95,
    "conversion_rate": 1.012345,
    "date": "2023-01-02T03:04:05Z",
    "gross_fee_lseth": 0.1851,
    "gross_fee_rate": 0.15,
    "oracle_report": "f071c15d86fd9ae82f62bb4bb04963f14e04045bbcac8b5439984733207821bc000000ef",
    "rewards_eth": 1.234,
    "total_lseth_supply": 120520123.456789,
    "total_protocol_active_keys_count": 76,
    "total_protocol_burns_lseth": 32,
    "total_protocol_mints_lseth": 32
  }
]

List platform fees

List all platform fees for a given date

GET//eth/v0/platforms/{date}

Path parameters

date*string

Date filter by year, month or day (eg. 2023, 2023-12, 2023-12-31). Note: times are UTC

Query parameters

Response

200400401403500

OK

Body

application/json

conversion_ratenumber

dao_fees_lsethnumber

dao_fees_ratenumber

datestring

gross_fee_lsethnumber

operator_fees_lsethnumber

operator_fees_ratenumber

oracle_reportstring

org_idstring

platformmessage.Platform (object)

slashing_coverage_fees_lsethnumber

slashing_coverage_fees_ratenumber

tech_provider_fees_lsethnumber

tech_provider_fees_ratenumber

total_eth_supplynumber

total_lseth_supplynumber

versioninteger

Request

JavaScriptCurl

const response = await fetch('//eth/v0/platforms/{date}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "conversion_rate": 1.012345,
    "dao_fees_lseth": 0.00001234567,
    "dao_fees_rate": 0.0015,
    "date": "2023-01-02T03:04:05Z",
    "gross_fee_lseth": 0.0001234,
    "operator_fees_lseth": 0.000123456789,
    "operator_fees_rate": 0.0035,
    "oracle_report": "f071c15d86fd9ae82f62bb4bb04963f14e04045bbcac8b5439984733207821bc000000ef",
    "org_id": "org_example1234",
    "platform": {
      "fees_lseth": 0.0001234567,
      "fees_rate": 0.097,
      "off_platform_rebate": {
        "adjusted_total_net_outflows_fees_lseth": 0.0001234567,
        "adjusted_total_net_outflows_lseth": 0.0001234567,
        "fees_paid_lseth": 0.0001234567,
        "off_platform_attributable_fees_lseth": 0.0001234567,
        "off_platform_balance_lseth": 0.0001234567,
        "off_platform_fees_lseth": 0.0001234567,
        "off_platform_gross_fee_lseth": 0.0001234567,
        "outflow_ratio": 0.0001234567,
        "total_burns_lseth": 32.1234,
        "total_mints_lseth": 32.1234,
        "total_net_outflows_lseth": 0.0001234567,
        "total_on_platform_lseth": 0.0001234567,
        "total_outflows_lseth": 0.0001234567
      },
      "on_platform_rebate": {
        "on_platform_attributable_fees_lseth": 0.0001234567,
        "on_platform_fees_lseth": 0.0001234567,
        "on_platform_lseth": 120520123.456789,
        "on_platform_ratio": 0.0001234567
      },
      "total_balance_lseth": 0.0001234567
    },
    "slashing_coverage_fees_lseth": 0.0000012345678,
    "slashing_coverage_fees_rate": 0.003,
    "tech_provider_fees_lseth": 0.0000123456789,
    "tech_provider_fees_rate": 0.0035,
    "total_eth_supply": 120520123.456789,
    "total_lseth_supply": 120520123.456789,
    "version": 3
  }
]

List operator fees

List platform operator fees for a given date

GET//eth/v0/operators/{date}

Path parameters

date*string

Date filter by year, month or day (eg. 2023, 2023-12, 2023-12-31). Note: times are UTC

Response

200401403500

OK

Body

application/json

conversion_ratenumber

datestring

operator_active_keys_countinteger

operator_active_keys_rationumber

operator_fees_lsethnumber

oracle_reportstring

org_idstring

total_active_keys_countinteger

total_operator_fees_lsethnumber

versioninteger

Request

JavaScriptCurl

const response = await fetch('//eth/v0/operators/{date}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "conversion_rate": 1.012345,
    "date": "2023-01-02T03:04:05Z",
    "operator_active_keys_count": 5,
    "operator_active_keys_ratio": 0.5,
    "operator_fees_lseth": 0.00006,
    "oracle_report": "f071c15d86fd9ae82f62bb4bb04963f14e04045bbcac8b5439984733207821bc000000ef",
    "org_id": "org_example1234",
    "total_active_keys_count": 10,
    "total_operator_fees_lseth": 0.00012,
    "version": 3
  }
]

List rewards

List rewards for a time period

POST//eth/v0/rewards

Body

application/json

Request body

balancestring

fromstring

tostring

Response

200401403500

OK

Body

application/json

accrued_rewardsnumber

balancenumber

lotsarray of message.Lot (object)

Request

JavaScriptCurl

const response = await fetch('//eth/v0/rewards', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();

Response

{
  "accrued_rewards": 0,
  "balance": 1000000000000000000,
  "lots": [
    {
      "accrued_rewards": 0,
      "balance": 1000000000000000000,
      "end_conversion_rate": 1.05,
      "from": "2024-01-01",
      "start_conversion_rate": 1.03,
      "to": "2024-01-31"
    }
  ]
}