Get distributed amount for a given allocation key

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  AllocationKeyId	String	Route	Allocation key id
  AssetType	AssetType	Query-String	Asset type. Optional, must be used in conjunction with name="uic"
  OrderAmountType	OrderAmountType	Query-String	Indicates if the total amount is specified as lots/shares/contracts or as a monetary purchase amount.
  Totalamount	Number	Query-String	Total amount to distribute between accounts associated with the allocationKey
  Uic	Integer	Query-String	Unique instrument identification. Optional, must be used in conjunction with "assetType"

• Response Parameters

  View Response Codes

  Name	Type	Description
  Remainder	Number	Remaining amount not possible to distribute between accounts.
  SubClientsInfo	SubClientInfo []	Collection of amount distributions.

  HTTP Code	Description
  200	OK	Indicates the information was retrieved successfully.
  400	Bad Request	Error Code Description DomainValidationError Domain Validation Failed!
  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/distributions/227?AssetType=FxSpot&OrderAmountType=Quantity&Totalamount=22&Uic={Uic}

• Response Example

  Response body

  {
    "SubClientsInfo": [
      {
        "AccountId": "324b0298-8ec2-4c13-9518-ee4f01244113",
        "Amount": 10.3,
        "MultiLegAmount": 0
      },
      {
        "AccountId": "324b0298-8ec2-4c13-9518-ee4f01244114",
        "Amount": 20.3,
        "MultiLegAmount": 0
      },
      {
        "AccountId": "324b0298-8ec2-4c13-9518-ee4f01244115",
        "Amount": 70.3,
        "MultiLegAmount": 0
      }
    ],
    "Remainder": 0.1
  }