Reporting API

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

Commercials V3 cutover — May 1, 2026. Use the v1 endpoints for any reporting period on or after 2026-05-01 00:00 UTC. The v0 endpoints remain valid only for historical periods through 2026-04-30.

Public endpoints (no authentication required)

List latest high-level protocol info

get

List latest available high-level protocol

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

unitstringOptional

Display LsETH values in units of wei or ether. If not present, LsETH is set by default.

Responses

200

application/json

a_srr_7dstringOptionalExample: 3.9712483

conversion_ratestringOptionalExample: 1.012345

datestringOptionalExample: 2023-01-02T03:04:05Z

gross_fee_lsethstringOptionalExample: 0.1851

gross_fee_ratestringOptionalExample: 0.15

net_srr_7dstringOptionalExample: 3.375561055

oracle_reportstringOptionalExample: f071c15d86fd9ae82f62bb4bb04963f14e04045bbcac8b5439984733207821bc000000ef

protocol_service_fee_ratestringOptionalExample: 0.11

rewards_ethstringOptionalExample: 1.234

total_eth_stakedstringOptionalExample: 122007944.381

total_lseth_supplystringOptionalExample: 120520123.456789

total_protocol_active_keys_countintegerOptionalExample: 76

total_protocol_burns_lsethstringOptionalExample: 32

total_protocol_mints_lsethstringOptionalExample: 32

400

Bad Request

application/json

500

Internal error

application/json

get/eth/v1/protocol

GET /eth/v1/protocol HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "a_srr_7d": "3.9712483",
  "conversion_rate": "1.012345",
  "date": "2023-01-02T03:04:05Z",
  "gross_fee_lseth": "0.1851",
  "gross_fee_rate": "0.15",
  "net_srr_7d": "3.375561055",
  "oracle_report": "f071c15d86fd9ae82f62bb4bb04963f14e04045bbcac8b5439984733207821bc000000ef",
  "protocol_service_fee_rate": "0.11",
  "rewards_eth": "1.234",
  "total_eth_staked": "122007944.381",
  "total_lseth_supply": "120520123.456789",
  "total_protocol_active_keys_count": 76,
  "total_protocol_burns_lseth": "32",
  "total_protocol_mints_lseth": "32"
}

List high-level protocol info

get

List high-level protocol info for a given date

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datestringRequired

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

Query parameters

unitstringOptional

Display LsETH values in units of wei or ether. If not present, LsETH is set by default.

Responses

200

application/json

a_srr_7dstringOptionalExample: 3.9712483

conversion_ratestringOptionalExample: 1.012345

datestringOptionalExample: 2023-01-02T03:04:05Z

gross_fee_lsethstringOptionalExample: 0.1851

gross_fee_ratestringOptionalExample: 0.15

net_srr_7dstringOptionalExample: 3.375561055

oracle_reportstringOptionalExample: f071c15d86fd9ae82f62bb4bb04963f14e04045bbcac8b5439984733207821bc000000ef

protocol_service_fee_ratestringOptionalExample: 0.11

rewards_ethstringOptionalExample: 1.234

total_eth_stakedstringOptionalExample: 122007944.381

total_lseth_supplystringOptionalExample: 120520123.456789

total_protocol_active_keys_countintegerOptionalExample: 76

total_protocol_burns_lsethstringOptionalExample: 32

total_protocol_mints_lsethstringOptionalExample: 32

400

Bad Request

application/json

500

Internal error

application/json

get/eth/v1/protocol/{date}

GET /eth/v1/protocol/{date} HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List wallet transactions

get

List wallet transactions for a given time period and wallet address

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

addressstringRequired

Wallet address

Query parameters

fromstringOptional

Start date (default: 1 year ago)

tostringOptional

End date (default: current time)

csvstringOptional

Output as CSV

page_sizestringOptional

Page size (default: 100)

next_cursorstringOptional

Next cursor

Responses

200

application/json

400

Bad request

application/json

404

Not found

application/json

500

Internal error

application/json

get/eth/v1/wallet/{address}/transactions

