ratelimit.v1.RateLimitService

GetRateLimitConfig

Get the complete active placement and cancellation quota catalog for VIP0 through VIP10. This public, caller-independent catalog supports cacheable ConnectRPC GET.

Method

POST

Path

ratelimit.v1.RateLimitService/GetRateLimitConfig

Service

ratelimit.v1.RateLimitService

Visibility

Public endpoint

POST

ratelimit.v1.RateLimitService/GetRateLimitConfig

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/ratelimit.v1.RateLimitService/GetRateLimitConfig' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{}'

Responses

{
  "effectiveFrom": "2025-01-01T00:00:00Z",
  "policyVersion": "1",
  "rules": [
    {
      "burstWeight": "1",
      "periodMs": "1",
      "policyClass": "TRADING_RATE_LIMIT_CLASS_PLACE",
      "quotaWeight": "1",
      "vipTier": 1
    }
  ]
}

Request

ratelimit.v1.GetRateLimitConfigRequest

Response

ratelimit.v1.GetRateLimitConfigResponse

policyVersion string (uint64) > 0

Positive identifier of the returned rate-limit policy version.

effectiveFrom string (date-time)

UTC time at which this policy version became effective.

5 fields

Possible errors: 5

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.