Public APIs

Alluvial exposes several non-authenticated APIs to support DApps

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"
  }
]

Get wallet rewards (V4 Public API)

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

addressstringRequired

Wallet address (0x-prefixed hex)

Query parameters

startstringRequired

Start date (YYYY-MM-DD format)

endstringOptional

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

display_ethstringOptional

Display ETH fields (default: true)

csvstringOptional

Export to CSV

Responses

200

400

Bad request

404

Not found

500

Internal error

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

GET /eth/v1/wallet/{address}/rewards?start=text HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "address": "0x30e2a735D692fC28CD31C28F1A8259b4790f9A23",
    "daily_reports": [
      {
        "address": "0x30e2a735D692fC28CD31C28F1A8259b4790f9A23",
        "avg_srr_hist": 0.00534633387,
        "balance_lseth": 0.3827486422527215,
        "conversion_rate": 1.037253225665527,
        "cumulative_burns_lseth": 0.109,
        "cumulative_fees_eth": 0.000006936273417258,
        "cumulative_mints_lseth": 0.49174864225272147,
        "cumulative_rewards_eth": 0.00003930554936445,
        "daily_burns_lseth": 0.1,
        "daily_fees_eth": 0.000006719219000121,
        "daily_mints_lseth": 0.48208860235174045,
        "daily_net_rewards_eth": 0.000038075574334017,
        "date": "2024-04-11",
        "oracle_report": "68bbc70ba87b9467831cc3ff56fc114f3659ba9e646042007d1d54f6b95f267d00000164",
        "previous_conversion_rate": 1.0371537463463845
      }
    ],
    "end_conversion_rate": 1.0454865181649966,
    "period": {
      "end": "2024-01-31T23:59:59Z",
      "end_epoch": 257200,
      "start": "2024-01-01T00:00:00Z",
      "start_epoch": 250000
    },
    "period_burns_lseth": 0.109,
    "period_fees_eth": 0.000006936273417258,
    "period_mints_lseth": 0.49174864225272147,
    "period_rewards_eth": 0.00003930554936445,
    "start_conversion_rate": 1.006282340620787
  },
  "metadata": {
    "next_cursor": "eyJpbmRleCI6MX0"
  }
}

Get wallet status

get

Provides status information of the wallet (ex. ALLOWLISTED, SUBMITTED, etc...)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

addressstringRequired

Wallet address

Responses

200

application/json

allowlistedbooleanOptionalExample: true

statusstringOptionalExample: ALLOWLISTED| PAUSED | DENIED

400

Bad request

application/json

404

Not found

application/json

500

Internal error

application/json

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

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

{
  "allowlisted": true,
  "status": "ALLOWLISTED| PAUSED | DENIED"
}

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"
  }
}

List the redeem requests (V1)

get

List redeem requests filtered by owner addresses and/or specific redeem IDs. At least one of owner or ids must be provided. When both are set the filters are combined (AND): only redeems whose ID is in the list AND whose owner is in the list are returned. IDs not found are silently omitted.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ownerstringOptional

Owner address(es), comma-separated. Required if ids is not set.

idsstringOptional

Comma-separated list of redeem request IDs (max 500). Required if owner is not set.

display_ethbooleanOptional

Include claimable_amount_eth in response (default: true)

Responses

200

application/json

claimable_amount_ethstringOptional

The possible amount available to claim in ETH (only present when display_eth is true)

claimable_amount_lsethstringOptional

The possible amount available to claim in LsETH

claimed_amount_ethstringOptional

The amount already claimed in ETH

claimed_amount_lsethstringOptional

The amount already claimed in LsETH

heightstringOptional

The height is the cumulative sum of all the sizes of preceding redeem requests

idintegerOptional

The ID of the redeem request

Example: 1048576

max_redeemable_amount_ethstringOptional

The maximum amount of ETH redeemable by this request

ownerstringOptional

The owner of the redeem request

requested_atintegerOptional

Block time

status_claimstring · enumOptionalPossible values:

status_satisfactionstring · enumOptionalPossible values:

timestampstringOptional

Timestamp

total_amount_lsethstringOptional

The amount of the redeem request in LsETH

withdrawal_event_idintegerOptional

The withdrawal event ID needed to claim the redeem (or -1 when no withdrawals available)

Example: 42

400

Bad Request

application/json

500

Internal Error

application/json

get/eth/v1/redeems

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

[
  {
    "claimable_amount_eth": "text",
    "claimable_amount_lseth": "text",
    "claimed_amount_eth": "text",
    "claimed_amount_lseth": "text",
    "height": "text",
    "id": 1048576,
    "max_redeemable_amount_eth": "text",
    "owner": "text",
    "requested_at": 1,
    "status_claim": "NOT_CLAIMED",
    "status_satisfaction": "PENDING_SATISFACTION",
    "timestamp": "text",
    "total_amount_lseth": "text",
    "withdrawal_event_id": 42
  }
]

Returns validator exit queue info

get

Returns validator exit queue info, including time estimates.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

exit_time_hoursstringOptional

mandatory_exit_delay_hoursstringOptional

sweep_time_hoursstringOptional

500

Internal error

application/json

get/eth/v1/validators/queue

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

{
  "exit_time_hours": "text",
  "mandatory_exit_delay_hours": "text",
  "sweep_time_hours": "text"
}

PreviousReporting API NextThird Party Integration Guides

Last updated 29 days ago

Was this helpful?