GET /eth/v1/wallet/{address}/transactions HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "amount_eth": 10,
      "amount_lseth": 9.5,
      "conversion_rate": 0.96,
      "date": "2024-06-21",
      "finalized": true,
      "transaction_hash": "0x5E9E16C6DEB4022399E4FCD387BCB59AC5855762",
      "transaction_type": "Deposit"
    }
  ],
  "metadata": {
    "next_cursor": "eyJpbmRleCI6MX0"
  }
}

Private endpoints ( authentication required)

List platform fees

get

List all platform fees for a given date

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datestringRequired

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

Query parameters

page_sizeintegerOptional

Number of oracle reports per page (1-1000, default 100)

next_cursorstringOptional

Cursor returned from previous page

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

get/eth/v1/platforms/{date}

GET /eth/v1/platforms/{date} HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "conversion_rate": 1.012345,
      "cumulative_eth_supply": 120520123.456789,
      "cumulative_lseth_supply": 120520123.456789,
      "date": "2023-01-02T03:04:05Z",
      "oracle_report": "f071c15d86fd9ae82f62bb4bb04963f14e04045bbcac8b5439984733207821bc000000ef",
      "org_id": "org_example1234",
      "period": {
        "end": "2024-01-31T23:59:59Z",
        "end_epoch": 257200,
        "start": "2024-01-01T00:00:00Z",
        "start_epoch": 250000
      },
      "period_lc_fees_lseth": 0.00001234567,
      "period_lc_fees_rate": 0.0015,
      "period_operator_fees_lseth": 0.000123456789,
      "period_operator_fees_rate": 0.0035,
      "period_originator_fees_lseth": 0.000123456789,
      "period_originator_fees_rate": 0.0035,
      "period_protocol_fee_lseth": 0.0001234,
      "period_protocol_fee_rate": 0.1,
      "period_tech_provider_fees_lseth": 0.0000123456789,
      "period_tech_provider_fees_rate": 0.0035,
      "platform": {
        "off_platform_rebate": {
          "adjusted_cumulative_platform_net_outflows_fees_lseth": 0.0001234567,
          "adjusted_cumulative_platform_net_outflows_transfers_lseth": 0.0001234567,
          "cumulative_platform_burns_lseth": 32.1234,
          "cumulative_platform_fees_received_from_lc_lseth": 0.0001234567,
          "cumulative_platform_mints_lseth": 32.1234,
          "cumulative_platform_net_outflows_lseth": 0.0001234567,
          "cumulative_platform_transfers_in_lseth": 0.0001234567,
          "cumulative_platform_transfers_out_lseth": 0.0001234567,
          "cumulative_protocol_on_platform_lseth": 0.0001234567,
          "cumulative_protocol_outflows_lseth": 0.0001234567,
          "period_off_platform_allocated_fees_lseth": 0.0001234567,
          "period_off_platform_balance_lseth": 0.0001234567,
          "period_off_platform_fees_lseth": 0.0001234567,
          "period_platform_adjusted_net_outflows_lseth": 0.0001234567,
          "period_platform_outflow_ratio": 0.0001234567,
          "period_protocol_off_platform_gross_fee_lseth": 0.0001234567
        },
        "on_platform_rebate": {
          "period_on_platform_allocated_fees_lseth": 0.0001234567,
          "period_on_platform_balance_lseth": 120520123.456789,
          "period_on_platform_fees_lseth": 0.0001234567,
          "period_on_platform_ratio": 0.0001234567
        },
        "period_fees_lseth": 0.0001234567,
        "period_fees_rate": 0.097,
        "period_platform_balance_lseth": 0.0001234567
      },
      "version": 3
    }
  ],
  "metadata": {
    "next_cursor": "eyJpbmRleCI6MX0"
  }
}

List originator fees

get

List all originator fees for a given date

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datestringRequired

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

Query parameters

page_sizeintegerOptional

Number of oracle reports per page (1-1000, default 100)

next_cursorstringOptional

Cursor returned from previous page

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

get/eth/v1/originators/{date}

