vip.v1.VIPService
GetVIPStatus
Get VIP qualification status for the authenticated caller's root account.
Request
curl --request POST \ \
--url 'https://api.testnet.polyester.com/vip.v1.VIPService/GetVIPStatus' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{}'Responses
{
"aopTier": 10,
"averageAop30dUsd": "25000",
"averageAopQuality": {
"incompleteHours": 720,
"status": "COMPLETE"
},
"effectiveFrom": "2025-01-01T00:00:00Z",
"evaluatedAt": "2025-01-01T00:00:00Z",
"metricsAsOf": "2025-01-01T00:00:00Z",
"nextTierThresholds": {
"aopThresholdUsd": "50000",
"tier": 1,
"volumeThresholdUsd": "12.3456"
},
"policyEffectiveFrom": "2025-01-01T00:00:00Z",
"policyVersion": "1",
"settledVolume30dUsd": "12.3456",
"settledVolumeQuality": {
"incompleteHours": 720,
"status": "COMPLETE"
},
"tier": 10,
"volumeTier": 123456
}vip.v1.GetVIPStatusRequestvip.v1.GetVIPStatusResponseEffective VIP tier in the inclusive range 0 through 10.
Tier earned from rolling 30-day settled spot volume, in the inclusive range 0 through 10.
Tier earned from rolling 30-day average portfolio value, in the inclusive range 0 through 10.
Rolling 30-day settled spot volume in USD, encoded as a non-negative base-10 decimal string without separators or a currency symbol. When settled_volume_quality.status is PRICE_UNAVAILABLE, this is a lower bound that excludes executions without an admissible USD reference price. Omitted when settled_volume_quality is omitted or its status is INCOMPLETE_HISTORY.
Rolling 30-day average portfolio value in USD, encoded as a non-negative base-10 decimal string without separators or a currency symbol. Omitted unless average_aop_quality.status is COMPLETE.
Positive identifier of the VIP policy used for this assignment.
UTC time at which the selected assignment policy became effective.
UTC time from which the explicit VIP assignment is effective. Omitted while a new account is using the default VIP0 tier.
UTC time at which the explicit assignment was evaluated. Omitted while a new account is using the default VIP0 tier.
UTC cutoff of the rolling metrics used for this assignment. Omitted when neither settled_volume_30d_usd nor average_aop_30d_usd is present.
Numeric next tier in the inclusive range 1 through 10.
Rolling 30-day settled spot volume entry threshold in USD, encoded as a non-negative base-10 decimal string without separators or a currency symbol.
Rolling 30-day average portfolio value entry threshold in USD, encoded as a positive base-10 decimal string without separators or a currency symbol.
Completeness status of the metric.
Number of hourly buckets in the rolling 720-hour window that are missing or incomplete. Zero when status is COMPLETE.
Completeness status of the metric.
Number of hourly buckets in the rolling 720-hour window that are missing or incomplete. Zero when status is COMPLETE.
| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |