Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $inlinecount String Query-String Specifies that the response to the request should include a count of the number of entries in the collection
    $skip Integer Query-String The number of entries to skip from the beginning of the collection
    $top Integer Query-String The number of entries to return from the beginning of the collection
  • Response Parameters

    View Response Codes
    Name Type Description
    __count Number The total count of items in the feed.
    __next String The link for the next page of items in the feed.
    Data AccountGroupResponse [] The collection of entities for this feed.
    MaxRows Number The maximum number of rows that can be returned (if applicable).
  • Request Example

    Request URL
    GET /port/v1/accountgroups/me?$inlinecount=AllPages&$skip=1&$top=1
  • Response Example

    Response body
    {
      "Data": [
        {
          "AccountGroupKey": "stringValue",
          "AccountGroupName": "stringValue",
          "AccountValueProtectionLimit": 10,
          "ClientKey": "493b43a5-fe85-4d1f-9071-dd4a9d4e42a4",
          "CollateralMonitoringMode": "MaxOfCollateralCreditValueAndCollateralCreditLine",
          "MarginCalculationMethod": "Default",
          "MarginLendingEnabled": "No",
          "MarginMonitoringMode": "Equity",
          "PortfolioBasedMarginEnabled": true,
          "SupportsAccountValueProtectionLimit": false
        }
      ],
      "MaxRows": 99
    }