Api vault view redemption queue response
ApiVaultViewRedemptionQueueResponse
Response payload for a vault manager to view the redemption queue for their vault, ordered by descending priority.
Also includes counters for total redemption sizes pending as well as urgent (refer to API integration guide for more detail on redemption request classifications).
NameLite |
Type | RequiredDefault |
Description |
|---|---|---|---|
redemption_queuerq |
[VaultRedemptionRequest] | True | Outstanding vault redemption requests, ordered by descending priority. Excludes requests that have not yet aged past the minimum redemption period. |
pending_redemption_token_countpr |
string | True | Number of shares eligible for automated redemption (held in queue for at least the minimum redemption period). |
urgent_redemption_token_countur |
string | True | Number of shares nearing the maximum redemption period (>= 90% of maximum redemption period). |
auto_redeemable_balancear |
string | True | Amount available for automated redemption request servicing (in USD). |
share_pricesp |
string | True | Current share price (in USD). |
pre_minpm |
PreMinRedemptions | True | Dedicated section for requests yet to wait at least the minimum redemption period. |
VaultRedemptionRequest
Representation of a pending redemption request for a given vault.
NameLite |
Type | RequiredDefault |
Description |
|---|---|---|---|
request_timert |
string | True | [Filled by GRVT Backend] Time at which the redemption request was received by GRVT in unix nanoseconds |
num_lp_tokensnl |
string | True | The number of shares to redeem |
max_redemption_period_timestampmr |
string | True | [Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be force-redeemed. |
age_categoryac |
VaultRedemptionReqAgeCategory | True | Age category of this redemption request. |
is_managerim |
boolean | FalseNone |
true if this request belongs to the vault manager, omitted otherwise. |
eligible_for_auto_redemption_timestampef |
string | True | [Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be eligible for automated redemption. |
VaultRedemptionReqAgeCategory
Denotes the age category of a given redemption request.
| Value | Description |
|---|---|
NORMAL = 1 |
This request is at least as old as the minimum redemption period, and is eligible for automated redemption. |
URGENT = 2 |
This request is nearing the maxmimum redemption period and will be factored into pre-order check margin requirements. |
OVERDUE = 3 |
This request has exceeded the maximum redemption period and will be considered for forced redemptions. |
PRE_MIN = 4 |
This request has yet to exceed the minimum redemption period, and is not yet eligible for automated redemption. |
PreMinRedemptions
Vault redemption queue section hidden from main view. All requests here have yet to age past the vault's minimum redemption period.
NameLite |
Type | RequiredDefault |
Description |
|---|---|---|---|
requestsr |
[VaultRedemptionRequest] | True | Pre-minimum-age redemption requests, ordered by age (first element is the oldest request that is pre-minimum-age). |
token_counttc |
string | True | Number of shares in the pre-minimum-age section of the vault's redemption queue. |
VaultRedemptionRequest
Representation of a pending redemption request for a given vault.
NameLite |
Type | RequiredDefault |
Description |
|---|---|---|---|
request_timert |
string | True | [Filled by GRVT Backend] Time at which the redemption request was received by GRVT in unix nanoseconds |
num_lp_tokensnl |
string | True | The number of shares to redeem |
max_redemption_period_timestampmr |
string | True | [Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be force-redeemed. |
age_categoryac |
VaultRedemptionReqAgeCategory | True | Age category of this redemption request. |
is_managerim |
boolean | FalseNone |
true if this request belongs to the vault manager, omitted otherwise. |
eligible_for_auto_redemption_timestampef |
string | True | [Filled by GRVT Backend] Time in unix nanoseconds, beyond which the request will be eligible for automated redemption. |
VaultRedemptionReqAgeCategory
Denotes the age category of a given redemption request.
| Value | Description |
|---|---|
NORMAL = 1 |
This request is at least as old as the minimum redemption period, and is eligible for automated redemption. |
URGENT = 2 |
This request is nearing the maxmimum redemption period and will be factored into pre-order check margin requirements. |
OVERDUE = 3 |
This request has exceeded the maximum redemption period and will be considered for forced redemptions. |
PRE_MIN = 4 |
This request has yet to exceed the minimum redemption period, and is not yet eligible for automated redemption. |