Get detailed information about an allocation key

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
  IsValid	Boolean	The allocation key becomes invalid if any of the participating accounts are deactivated or if the owner loses access to any of the participating accounts.
  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.

  HTTP Code	Description
  200	OK	OK
  400	Bad Request	Error Code Description InvalidRequest Default error code returned when it cannot be determined which part of the request is malformed.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  404	Not Found	Error Code Description AllocationKeyNotFound Requested allocation key is not found.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  GET /trade/v1/allocationkeys/227

• Response Example

  Response body

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