GET /eth/v1/originators/{date} HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "conversion_rate": 1.012345,
      "cumulative_eth_supply": 120520123.456789,
      "cumulative_lseth_supply": 120520123.456789,
      "date": "2023-01-02T03:04:05Z",
      "oracle_report": "f071c15d86fd9ae82f62bb4bb04963f14e04045bbcac8b5439984733207821bc000000ef",
      "org_id": "org_example1234",
      "originator": {
        "attributed_rebate": {
          "period_originator_attributed_allocated_fees_lseth": 0.0001234567,
          "period_originator_attributed_balance_lseth": 120520123.456789,
          "period_originator_attributed_fees_lseth": 0.0001234567,
          "period_originator_attributed_ratio": 0.0001234567
        },
        "period_fees_lseth": 0.0001234567,
        "period_fees_rate": 0.097,
        "period_originator_balance_lseth": 0.0001234567,
        "unattributed_rebate": {
          "adjusted_cumulative_originator_net_outflows_fees_lseth": 0.0001234567,
          "cumulative_originator_attributed_lseth": 0.0001234567,
          "cumulative_originator_burns_lseth": 32.1234,
          "cumulative_originator_fees_received_from_lc_lseth": 0.0001234567,
          "cumulative_originator_mints_lseth": 32.1234,
          "cumulative_originator_net_outflows_lseth": 0.0001234567,
          "cumulative_protocol_originator_outflows_lseth": 0.0001234567,
          "period_originator_adjusted_total_net_outflows_lseth": 0.0001234567,
          "period_originator_outflow_ratio": 0.0001234567,
          "period_unattributed_allocated_fees_lseth": 0.0001234567,
          "period_unattributed_balance_lseth": 0.0001234567,
          "period_unattributed_fees_lseth": 0.0001234567
        }
      },
      "period": {
        "end": "2024-01-31T23:59:59Z",
        "end_epoch": 257200,
        "start": "2024-01-01T00:00:00Z",
        "start_epoch": 250000
      },
      "period_protocol_fee_lseth": 0.0001234,
      "period_protocol_fee_rate": 0.1,
      "version": 3
    }
  ],
  "metadata": {
    "next_cursor": "eyJpbmRleCI6MX0"
  }
}

List operator fees

get

List platform operator fees for a given date

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datestringRequired

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

Query parameters

page_sizeintegerOptional

Number of oracle reports per page (1-1000, default 100)

next_cursorstringOptional

Cursor returned from previous page

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

get/eth/v1/operators/{date}

GET /eth/v1/operators/{date} HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "conversion_rate": 1.012345,
      "date": "2023-01-02T03:04:05Z",
      "end_operator_active_keys_count": 5,
      "end_operator_active_keys_ratio": 0.5,
      "end_protocol_active_keys_count": 10,
      "oracle_report": "f071c15d86fd9ae82f62bb4bb04963f14e04045bbcac8b5439984733207821bc000000ef",
      "org_id": "org_example1234",
      "period": {
        "end": "2024-01-31T23:59:59Z",
        "end_epoch": 257200,
        "start": "2024-01-01T00:00:00Z",
        "start_epoch": 250000
      },
      "period_all_operators_fees_lseth": 0.00012,
      "period_operator_fees_lseth": 0.00006,
      "version": 3
    }
  ],
  "metadata": {
    "next_cursor": "eyJpbmRleCI6MX0"
  }
}

List rewards

post

List rewards for a time period

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

page_sizeintegerOptional

Number of lots per page (default: 100, max: 1000)

next_cursorstringOptional

Cursor for next page of lots

Bodyobject · message.GetRewardV4Req[]

balance_lsethstringOptionalExample: 0.382748642252721461

display_ethbooleanOptionalDefault: trueExample: false

endstringOptionalExample: 2024-01-31

startstringOptionalExample: 2024-01-01

Responses

200

application/json

end_balance_lsethstringOptional

end_position_value_ethstringOptional

period_net_rewards_ethstringOptional

period_net_rewards_lsethstringOptionalExample: 0.00003930554936445

position_apystringOptional

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

post/eth/v1/rewards

POST /eth/v1/rewards HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

