Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountKey AccountKey Route Unique key of the account to share.
    AccountValueProtectionLimit Number Body If set, this value shields the account value from going below the given limit by automatically triggering closing of positions should the limit be exceeded. A limit of zero means there is no limit.
    BenchmarkInstrument AccountBenchmarkInstrument Body Sets the instrument to be used as comparison then evaluating account performance.
    DisplayName String Body The nickname the client would like to give the account.
    UseCashPositionsAsMarginCollateral Boolean Body Enable/disable the use of cash positions for margin trading collateral.
  • Response Parameters

    View Response Codes

    There are no response parameters

  • Request Example

    Request URL
    PATCH /port/v1/accounts/LZTc7DdejXODf-WSl2aCyQ==
    Request Body
      "DisplayName": "Trading Account"