Ethereum Data API

Ethereum Data API is a collection of APIs that expose read data from the Ethereum network.

Get latest status of the Ethereum protocol

get

Get global information about protocol token supplies

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

active_validator_countintegerOptional

Count of total validators minus stopped validators on the consensus layer

Example: 58

active_validators_eth_balancestringOptional

Total consensus ETH balance of all validators on the consensus layer (as reported by the Oracle) in Wei

Example: 128000000000000000000

block_numberintegerOptional

Height of the returned data

Example: 15034284

collected_rewardsstringOptional

Total collected rewards

Example: 3200000000000000000000

contract_eth_balancestringOptional

ETH balance on the contract in Wei

Example: 5000000000000000000

conversion_ratenumberOptional

deposit_countintegerOptional

Number of deposits

Example: 2

exited_validators_eth_balancestringOptional

Total ETH balance of exited validators on the consensus layer (as reported by the Oracle) in Wei

Example: 128000000000000000000

exiting_validators_eth_balancestringOptional

Total ETH balance of exiting validators on the consensus layer (as reported by the Oracle) in Wei

Example: 128000000000000000000

funded_validator_countintegerOptional

Count of funded validators

Example: 102

funded_valitor_countintegerOptional

Previous typo made, keeping for backwards compatibility

Example: 102

pending_validator_countintegerOptional

Count of funded validators and pending activation on the consensus layer (as reported by the Oracle)

Example: 2

pending_validators_eth_balancestringOptional

Total ETH balance of pending validators in GWei

Example: 64000000000000000000

rebalance_deposit_to_redeem_modebooleanOptionalExample: true

skimmed_validators_eth_balancestringOptional

Total ETH balance of skimmed withdrawals (as reported by the Oracle) in Wei

Example: 128000000000000000000

slashing_containment_modebooleanOptionalExample: false

stopped_validator_countintegerOptional

Count of stopped LC validators on the consensus layer (as reported by the Oracle)

Example: 42

total_eth_balancestringOptional

Total ETH balance managed by the River protocol in GWei

Example: 3200000000000000000000

total_eth_depositedstringOptional

Total ETH deposited

Example: 3200000000000000000000

total_supplystringOptional

Total LsETH supply

Example: 3200000000000000000000

total_validator_countintegerOptional

Count of all LC validators found on the consensus layer (as reported by the Oracle)

Example: 100

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

get

/eth/v0/status

HTTPcURLJavaScriptPython

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

{
  "active_validator_count": 58,
  "active_validators_eth_balance": "128000000000000000000",
  "block_number": 15034284,
  "collected_rewards": "3200000000000000000000",
  "contract_eth_balance": "5000000000000000000",
  "conversion_rate": 1,
  "deposit_count": 2,
  "exited_validators_eth_balance": "128000000000000000000",
  "exiting_validators_eth_balance": "128000000000000000000",
  "funded_validator_count": 102,
  "funded_valitor_count": 102,
  "pending_validator_count": 2,
  "pending_validators_eth_balance": "64000000000000000000",
  "rebalance_deposit_to_redeem_mode": true,
  "skimmed_validators_eth_balance": "128000000000000000000",
  "slashing_containment_mode": false,
  "stopped_validator_count": 42,
  "total_eth_balance": "3200000000000000000000",
  "total_eth_deposited": "3200000000000000000000",
  "total_supply": "3200000000000000000000",
  "total_validator_count": 100
}

Get status of the Ethereum protocol at a given block number

get

Get global information about protocol token supplies at a given block number

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

block_numberintegerRequired

Block height to query

Responses

200

OK

application/json

active_validator_countintegerOptional

Count of total validators minus stopped validators on the consensus layer

Example: 58

active_validators_eth_balancestringOptional

Total consensus ETH balance of all validators on the consensus layer (as reported by the Oracle) in Wei

Example: 128000000000000000000

block_numberintegerOptional

Height of the returned data

Example: 15034284

collected_rewardsstringOptional

Total collected rewards

Example: 3200000000000000000000

contract_eth_balancestringOptional

ETH balance on the contract in Wei

Example: 5000000000000000000

conversion_ratenumberOptional

deposit_countintegerOptional

Number of deposits

Example: 2

exited_validators_eth_balancestringOptional

Total ETH balance of exited validators on the consensus layer (as reported by the Oracle) in Wei

Example: 128000000000000000000

exiting_validators_eth_balancestringOptional

Total ETH balance of exiting validators on the consensus layer (as reported by the Oracle) in Wei

Example: 128000000000000000000

funded_validator_countintegerOptional

Count of funded validators

Example: 102

funded_valitor_countintegerOptional

Previous typo made, keeping for backwards compatibility

Example: 102

pending_validator_countintegerOptional

Count of funded validators and pending activation on the consensus layer (as reported by the Oracle)

Example: 2

pending_validators_eth_balancestringOptional

Total ETH balance of pending validators in GWei

Example: 64000000000000000000

rebalance_deposit_to_redeem_modebooleanOptionalExample: true

skimmed_validators_eth_balancestringOptional

Total ETH balance of skimmed withdrawals (as reported by the Oracle) in Wei