[
  {
    "balance_lseth": "0.382748642252721461",
    "display_eth": false,
    "end": "2024-01-31",
    "start": "2024-01-01"
  }
]

{
  "end_balance_lseth": "text",
  "end_position_value_eth": "text",
  "lots": [
    {
      "balance_lseth": 0.3827486422527215,
      "end": "2024-01-31",
      "end_conversion_rate": 1.037253225665527,
      "end_position_value_eth": 0.00003930554936445,
      "net_rewards_eth": 0.00003930554936445,
      "net_rewards_lseth": 0.000038075574334017,
      "principal_eth": 1,
      "start": "2024-01-01",
      "start_conversion_rate": 1.0371537463463845
    }
  ],
  "metadata": {
    "next_cursor": "eyJpbmRleCI6MX0"
  },
  "period": {
    "end": "2024-01-31T23:59:59Z",
    "end_epoch": 257200,
    "start": "2024-01-01T00:00:00Z",
    "start_epoch": 250000
  },
  "period_net_rewards_eth": "text",
  "period_net_rewards_lseth": "0.00003930554936445",
  "position_apy": "text"
}

List account rewards

post

List rewards by account for a specific date

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

accountsstring[]OptionalExample: ["bb3e6114-af15-43a6-9b36-a5ec011d9d95"]

daystringOptionalExample: 2024-04-11

include_breakdown_detailsbooleanOptionalExample: false

Responses

200

application/json

account_idstringOptionalExample: bb3e6114-af15-43a6-9b36-a5ec011d9d95

daystringOptionalExample: 2024-04-11

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

post/eth/v1/rewards/accounts

POST /eth/v1/rewards/accounts HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "accounts": [
    "bb3e6114-af15-43a6-9b36-a5ec011d9d95"
  ],
  "day": "2024-04-11",
  "include_breakdown_details": false
}

[
  {
    "account_id": "bb3e6114-af15-43a6-9b36-a5ec011d9d95",
    "account_totals": {
      "cumulative_net_rewards_eth": 0.00003930554936445,
      "end_balance_lseth": 0.3827486422527215,
      "end_position_value_eth": 0.4235486422527215,
      "period_net_rewards_eth": 0.00003930554936445
    },
    "day": "2024-04-11",
    "period": {
      "end": "2024-01-31T23:59:59Z",
      "end_epoch": 257200,
      "start": "2024-01-01T00:00:00Z",
      "start_epoch": 250000
    },
    "wallets": [
      {
        "account_id": "ab3e5114-af15-45b8-9c43-a5ec011d9d95",
        "address": "0x30e2a735D692fC28CD31C28F1A8259b4790f9A23",
        "avg_srr_hist": "0.00534633387",
        "cumulative_burns_lseth": "0.109",
        "cumulative_gross_rewards_eth": "0.000006264174837104",
        "cumulative_lc_fees_eth": "0.000000439297316428",
        "cumulative_mints_lseth": "0.49174864225272146",
        "cumulative_net_rewards_eth": "0.00003930554936445",
        "cumulative_operator_fees_eth": "0.000006264174837104",
        "cumulative_originator_fees_eth": "0.000006264174837104",
        "cumulative_platform_fees_eth": "0.000005364051442679",
        "cumulative_protocol_fees_eth": "0.000006936273417258",
        "cumulative_tech_provider_fees_eth": "0.000000161846379739",
        "day": "2024-04-11",
        "end_balance_lseth": "0.382748642252721461",
        "end_conversion_rate": "1.037253225665527",
        "oracle_report": "68bbc70ba87b9467831cc3ff56fc114f3659ba9e646042007d1d54f6b95f267d00000164",
        "org_id": "org_aDL0aCAXyWYgHQ4W",
        "period": {
          "end": "2024-01-31T23:59:59Z",
          "end_epoch": 257200,
          "start": "2024-01-01T00:00:00Z",
          "start_epoch": 250000
        },
        "period_burns_lseth": "0.1",
        "period_gross_rewards_eth": "0.000006264174837104",
        "period_lc_fees_eth": "0.000000425550536674",
        "period_mints_lseth": "0.482088602351740421",
        "period_net_rewards_eth": "0.000038075574334017",
        "period_operator_fees_eth": "0.000006264174837104",
        "period_originator_fees_eth": "0.000006264174837104",
        "period_platform_fees_eth": "0.00000519619602676",
        "period_protocol_fee_rate": "0.000006264174837104",
        "period_protocol_fees_eth": "0.000006719219000121",
        "period_tech_provider_fees_eth": "0.000000156781776669",
        "start_conversion_rate": "1.0371537463463845"
      }
    ]
  }
]

