Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Alpaca Events API

The Events API from Alpaca — 4 operation(s) for events.

Alpaca Events API is one of 23 APIs that Alpaca publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 4 operations across 4 paths, and defines 17 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://broker-api.sandbox.alpaca.markets, https://broker-api.alpaca.markets.

4 operations 4 paths 17 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.alpaca.markets/v2
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Alpaca Events API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Events 4
GET
/v1/events/accounts/status
Subscribe to account status events (SSE).
suscribeToAccountStatusSSE 4 params → 200
GET
/v1/events/journals/status
Subscribe to journal events (SSE).
subscribeToJournalStatusSSE 4 params → 200
GET
/v1/events/transfers/status
Subscribe to Transfer Events (SSE)
subscribeToTransferStatusSSE 4 params → 200
GET
/v1/events/trades
Subscribe to Trade Events (SSE)
subscribeToTradeSSE 4 params → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Order (33 properties), AccountStatusEvent (8 properties), TradeUpdateEvent (7 properties), JournalStatusEvent (6 properties). Each schema is shown below with its type and property counts.

JournalEntryType
string
This enum represents the various kinds of Journal alpaca supports. Current values are: - JNLC Journal Cash between accounts - JNLS Journal Securities between a…
TransferStatus
string
- QUEUED Transfer is in queue to be processed. - APPROVALPENDING Transfer is pending approval. - PENDING Transfer is pending processing. - SENTTOCLEARING Trans…
AccountStatusEvent
object
Represents a change in an Account's status, sent over the events streaming api. For partners who utilize Alpaca’s KYC service for opening brokerage accounts an…
8 properties 7 required
OrderType
string
TimeInForce
string
TradeUpdateEventType
string
Common events These are the events that are the expected results of actions you may have taken by sending API requests. The meaning of the timestamp field chan…
JournalStatus
string
Represents the status that a Journal instance can be in. Current Values: - pending - canceled - executed - queued - rejected - deleted
JournalStatusEvent
object
Represents a change in a Journal's status, sent over the events streaming api.
6 properties 6 required
Order
object
33 properties 2 required
AccountStatus
string
Designates the current status of this account Possible Values: - ONBOARDING An application is expected for this user, but has not been submitted yet. - SUBMITT…
TransferStatusEvent
object
Represents a change in a Transfer's status, sent over the events streaming api.
6 properties 6 required
TradeUpdateEvent
object
Represents an update to an order/trade, sent over the events streaming api.
7 properties 7 required
AssetClass
string
OrderStatus
string
OrderClass
string
OrderSide
string
Represents what side of the transaction an order was on.
KYCResult
object
Hold information about the result of KYC. Please see the documentation [here](https://alpaca.markets/docs/api-references/broker-api/events/kyc-results) for mor…
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alpaca-events-api-openapi.yml Raw ↑

Other APIs Alpaca publishes across the network.

Alpaca Trading API
Alpaca OAuth API
Alpaca Account Activities API
Alpaca Account Configurations API
Alpaca Accounts API
Alpaca Assets API
Alpaca Calendar API
Alpaca Clock API
Alpaca Corporate Actions API
Alpaca Crypto Pricing Data API API
Alpaca Documents API
Alpaca Funding API