Skip to content

Get stop outs#

About#

Returns subscriber account stop outs

GET /users/current/accounts/:accountId/stopouts

For more information see Swagger documentation

Headers#

Name Type Required Description
auth-token string Yes authorization token. See Authentication & authorization

Path parameters#

Name Type Required Description
accountId string Yes account id

Response#

Responses:

  • 200 - Account stop outs returned successfully. Response schema: Array<AccountStrategyStopOut>
  • 401 - Authorization failed. Response schema: Error
  • 403 - User is not an account owner. Response schema: Error

Examples#

Example request:

curl -X GET --header 'Accept: application/json' --header 'auth-token: token' 'https://trading-api-v1.agiliumtrade.agiliumtrade.ai/users/current/accounts/865d3a4d-3803-486d-bdf3-a85679d9fad2/stopouts'

Example response:

[
  {
    "strategy": {
      "id": "string",
      "name": "string"
    },
    "partial": true,
    "reason": "yearly-balance",
    "reasonDescription": "string",
    "stoppedAt": "string",
    "stoppedTill": "string"
  }
]