List wallet rewards

post

List rewards by wallet for a specific date

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

addressesstring[]OptionalExample: ["0x30e2a735D692fC28CD31C28F1A8259b4790f9A23"]

daystringOptionalExample: 2024-04-11

include_breakdown_detailsbooleanOptionalExample: false

Responses

200

application/json

account_idstringOptionalExample: ab3e5114-af15-45b8-9c43-a5ec011d9d95

addressstringOptionalExample: 0x30e2a735D692fC28CD31C28F1A8259b4790f9A23

avg_srr_histstringOptionalExample: 0.00534633387

cumulative_burns_lsethstringOptionalExample: 0.109

cumulative_gross_rewards_ethstringOptionalExample: 0.000006264174837104

cumulative_lc_fees_ethstringOptionalExample: 0.000000439297316428

cumulative_mints_lsethstringOptionalExample: 0.49174864225272146

cumulative_net_rewards_ethstringOptionalExample: 0.00003930554936445

cumulative_operator_fees_ethstringOptionalExample: 0.000006264174837104

cumulative_originator_fees_ethstringOptionalExample: 0.000006264174837104

cumulative_platform_fees_ethstringOptionalExample: 0.000005364051442679

cumulative_protocol_fees_ethstringOptionalExample: 0.000006936273417258

cumulative_tech_provider_fees_ethstringOptionalExample: 0.000000161846379739

daystringOptionalExample: 2024-04-11

end_balance_lsethstringOptionalExample: 0.382748642252721461

end_conversion_ratestringOptionalExample: 1.037253225665527

oracle_reportstringOptionalExample: 68bbc70ba87b9467831cc3ff56fc114f3659ba9e646042007d1d54f6b95f267d00000164

org_idstringOptionalExample: org_aDL0aCAXyWYgHQ4W

period_burns_lsethstringOptionalExample: 0.1

period_gross_rewards_ethstringOptionalExample: 0.000006264174837104

period_lc_fees_ethstringOptionalExample: 0.000000425550536674

period_mints_lsethstringOptionalExample: 0.482088602351740421

period_net_rewards_ethstringOptionalExample: 0.000038075574334017

period_operator_fees_ethstringOptionalExample: 0.000006264174837104

period_originator_fees_ethstringOptionalExample: 0.000006264174837104

period_platform_fees_ethstringOptionalExample: 0.00000519619602676

period_protocol_fee_ratestringOptionalExample: 0.000006264174837104

period_protocol_fees_ethstringOptionalExample: 0.000006719219000121

period_tech_provider_fees_ethstringOptionalExample: 0.000000156781776669

start_conversion_ratestringOptionalExample: 1.0371537463463845

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

post/eth/v1/rewards/wallets

POST /eth/v1/rewards/wallets HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "addresses": [
    "0x30e2a735D692fC28CD31C28F1A8259b4790f9A23"
  ],
  "day": "2024-04-11",
  "include_breakdown_details": false
}

