Examples

Example request

curl --request POST \
  --url 'https://trade-uk.sandbox.zodiamarkets.com/api/3/user/limit' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'Rest-Key: <your_api_key>' \
  --header 'Rest-Sign: <generated_signature>' \
  --data '{"tonce":1770888183656000}'

200 response example

Response with Limits

{
  "limit": {
    "limitAmount": 1000,
    "exposureAmount": 1000,
    "isNetSettlementMode": true,
    "limitCurrency": "USD",
    "exposureCurrency": "USD",
    "limitUtilisationPercentage": 100
  },
  "timestamp": "1656987491835",
  "resultCode": "OK"
}

Response Without Limitis

{
  "timestamp": "1656987491835",
  "resultCode": "OK"
}

400 response example

{
  "resultCode": "INVALID_NONCE_OR_TONCE",
  "timestamp": "1666520496583"
}

401 response example

{
  "timestamp": "1666418418989",
  "resultCode": "UNAUTHORISED"
}

403 response example

{
  "timestamp": "1666418418989",
  "resultCode": "UNAUTHORISED"
}

404 response example

{
  "apiVersion": "1.0.0",
  "error": "SYSTEM_ERROR",
  "timestamp": 1666587269
}

500 response example

{
  "resultCode": "SYSTEM_ERROR",
  "timestamp": "1666580244296"
}

Get Trading Limit

Get the trading limit for your account.

Domain: Accounts

Request

POST https://trade-uk.sandbox.zodiamarkets.com/api/3/user/limit

Headers

Header	Required	Description
`Rest-Key`	yes	API key for authentication
`Rest-Sign`	yes	Calculated API Signature

Body

Field	Type	Required	Description
`tonce`	integer (int64)	yes	The current Unix time in microseconds.

Responses

200

Response with Limits

Field	Type	Description
`limit`	object	Limit block
`limit.limitAmount`	integer	Current Limit amount assigned — Default: “2000000”
`limit.exposureAmount`	integer	Current Exposure (used amount) — Default: 0
`limit.isNetSettlementMode`	boolean	Is the remaining limit calculated on net or gross settlement bases — Default: true
`limit.limitCurrency`	string	Default USD — Default: “USD”
`limit.exposureCurrency`	string	Default USD — Default: “USD”
`limit.limitUtilisationPercentage`	integer	Utilization of current limit in percentage terms — Default: 0
`timestamp`	string
`resultCode`	string

Response Without Limitis

Field	Type	Required	Description
`limit`	object
`timestamp`	string
`resultCode`	string

400

Field	Type	Required	Description
`resultCode`	string
`timestamp`	string

401

Field	Type	Required	Description
`timestamp`	string
`resultCode`	string

403

Field	Type	Required	Description
`timestamp`	string
`resultCode`	string

404

Field	Type	Description
`apiVersion`	string
`error`	string
`timestamp`	integer	Default: 0

500

Field	Type	Required	Description
`resultCode`	string
`timestamp`	string