Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AllocationKeyId String Route allocation key ID
  • Response Parameters

    View Response Codes
    Name Type Description
    AllocationKeyId String Allocation key ID.
    AllocationKeyName String Allocation key name.
    AllocationUnitType AllocationUnitType Specifies how to interpret the value of UnitValue in the AllocationKeyAccountInfo.
    AssetType AssetType The Instruments AssetType.
    BuySell BuySell The direction of the order buy or sell.
    CreationTime UtcDateTime Datetime of allocation group creation
    ErrorAccount String If any participant faces issue to book the allocated amount , then respective allocated amount will be booked against Error account instead of participant's account.
    ExternalReference String Optional reference from the client app. Maximum length: 50 characters
    MarginHandling MarginHandlingType Represents the behavior if because of margin reason entire order can not be processed.
    OwnerAccountKey AccountKey Allocation key owner account key.
    Participants Integer Number of Participant(s)
    ParticipatingAccountsInfo AllocationKeyAccountInfoView [] Allocation participants.
    Status AllocationKeyStatus Allocation key status.
    TotalUnitValues Number Sum of all participating accounts' UnitValues.
    Uic Integer Unique id of the instrument to place the allocation key for.
  • Request Example

    Request URL
    GET /trade/v1/allocationkeys/227
  • Response Example

    Response body
      "AllocationUnitType": "Percentage",
      "MarginHandling": "Reduce",
      "ParticipatingAccountsInfo": [
          "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
          "ClientKey": "",
          "Priority": 1,
          "UnitValue": 10,
          "AcceptRemainderAmount": true
          "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
          "ClientKey": "",
          "Priority": 1,
          "UnitValue": 90,
          "AcceptRemainderAmount": false
      "AllocationKeyId": "227",
      "AllocationKeyName": "MyAllocation_Key",
      "Status": "Active",
      "OwnerAccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
      "Participants": 0,
      "CreationTime": "0001-01-01T00:00:00Z",
      "TotalUnitValues": 0,
      "Uic": 4361,
      "AssetType": "CfdOnStock",
      "BuySell": "Buy",
      "ExternalReference": "Order123"