Skip to content
UDX
2026-07-15
2026-07-15Latest
Esc
↑↓navigate↵open⌘Jpreview

Get the Caller's Rate Limit Profile

Returns the authenticated member’s current rate limit profile. Every user, account, and API key owned by the member shares rate limits.

GET/rate_limit_profile
Authorization
Authorization
UDX-Access-KeyAPI key · headerrequired

Opaque API key ID.

UDX-Access-TimestampAPI key · headerrequired

Unix time in milliseconds, within 30 seconds of server time.

UDX-Access-SignatureAPI key · headerrequired

Standard-base64 RSA-PSS/SHA-256 signature with a 32-byte salt.

or
AuthorizationBearer token (JWT) · headerrequired

Bearer token for an active signed-in UDX user.

Header parameters
Header parameters
UDX-Versionstring

Dated API version (YYYY-MM-DD).

min length 10 · max length 10
Responses
200The caller's current member rate limit profile.
rate_limit_profileRateLimitProfilerequired

The caller's own current member rate limit profile.

Show properties
profile_keystringrequired

Stable machine-readable profile key.

min length 1 · max length 32 · matches ^[a-z][a-z0-9_]*$
profile_versioninteger<int64>required

Immutable profile version.

min 1 · max 1000000
bucketsRateLimitBucket[]required

The profile's read, write, and cancel bucket definitions.

min items 3 · max items 3
Show properties
Array of RateLimitBucket
bucketRateLimitBucketNamerequired

Closed rate bucket used by authenticated public REST operations.

Allowed:readwritecancel
refill_tokens_per_minuteinteger<int64>required

Tokens restored per minute.

min 1 · max 10000000
capacityinteger<int64>required

Maximum tokens retained by the bucket.

min 1 · max 10000000
unit_costinteger<int64>required

Default token cost for one operation assigned to this bucket.

min 1 · max 10000000
401No valid credential was provided.
typestring<uri-reference>required

A stable URN identifying the kind of problem, for example urn:udx:problem:insufficient-permissions. Branch on it rather than on the localized detail. It is an identifier, not a URL to dereference.

max length 2048
titlestringrequired

A localized, human-readable summary of the error category. Stable for a given status code and resolved language — clients must not use it as a machine-readable discriminator.

max length 40
statusintegerrequired

The HTTP status code, repeated from the response itself.

detailstring

A localized, human-readable explanation specific to this occurrence. Clients must not parse it for machine-readable information.

max length 500
instancestring<uri-reference>

An identifier for this specific occurrence, so it can be correlated with server-side logs if you need to report it.

max length 100
429The member rate limit was exceeded.
typestring<uri-reference>required

A stable URN identifying the kind of problem, for example urn:udx:problem:insufficient-permissions. Branch on it rather than on the localized detail. It is an identifier, not a URL to dereference.

max length 2048
titlestringrequired

A localized, human-readable summary of the error category. Stable for a given status code and resolved language — clients must not use it as a machine-readable discriminator.

max length 40
statusintegerrequired

The HTTP status code, repeated from the response itself.

detailstring

A localized, human-readable explanation specific to this occurrence. Clients must not parse it for machine-readable information.

max length 500
instancestring<uri-reference>

An identifier for this specific occurrence, so it can be correlated with server-side logs if you need to report it.

max length 100
500Something went wrong on UDX's side.
typestring<uri-reference>required

A stable URN identifying the kind of problem, for example urn:udx:problem:insufficient-permissions. Branch on it rather than on the localized detail. It is an identifier, not a URL to dereference.

max length 2048
titlestringrequired

A localized, human-readable summary of the error category. Stable for a given status code and resolved language — clients must not use it as a machine-readable discriminator.

max length 40
statusintegerrequired

The HTTP status code, repeated from the response itself.

detailstring

A localized, human-readable explanation specific to this occurrence. Clients must not parse it for machine-readable information.

max length 500
instancestring<uri-reference>

An identifier for this specific occurrence, so it can be correlated with server-side logs if you need to report it.

max length 100
503Request admission is unavailable.
typestring<uri-reference>required

A stable URN identifying the kind of problem, for example urn:udx:problem:insufficient-permissions. Branch on it rather than on the localized detail. It is an identifier, not a URL to dereference.

max length 2048
titlestringrequired

A localized, human-readable summary of the error category. Stable for a given status code and resolved language — clients must not use it as a machine-readable discriminator.

max length 40
statusintegerrequired

The HTTP status code, repeated from the response itself.

detailstring

A localized, human-readable explanation specific to this occurrence. Clients must not parse it for machine-readable information.

max length 500
instancestring<uri-reference>

An identifier for this specific occurrence, so it can be correlated with server-side logs if you need to report it.

max length 100
Request
curl -X GET "https://api.underdogexchange.com/rate_limit_profile" \
  -H "UDX-Access-Key: API_KEY_ID" \
  -H "UDX-Access-Timestamp: UNIX_MILLISECONDS" \
  -H "UDX-Access-Signature: BASE64_SIGNATURE"
Response
{
  "rate_limit_profile": {
    "profile_key": "tier_0",
    "profile_version": 1,
    "buckets": [
      {
        "bucket": "read",
        "refill_tokens_per_minute": 900,
        "capacity": 30,
        "unit_cost": 1
      },
      {
        "bucket": "write",
        "refill_tokens_per_minute": 450,
        "capacity": 15,
        "unit_cost": 1
      },
      {
        "bucket": "cancel",
        "refill_tokens_per_minute": 150,
        "capacity": 5,
        "unit_cost": 1
      }
    ]
  }
}