[
  {
    "account_id": "ab3e5114-af15-45b8-9c43-a5ec011d9d95",
    "address": "0x30e2a735D692fC28CD31C28F1A8259b4790f9A23",
    "avg_srr_hist": "0.00534633387",
    "cumulative_burns_lseth": "0.109",
    "cumulative_gross_rewards_eth": "0.000006264174837104",
    "cumulative_lc_fees_eth": "0.000000439297316428",
    "cumulative_mints_lseth": "0.49174864225272146",
    "cumulative_net_rewards_eth": "0.00003930554936445",
    "cumulative_operator_fees_eth": "0.000006264174837104",
    "cumulative_originator_fees_eth": "0.000006264174837104",
    "cumulative_platform_fees_eth": "0.000005364051442679",
    "cumulative_protocol_fees_eth": "0.000006936273417258",
    "cumulative_tech_provider_fees_eth": "0.000000161846379739",
    "day": "2024-04-11",
    "end_balance_lseth": "0.382748642252721461",
    "end_conversion_rate": "1.037253225665527",
    "oracle_report": "68bbc70ba87b9467831cc3ff56fc114f3659ba9e646042007d1d54f6b95f267d00000164",
    "org_id": "org_aDL0aCAXyWYgHQ4W",
    "period": {
      "end": "2024-01-31T23:59:59Z",
      "end_epoch": 257200,
      "start": "2024-01-01T00:00:00Z",
      "start_epoch": 250000
    },
    "period_burns_lseth": "0.1",
    "period_gross_rewards_eth": "0.000006264174837104",
    "period_lc_fees_eth": "0.000000425550536674",
    "period_mints_lseth": "0.482088602351740421",
    "period_net_rewards_eth": "0.000038075574334017",
    "period_operator_fees_eth": "0.000006264174837104",
    "period_originator_fees_eth": "0.000006264174837104",
    "period_platform_fees_eth": "0.00000519619602676",
    "period_protocol_fee_rate": "0.000006264174837104",
    "period_protocol_fees_eth": "0.000006719219000121",
    "period_tech_provider_fees_eth": "0.000000156781776669",
    "start_conversion_rate": "1.0371537463463845"
  }
]

Reward Summary

Get account reward summary (V4)

get

Get reward summary for an account with new V4 parameter structure

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idOrKeystringRequired

Account ID or key

Query parameters

startstringOptional

Start date (YYYY-MM-DD format, defaults to 1 month ago)

endstringOptional

End date (YYYY-MM-DD format, defaults to current time)

include_breakdown_detailsbooleanOptional

Include daily breakdown details (default: false)

page_sizeintegerOptional

Number of daily reports per page (default: 100, max: 1000)

next_cursorstringOptional

Cursor for next page of daily reports

Responses

200

application/json

400

Bad request

application/json

404

Not found

application/json

500

Internal error

application/json

get/eth/v1/rewards/accounts/{idOrKey}/summary

GET /eth/v1/rewards/accounts/{idOrKey}/summary HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "account_id": "ab3e5114-af15-45b8-9c43-a5ec011d9d95",
    "end_conversion_rate": 1.0454865181649966,
    "org_id": "org_aDs4aCACyWYgMQ4A",
    "period": {
      "end": "2024-01-31T23:59:59Z",
      "end_epoch": 257200,
      "start": "2024-01-01T00:00:00Z",
      "start_epoch": 250000
    },
    "period_account_totals": {
      "burns_lseth": 0,
      "gross_rewards_eth": 0.000045747124673728,
      "lc_fees_eth": 4.345976844e-7,
      "mints_lseth": 0.00099376738985375,
      "net_rewards_eth": 0.000038959833189463,
      "operator_fees_eth": 8.189616111e-7,
      "originator_fees_eth": 7.868546e-10,
      "platform_fees_eth": 0.000005236375878362,
      "protocol_fees_eth": 0.000006787291484265,
      "tech_provider_fees_eth": 1.601149364e-7
    },
    "start_conversion_rate": 1.006282340620787,
    "wallets": [
      {
        "account_id": "ab3e5114-af15-45b8-9c43-a5ec011d9d95",
        "address": "0xF523F31Acf07Ff41D2616f9c1b73E762Ba8E5660",
        "daily_reports": [
          {
            "address": "0xF523F31Acf07Ff41D2616f9c1b73E762Ba8E5660",
            "balance_lseth": 0.00099376738985375,
            "conversion_rate": 1.006282340620787,
            "daily_burns_lseth": 2.22405e-13,
            "daily_gross_rewards_eth": 0.000006264174837104,
            "daily_lc_fees_eth": 7.868546e-10,
            "daily_mints_lseth": 4.45541235e-8,
            "daily_net_rewards_eth": 7.45441235e-8,
            "daily_operator_fees_eth": 1.2424021e-9,
            "daily_originator_fees_eth": 7.868546e-10,
            "daily_platform_fees_eth": 5.7150495e-9,
            "daily_protocol_fee_rate": 0.000006264174837104,
            "daily_protocol_fees_eth": 8.28268039e-8,
            "daily_tech_provider_fees_eth": 2.898938e-10,
            "date": "2024-04-01",
            "oracle_report": "68bbc70ba87b9467831cc3ff56fc114f3659ba9e646042007d1d54f6b95f267d00000164",
            "previous_conversion_rate": 1.0371537463463845
          }
        ]
      }
    ]
  },
  "metadata": {
    "next_cursor": "eyJpbmRleCI6MX0"
  }
}

