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).

urlhttps://github.com/AlluvialFinance/alluvial-docs/blob/main/guides/redemptions.md

List the redeem requests

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

GET//eth/v0/redeems

Query parameters

Response

200400401403500

OK

Body

application/json

claimable_amount_lsethnumber

The possible amount available to claim in LsETH

claimed_amount_lsethnumber

The amount already claimed in LsETH

heightnumber

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

idinteger

The ID of the redeem request

max_redeemable_amount_ethnumber

The maximum amount of ETH redeemable by this request

ownerarray of integer

The owner of the redeem request

requested_atinteger

Block time

status_claimall of

The status of the claimed request

status_satisfactionall of

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

total_amount_lsethnumber

The amount of the redeem request in LsETH

withdrawal_event_idinteger

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

Request

JavaScriptCurl

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

Response

[
  {
    "claimable_amount_lseth": 0,
    "claimed_amount_lseth": 0,
    "height": 0,
    "max_redeemable_amount_eth": 0,
    "owner": [],
    "status_claim": {},
    "status_satisfaction": {},
    "total_amount_lseth": 0
  }
]

List a redeem request by id

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

GET//eth/v0/redeems/{idx}

Path parameters

idx*integer

The redeem request id to query

Response

200400401404500

OK

Body

application/json

claimable_amount_lsethnumber

The possible amount available to claim in LsETH

claimed_amount_lsethnumber

The amount already claimed in LsETH

heightnumber

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

idinteger

The ID of the redeem request

max_redeemable_amount_ethnumber

The maximum amount of ETH redeemable by this request

ownerarray of integer

The owner of the redeem request

requested_atinteger

Block time

status_claimall of

The status of the claimed request

status_satisfactionall of

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

total_amount_lsethnumber

The amount of the redeem request in LsETH

withdrawal_event_idinteger

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

Request

JavaScriptCurl

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

Response

{
  "claimable_amount_lseth": 0,
  "claimed_amount_lseth": 0,
  "height": 0,
  "max_redeemable_amount_eth": 0,
  "owner": [],
  "status_claim": {},
  "status_satisfaction": {},
  "total_amount_lseth": 0
}

Get a redeem request time projection

Get a redeem request time projection for becoming redeemable

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

Path parameters

idx*integer

The redeem request id to query

Response

200400401404500

OK

Body

application/json

projected_redeemable_atstring

Request

JavaScriptCurl

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

Response

{
  "projected_redeemable_at": "text"
}

List the redeem manager

List the withdrawal event height and redeem request height

GET//eth/v0/redeems_info

Response

200404500

OK

Body

application/json

total_amount_redeem_queue_lsethnumber

The cumulative sum of the redeem request heights

total_amount_withdrawal_stack_lsethnumber

The cumulative sum of the withdrawal event heights

Request

JavaScriptCurl

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

Response

{
  "total_amount_redeem_queue_lseth": 0,
  "total_amount_withdrawal_stack_lseth": 0
}

Get the redeem manager time projection

Get the redeem manager time projection for being fulfilled

GET//eth/v0/redeems_info/projection

Response

200400401404

OK

Body

application/json

projected_fulfilled_atstring

Request

JavaScriptCurl

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

Response

{
  "projected_fulfilled_at": "text"
}