v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Query Participants

Get participant limits

Allows the Platform to query Customer limits, broken out by transaction type, time period and asset.

get/participant/{participant_code}/limits

Path parameters

participant_codestring required

Example:ABCDEF

Unique participant identifier. Always 6 uppercase alphanumeric characters.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required

Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved participant transaction limits including deposit, withdrawal, and trade limits by asset and time period

Example response

{
  "message": {
    "participant_code": "CUST01",
    "as_of": 1703001600,
    "limits": [
      {
        "type": [
          "trades"
        ],
        "period": 24,
        "balance": "7500",
        "limit": "3000",
        "configured_limit": "5000",
        "asset": "USD"
      }
    ],
    "tags": [
      "kyc_tier_1"
    ]
  }
}