Example: 128000000000000000000

slashing_containment_modebooleanOptionalExample: false

stopped_validator_countintegerOptional

Count of stopped LC validators on the consensus layer (as reported by the Oracle)

Example: 42

total_eth_balancestringOptional

Total ETH balance managed by the River protocol in GWei

Example: 3200000000000000000000

total_eth_depositedstringOptional

Total ETH deposited

Example: 3200000000000000000000

total_supplystringOptional

Total LsETH supply

Example: 3200000000000000000000

total_validator_countintegerOptional

Count of all LC validators found on the consensus layer (as reported by the Oracle)

Example: 100

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

get

/eth/v0/status/{block_number}

HTTPcURLJavaScriptPython

GET /eth/v0/status/{block_number} HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "active_validator_count": 58,
  "active_validators_eth_balance": "128000000000000000000",
  "block_number": 15034284,
  "collected_rewards": "3200000000000000000000",
  "contract_eth_balance": "5000000000000000000",
  "conversion_rate": 1,
  "deposit_count": 2,
  "exited_validators_eth_balance": "128000000000000000000",
  "exiting_validators_eth_balance": "128000000000000000000",
  "funded_validator_count": 102,
  "funded_valitor_count": 102,
  "pending_validator_count": 2,
  "pending_validators_eth_balance": "64000000000000000000",
  "rebalance_deposit_to_redeem_mode": true,
  "skimmed_validators_eth_balance": "128000000000000000000",
  "slashing_containment_mode": false,
  "stopped_validator_count": 42,
  "total_eth_balance": "3200000000000000000000",
  "total_eth_deposited": "3200000000000000000000",
  "total_supply": "3200000000000000000000",
  "total_validator_count": 100
}

List LsETH balance of several addresses

get

List LsETH balance of several addresses It is possible to specify for which block and which addresses to get the balances.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

addressesstringOptional

Comma separated list of addresses (if empty returns all addresses)

block_numberintegerOptional

Block number at which to get balance for (latest by default)

limitintegerOptional

Limit of elements to return (100 by default)

Responses

200

OK

application/json

addressstringOptional

Owner address

Example: 0x123456789985ca04a69c35978c3a3e778d6ef172

balancestringOptional

LsETH balance

Example: 4200000000000000000000

block_numberintegerOptional

Block height of the balance

Example: 15034284

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

get

/eth/v0/balances

HTTPcURLJavaScriptPython

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

[
  {
    "address": "0x123456789985ca04a69c35978c3a3e778d6ef172",
    "balance": "4200000000000000000000",
    "block_number": 15034284
  }
]

Get LsETH balance of a given address

get

Get LsETH balance of a given address It is possible to specify for which block to get the balance at.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

addressstringRequired

Account address to query the balance for

Query parameters

block_numberintegerOptional

Block number at which to get balance for (latest by default)

Responses

200

OK

application/json

addressstringOptional

Owner address

Example: 0x123456789985ca04a69c35978c3a3e778d6ef172

balancestringOptional

LsETH balance

Example: 4200000000000000000000

block_numberintegerOptional

Block height of the balance

Example: 15034284

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

get

/eth/v0/balances/{address}

HTTPcURLJavaScriptPython

GET /eth/v0/balances/{address} HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "address": "0x123456789985ca04a69c35978c3a3e778d6ef172",
  "balance": "4200000000000000000000",
  "block_number": 15034284
}

Get LsETH balance history

get

Get the LsETH balance history for a given address It returns a balance object for every block a balance change occurred It is possible to filter the history for a range only blocks

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

addressstringRequired

Address of the balance to query balance for

Query parameters

from_blockintegerOptional

Starting block height to query (0 by default)

to_blockintegerOptional

Ending block height to query (latest by default)

limitintegerOptional

Limit of elements to return (100 by default)

Responses

200

OK

application/json

addressstringOptional

Owner address

Example: 0x123456789985ca04a69c35978c3a3e778d6ef172

balancestringOptional

LsETH balance

Example: 4200000000000000000000

block_numberintegerOptional

Block height of the balance

Example: 15034284

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

get

/eth/v0/balances/{address}/history

HTTPcURLJavaScriptPython

GET /eth/v0/balances/{address}/history HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "address": "0x123456789985ca04a69c35978c3a3e778d6ef172",
    "balance": "4200000000000000000000",
    "block_number": 15034284
  }
]

List the smart contracts

get

List all the smart contracts addresses used

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

allowlisterinteger[]Optional

deployment_blockintegerOptional

el_fee_recipientinteger[]Optional

operators_registryinteger[]Optional

oracleinteger[]Optional

redeem_managerinteger[]Optional

riverinteger[]Optional

withdrawinteger[]Optional

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal error

application/json

get

/eth/v0/contracts

HTTPcURLJavaScriptPython

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

{
  "allowlister": [
    1
  ],
  "deployment_block": 1,
  "el_fee_recipient": [
    1
  ],
  "operators_registry": [
    1
  ],
  "oracle": [
    1
  ],
  "redeem_manager": [
    1
  ],
  "river": [
    1
  ],
  "withdraw": [
    1
  ]
}