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
200
OK
application/json
get
GET /eth/v0/redeems HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer JWT
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
Path parameters
idxintegerRequired

The redeem request id to query

Responses
200
OK
application/json
get
GET /eth/v0/redeems/{idx} HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer JWT
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
Path parameters
idxintegerRequired

The redeem request id to query

Responses
200
OK
application/json
get
GET /eth/v0/redeems/{idx}/projection HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer JWT
Accept: */*

{
  "projected_redeemable_at": "text"
}

List the redeem manager

get

List the withdrawal event height and redeem request height

Authorizations
Responses
200
OK
application/json
get
GET /eth/v0/redeems_info HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer JWT
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
Responses
200
OK
application/json
get
GET /eth/v0/redeems_info/projection HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer JWT
Accept: */*

{
  "projected_fulfilled_at": "text"
}
PreviousAllowlisting APINextReporting API

Last updated

Was this helpful?