Get stop outs stream

About

Returns stopout events stream. If there are no new events yet, the response will not be sent until a timeout expires or new event arrives. It is recommended to invoke this API in an infinite cycle constantly polling for new events to receive events in real time

GET /users/current/stopouts/stream

For more information see Swagger documentation

Headers

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

Query parameters

Name	Type	Required	Description
previousSequenceNumber	integer		value of the last consumed sequence number to start streaming from
subscriberId	string		id of the CopyFactory subscriber
strategyId	string		id of the strategy
limit	integer		pagination limit, default: 1000, min: 1, max: 1000

Response

Responses:

• 200 - Stopout events returned successfully. Response schema: Array<AccountStrategyStopOut>
• 401 - Authorization failed. Response schema: Error

Examples

Example request:

curl -X GET --header 'Accept: application/json' --header 'auth-token: token' 'https://copyfactory-api-v1.new-york.agiliumtrade.ai/users/current/stopouts/stream'

Example response:

[
  {
    "strategy": {
      "id": "GtyH",
      "name": "Demo strategy"
    },
    "partial": true,
    "reason": "day-balance-difference",
    "reasonDescription": "daily realized loss exceeded maximum allowed value",
    "stoppedAt": "2020-08-24T00:00:00.000Z",
    "stoppedTill": "2020-08-24T10:00:00.000Z"
  }
]