Redemption API

Redemption API is a collection of APIs that expose read data on redemptions.

To see APIs used in an example implementation check out the Redemption guide (below).

List the redeem requests

get

List the redeem requests for one or multiple owners (addresses)

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ownerstringRequired

The address or addresses to query, separated by commas

Responses

200

OK

application/json

claimable_amount_lsethnumberOptional

The possible amount available to claim in LsETH

claimed_amount_ethnumberOptional

The amount already claimed in ETH

claimed_amount_lsethnumberOptional

The amount already claimed in LsETH

heightnumberOptional

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

idintegerOptional

The ID of the redeem request

max_redeemable_amount_ethnumberOptional

The maximum amount of ETH redeemable by this request

ownerinteger[]Optional

The owner of the redeem request

requested_atintegerOptional

Block time

status_claimall ofOptional

The status of the claimed request

string · enumOptionalPossible values:

status_satisfactionall ofOptional

The status of the satisfaction (withdrawal stack matching the redeem queue)

string · enumOptionalPossible values:

timestampstringOptional

Timestamp

total_amount_lsethnumberOptional

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)

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Error

application/json

get

/eth/v0/redeems

HTTPcURLJavaScriptPython

GET /eth/v0/redeems?owner=text HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List a redeem request by id

get

List a redeem request by the request id, obtained from /eth/v0/redeems

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idxintegerRequired

The redeem request id to query

Responses

200

OK

application/json

claimable_amount_lsethnumberOptional

The possible amount available to claim in LsETH

claimed_amount_ethnumberOptional

The amount already claimed in ETH

claimed_amount_lsethnumberOptional

The amount already claimed in LsETH

heightnumberOptional

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

idintegerOptional

The ID of the redeem request

max_redeemable_amount_ethnumberOptional

The maximum amount of ETH redeemable by this request

ownerinteger[]Optional

The owner of the redeem request

requested_atintegerOptional

Block time

status_claimall ofOptional

The status of the claimed request

string · enumOptionalPossible values:

status_satisfactionall ofOptional

The status of the satisfaction (withdrawal stack matching the redeem queue)

string · enumOptionalPossible values:

timestampstringOptional

Timestamp

total_amount_lsethnumberOptional

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)

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Error

application/json

get

/eth/v0/redeems/{idx}

HTTPcURLJavaScriptPython

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

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

Get a redeem request time projection

get

Get a redeem request time projection for becoming redeemable

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idxintegerRequired

The redeem request id to query

Responses

200

OK

application/json

projected_redeemable_atstringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Error

application/json

get

/eth/v0/redeems/{idx}/projection

HTTPcURLJavaScriptPython

GET /eth/v0/redeems/{idx}/projection HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "projected_redeemable_at": "text"
}

List the redeem manager

get

List the withdrawal event height and redeem request height

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

total_amount_redeem_queue_lsethnumberOptional

The cumulative sum of the redeem request heights

total_amount_withdrawal_stack_lsethnumberOptional

The cumulative sum of the withdrawal event heights

404

Not Found

application/json

500

Internal Error

application/json

get

/eth/v0/redeems_info

HTTPcURLJavaScriptPython

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

{
  "total_amount_redeem_queue_lseth": 1,
  "total_amount_withdrawal_stack_lseth": 1
}

Get the redeem manager time projection

get

Get the redeem manager time projection for being fulfilled

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

projected_fulfilled_atstringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/eth/v0/redeems_info/projection

HTTPcURLJavaScriptPython

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

{
  "projected_fulfilled_at": "text"
}

Returns validator exit queue info

get

Returns validator exit queue info, inclding time estimates.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

exit_time_hoursnumberOptional

mandatory_exit_delay_hoursnumberOptional

sweep_time_hoursnumberOptional

500

Internal error

application/json

get

/eth/v0/validators/queue

HTTPcURLJavaScriptPython

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

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