Subscribe to Journal Events (SSE) (Legacy)
The Events API provides event push as well as historical queries via SSE (server sent events).
You can listen to journal status updates as they get processed by our backoffice.
Historical events are streamed immediately if queried, and updates are pushed as events occur.
Query Params Rules:
- since_id and until_id are deprecated and available only to select broker partners; use since_ulid and until_ulid instead
- since required if until specified
- since_id required if until_id specified
- since_ulid required if until_ulid specified
- since, since_id or since_ulid can't be used at the same time Behavior:
- if since, since_id or since_ulid not specified this will not return any historic data
- if until, until_id or until_ulid reached stream will end (status 200)
There is no compatibility between /v1/events/journals/status and /v2/events/journals/status, the ids (ulid) are always different, and the number of events might also different
Please note that the new /v2 endpoint, is the same as, and was originally available under /v2beta1. We encourage all customers to adjust their codebase from that interim beta endpoint to the /v2 stable endpoint. In the near future we will setup permanent redirect from /v2beta1 to /v2 before we completely remove the beta endpoint.
Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a since and until there is a good chance the generated clients will hang waiting for the response to end.
If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correctly in OAS-3.
Request
- Base URLhttps://broker-api.giftcity.sandbox.in.alpaca.markets
- URLhttps://broker-api.giftcity.sandbox.in.alpaca.markets/v1/events/journals/status
- AuthHTTP basic
Query parameters
Format: YYYY-MM-DD
Format: YYYY-MM-DD
Deprecation notice: Use since_ulid instead.
Since: 2023-08-01 Sunset: 2027-02-15
Deprecation notice: Use until_ulid instead.
Since: 2023-08-01 Sunset: 2027-02-15
Response
Connected. Events will now start streaming as long as you keep the connection open.
Changes
No recorded changes to this operation across all 1 revision of this API.