Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AllocationKeyName String Body Name of the allocation key.
    AllocationUnitType AllocationUnitType Body Specifies how to interpret the value of UnitValue in the AllocationKeyAccountInfo.
    MarginHandling MarginHandlingType Body Represents the behavior if because of margin reason entire order can not be processed.
    OneTime Boolean Body Whether the key is for one time use.
    OwnerAccountKey AccountKey Body Account key for the account to this allocation key belongs to.
    ParticipatingAccountsInfo AllocationKeyAccountInfo [] Body Allocation participants.
  • Response Parameters

    View Response Codes
    Name Type Description
    AllocationKeyId String Newly created allocation key ID.
  • Request Example

    Request URL
    POST /trade/v1/allocationkeys
    Request Body
      "AllocationKeyName": "MyAllocation_Key",
      "OneTime": true,
      "OwnerAccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
      "AllocationUnitType": "Percentage",
      "MarginHandling": "Reduce",
      "ParticipatingAccountsInfo": [
          "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
          "Priority": 1,
          "UnitValue": 10,
          "AcceptRemainderAmount": true
          "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
          "Priority": 1,
          "UnitValue": 90,
          "AcceptRemainderAmount": false
  • Response Example

    Response body
      "AllocationKeyId": "227"