Get wallet reward summary (V4)

get

Get reward summary for a wallet address with new V4 parameter structure

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idOrAddressstringRequired

Wallet ID or address (0x-prefixed hex)

Query parameters

startstringOptional

Start date (YYYY-MM-DD format, defaults to 1 month ago)

endstringOptional

End date (YYYY-MM-DD format, defaults to current time)

include_breakdown_detailsbooleanOptional

Include daily breakdown details (default: false)

page_sizeintegerOptional

Number of daily reports per page (default: 100, max: 1000)

next_cursorstringOptional

Cursor for next page of daily reports

Responses

200

application/json

400

Bad request

application/json

404

Not found

application/json

500

Internal error

application/json

get/eth/v1/rewards/wallets/{idOrAddress}/summary

GET /eth/v1/rewards/wallets/{idOrAddress}/summary HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "account_id": "ab3e5114-af15-45b8-9c43-a5ec011d9d95",
    "address": "0xF523F31Acf07Ff41D2616f9c1b73E762Ba8E5660",
    "daily_reports": [
      {
        "address": "0xF523F31Acf07Ff41D2616f9c1b73E762Ba8E5660",
        "balance_lseth": 0.00099376738985375,
        "conversion_rate": 1.006282340620787,
        "daily_burns_lseth": 2.22405e-13,
        "daily_gross_rewards_eth": 0.000006264174837104,
        "daily_lc_fees_eth": 7.868546e-10,
        "daily_mints_lseth": 4.45541235e-8,
        "daily_net_rewards_eth": 7.45441235e-8,
        "daily_operator_fees_eth": 1.2424021e-9,
        "daily_originator_fees_eth": 7.45441235e-8,
        "daily_platform_fees_eth": 5.7150495e-9,
        "daily_protocol_fee_rate": 0.000006264174837104,
        "daily_protocol_fees_eth": 8.28268039e-8,
        "daily_tech_provider_fees_eth": 2.898938e-10,
        "date": "2024-04-01",
        "oracle_report": "68bbc70ba87b9467831cc3ff56fc114f3659ba9e646042007d1d54f6b95f267d00000164",
        "previous_conversion_rate": 1.0371537463463845
      }
    ],
    "end_conversion_rate": 1.0454865181649966,
    "org_id": "org_aDs4aCACyWYgMQ4A",
    "period": {
      "end": "2024-01-31T23:59:59Z",
      "end_epoch": 257200,
      "start": "2024-01-01T00:00:00Z",
      "start_epoch": 250000
    },
    "period_wallet_totals": {
      "burns_lseth": 0,
      "gross_rewards_eth": 0.000045747124673728,
      "lc_fees_eth": 4.345976844e-7,
      "mints_lseth": 0.00099376738985375,
      "net_rewards_eth": 0.000038959833189463,
      "operator_fees_eth": 8.189616111e-7,
      "originator_fees_eth": 7.868546e-10,
      "platform_fees_eth": 0.000005236375878362,
      "protocol_fees_eth": 0.000006787291484265,
      "tech_provider_fees_eth": 1.601149364e-7
    },
    "start_conversion_rate": 1.006282340620787
  },
  "metadata": {
    "next_cursor": "eyJpbmRleCI6MX0"
  }
}

PreviousRedemption API NextPublic APIs

Last updated 29 days ago

Was this helpful?