climits

Returns Counterparty limits snapshot

POST api/climits

Payload

{}

200 OK

[
  {
    "counterpartyId": 5,
    "tradingPermissions": {
      "ownTradingEnabled": true,
      "mutualTradingEnabled": false
    },
    "ownLimit": {
      "grossLimit": 1000000000,
      "asset": "BTC",
      "limitUtilization": 5000000,
      "equity": 300000,
      "maintenanceMargin": 1000,
      "restrictedTrading": 2000,
      "initialMargin": 3000
    },
    "mutualLimit": {
      "grossLimit": 500000000000,
      "asset": "USD",
      "limitUtilization": 1000000000,
      "equity": -300000,
    }
  },
  {
    "counterpartyId": 10,
    "tradingPermissions": {
      "ownTradingEnabled": true,
      "mutualTradingEnabled": true,
      "ownIncomingFlowEnabled": true,
      "ownOutgoingFlowEnabled": false,
      "mutualIncomingFlowEnabled": true,
      "mutualOutgoingFlowEnabled": true
    },
    "ownLimit": {
      "grossLimit": 500000000000,
      "asset": "USD",
      "limitUtilization": 0,
      "equity": 0
    }
  }
]

400 Bad request

{
    "error": 2
}

Response description

Field name	Type	Description
	Array of CLimits	Array of counterparty limits
CLimit	Dict
counterpartyId	Efx::ClientId	Counteraparty Id
tradingPermissions	TradingPermissions	Own and mitual trading permissions.
ownLimit	LimitData	Optional. Own limit data, present only if the own gross limit exists.
mutualLimit	LimitData	Optional. Mutual limit data, present only if the counterparty set the gross limit.
LimitData	Dict
grossLimit	Efx::Size	Gross limit value.
asset	string	Gross limit currency name.
limitUtilization	Efx::Size	Maintenance margin. In % multiplied by 1e4.
equity	Efx::Size	Equity.
maintenanceMargin	int32	Optional. Maintenance margin. In % multiplied by 1e4.
restrictedTrading	int32	Optional. Restricted trading level. In % multiplied by 1e4.
initialMargin	int32	Optional. Initial margin. In % multiplied by 1e4.
TradingPermissions	Dict
ownTradingEnabled	bool	True if trading enabled by client.
mutualTradingEnabled	bool	True if trading enabled by counterparty.
ownIncomingFlowEnabled	bool	Optional. Field is present only for master-master connection. True if incoming flow from counterparty master is enabled by master client.
ownOutgoingFlowEnabled	bool	Optional. Field is present only for master-master connection. True if outgoing flow to counterparty master is enabled by master client.
mutualIncomingFlowEnabled	bool	Optional. Field is present only for master-master connection. True if counterparty master enabled incoming flow from the master client.
mutualOutgoingFlowEnabled	bool	Optional. Field is present only for master-master connection. True if counterparty master enabled outgoing flow to the master client.