Account Caps

Retrieve account cap values for leverage, position value, or order value

GET /v1/accounts/cap

Account Caps

cURL

curl --request GET \
  --url https://api.roxom.com/v1/accounts/cap \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Signature: <api-key>'

200

{
  "data": {
    "value": "<string>"
  },
  "error": true
}

Authorizations

X-API-Key · string · header · required

Your API key

X-API-Signature · string · header · required

The signature of the request

Query Parameters

capType · enum<string> · required

Available options: leverage, positionValue, orderValue

symbol · string · required

Response

200 - application/json

Represents a successful API response wrapper

data · object · required

Show child attributes

error · boolean · required