Last updated 1 month ago
Was this helpful?
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 for one or multiple owners (addresses)
The address or addresses to query, separated by commas
GET /eth/v0/redeems HTTP/1.1 Host: api.alluvial.finance Authorization: Bearer JWT Accept: */*
OK
[ { "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 the request id, obtained from /eth/v0/redeems
/eth/v0/redeems
The redeem request id to query
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 for becoming redeemable
GET /eth/v0/redeems/{idx}/projection HTTP/1.1 Host: api.alluvial.finance Authorization: Bearer JWT Accept: */*
{ "projected_redeemable_at": "text" }
List the withdrawal event height and redeem request height
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 for being fulfilled
GET /eth/v0/redeems_info/projection HTTP/1.1 Host: api.alluvial.finance Authorization: Bearer JWT Accept: */*
{ "projected_fulfilled_at": "text" }
