All pages
Powered by GitBook
1 of 1

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
Query parameters
ownerstringrequired

The address or addresses to query, separated by commas

Responses
curl -L \
  --url 'https://api.alluvial.finance/eth/v0/redeems?owner=text' \
  --header 'Authorization: Bearer JWT'
[
  {
    "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
  }
]

OK

List a redeem request by id

get

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

Authorizations
Path parameters
idxintegerrequired

The redeem request id to query

Responses
curl -L \
  --url 'https://api.alluvial.finance/eth/v0/redeems/{idx}' \
  --header 'Authorization: Bearer JWT'
{
  "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
}

OK

Get a redeem request time projection

get

Get a redeem request time projection for becoming redeemable

Authorizations
Path parameters
idxintegerrequired

The redeem request id to query

Responses
curl -L \
  --url 'https://api.alluvial.finance/eth/v0/redeems/{idx}/projection' \
  --header 'Authorization: Bearer JWT'
{
  "projected_redeemable_at": "text"
}

OK

List the redeem manager

get

List the withdrawal event height and redeem request height

Authorizations
Responses
curl -L \
  --url 'https://api.alluvial.finance/eth/v0/redeems_info' \
  --header 'Authorization: Bearer JWT'
{
  "total_amount_redeem_queue_lseth": 1,
  "total_amount_withdrawal_stack_lseth": 1
}

OK

Get the redeem manager time projection

get

Get the redeem manager time projection for being fulfilled

Authorizations
Responses
curl -L \
  --url 'https://api.alluvial.finance/eth/v0/redeems_info/projection' \
  --header 'Authorization: Bearer JWT'
{
  "projected_fulfilled_at": "text"
}

OK