RateLimitService
Get Rate Limit Config
Get the complete active placement and cancellation quota catalog for VIP0 through VIP10.
Method
GET
Path
/v1/rate-limits
Visibility
Public endpoint
GET
/v1/rate-limits Request
Testnet
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/rate-limits' \ --header 'Accept: */*'
Responses
{
"effectiveFrom": "2025-01-01T00:00:00Z",
"policyVersion": "1",
"rules": [
{
"burstWeight": "1",
"periodMs": "1",
"policyClass": "PLACE",
"quotaWeight": "1",
"vipTier": 1
}
]
} effectiveFrom string (date-time)
UTC time at which this policy version became effective.
Example
2025-01-01T00:00:00Z policyVersion string
Positive identifier of the returned rate-limit policy version.
Example
1 5 fields
burstWeight string
Maximum weighted capacity that may be consumed in a burst.
Example
1 periodMs string
Policy period duration in milliseconds.
Example
1 policyClass enum
Trading operation family governed by this rule. REST responses contain PLACE or CANCEL.
PLACE CANCEL
Example
PLACE quotaWeight string
Weighted request capacity available during each policy period. One operation consumes the weight assigned to that operation.
Example
1 vipTier integer (int32)
VIP tier for this rule, in the inclusive range 0 through 10.
Example
1| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |