OpenAPI
Open API Learn Tutorial Reference Docs Explorer Apps Updates Get 24 Hour Token Sign in
Other Products FIX Trading API Client Management Systems API End-of-Day File Transfers Trade Event Notification System OpenAPI for Excel

Margin Call Events

Message to indicate some event related to client margin.

Additional Fields

NameTypeDescriptionAvailable

AccountGroupKey

String

Refers to the group of accounts.

When MarginEntityType = AccountGroup.

AccountGroupName

String

Name of the account group.

When MarginEntityType = AccountGroup.

MarginBreachCallLevel

Decimal

The defined level of breach for this account.

Always.

MarginCallAction

MarginCallAction

  • MarginCall: The client is requested to restore the necessary margin required.
  • StopOut: The client has been forcefully stopped out to restore the necessary margin required.
  • LevelDrop: Margin level dropped; the client has restored the necessary margin level required, according to the margin call profile defined. This margin call action will appear if the client margin level dropped under the defined margin levels percentage as set in the margin call profile.

    This is normally not communicated to the client.

  • Reinstate: The system has restored the necessary margin required.

Always.

MarginCallActionSubType

String

Specifies the sub-type of the margin call. Currently the following values are defined:

  • MarginLendingStopOut
  • MarginStopOut
  • OptionsCloseOut

Always.

MarginCallActionTypeString

The value returned in MarginCallActionType matches the "Action Type" set for a particular margin call definition at Saxo.

Most common values:

  • ActionClientEMail: Customer is notified via email.
  • ActionCSPopUp
  • ActionStopOut: When MarginCallAction = StopOut.

Always.

MarginCallLevelDecimal

The margin percentage level, which was breached.

NOTE: The clients actual margin at the time of receiving this message may deviate slightly from the threshold level.

If the MarginCallAction is "LevelDrop", there are two situations where the value of MarginLevel may be 0 (or null).

  • Scenario 1: If the margin level has dropped under the last percentage defined in the margin call profile, then the margin call level will be equal to 0, in this case the MarginCallLevel field will not be included in the Margin Call notification. 
  • Scenario 2: In case of account funding where the account balance was negative, margin call level call level will be equal to 0, in this case the MarginCallLevel field will not be included in the Margin Call notification.
Always.
MarginEntityTypeString

Defines at which level margin call happened. Following are the possible values:

  • Account
  • AccountGroup
  • ClientLevel
Always.
TimeOnMarginTimeSpanSpecifies time by which client has been on Margin. Format is "hh:mm:ss". Example: "216:00:00".Always.


Sample Message

An example of a margin call event message:

{
  "ReferenceId": "C_542",
  "Timestamp": "2022-10-24T18:20:18.103333Z",
  "Data": [
    {
      "AccountGroupKey": "789==",
      "AccountGroupName": "Binck SBM Derivatives",
      "AccountId": "123USD",
      "AccountKey": "123=",
      "ActivityTime": "2022-10-24T18:20:18.103333Z",
      "ActivityType": "MarginCalls",
      "ClientId": "456",
      "ClientKey": "456==",
      "MarginBreachCallLevel": 90.0,
      "MarginCallAction": "MarginCall",
      "MarginCallActionSubType": "MarginStopOut",
      "MarginCallActionType": "ActionClientEMail",
      "MarginCallLevel": 90.0,
      "MarginEntityType": "AccountGroup",
      "SequenceId": "1056028156",
      "TimeOnMargin": "00:00:00"
    }
  ]
}

Comments about Margin Calls

The levels at which margin calls and stop outs are triggered are defined in a margin profile, which is configured by Saxo's staff. The margin call profile may also specify that a client should be reminded at regular intervals, if the margin level remains above a certain threshold for a prolonged period of time.