ratelimit.v1.RateLimitService
GetTradingRateLimits
Get the effective placement and cancellation limits for the authenticated caller's root account or selected subaccount.
Request
curl --request POST \ \
--url 'https://api.testnet.polyester.com/ratelimit.v1.RateLimitService/GetTradingRateLimits' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"subaccountId": "6789012345678"
}'Responses
{
"apiKeyRules": [
{
"burstWeight": "1",
"periodMs": "1",
"policyClass": "TRADING_RATE_LIMIT_CLASS_PLACE",
"quotaWeight": "1",
"vipTier": 1
}
],
"effectiveFrom": "2025-01-01T00:00:00Z",
"policyVersion": "1",
"rules": [
{
"burstWeight": "1",
"periodMs": "1",
"policyClass": "TRADING_RATE_LIMIT_CLASS_PLACE",
"quotaWeight": "1",
"vipTier": 1
}
]
}ratelimit.v1.GetTradingRateLimitsRequestratelimit.v1.GetTradingRateLimitsResponseOptional public subaccount ID. When omitted, subaccount-scoped API keys use their bound subaccount; other callers use their authenticated root account.
Positive identifier of the rate-limit policy version used for the returned rules.
UTC time at which this policy version became effective.
Trading operation family governed by this rule. Public responses contain TRADING_RATE_LIMIT_CLASS_PLACE or TRADING_RATE_LIMIT_CLASS_CANCEL.
VIP tier for this rule, in the inclusive range 0 through 10.
Weighted request capacity available during each policy period. One operation consumes the weight assigned to that operation.
Policy period duration in milliseconds.
Maximum weighted capacity that may be consumed in a burst.
Trading operation family governed by this rule. Public responses contain TRADING_RATE_LIMIT_CLASS_PLACE or TRADING_RATE_LIMIT_CLASS_CANCEL.
VIP tier for this rule, in the inclusive range 0 through 10.
Weighted request capacity available during each policy period. One operation consumes the weight assigned to that operation.
Policy period duration in milliseconds.
Maximum weighted capacity that may be consumed in a burst.
| 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. |