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

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

get

/eth/v0/redeems

Authorizations

Query parameters

ownerstringrequired

The address or addresses to query, separated by commas

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alluvial.finance/eth/v0/redeems?owner=text' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

500

200

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

OK

List a redeem request by id

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

get

/eth/v0/redeems/{idx}

Authorizations

Path parameters

idxintegerrequired

The redeem request id to query

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

404

500

200

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

OK

Get a redeem request time projection

Get a redeem request time projection for becoming redeemable

get

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

Authorizations

Path parameters

idxintegerrequired

The redeem request id to query

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

404

500

200

{
  "projected_redeemable_at": "text"
}

OK

List the redeem manager

List the withdrawal event height and redeem request height

get

/eth/v0/redeems_info

Authorizations

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alluvial.finance/eth/v0/redeems_info' \
  --header 'Authorization: Bearer JWT'

200

404

500

200

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

OK

Get the redeem manager time projection

Get the redeem manager time projection for being fulfilled

get

/eth/v0/redeems_info/projection

Authorizations

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alluvial.finance/eth/v0/redeems_info/projection' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

{
  "projected_fulfilled_at": "text"
}

OK