alpaca-broker-integration
Entry point for integrating with the Alpaca Broker API (plus Market Data and Trading APIs) in any programming language. Use when a developer wants to build on Alpaca — open brokerage accounts, run KYC, fund accounts, move money via journals, place orders, consume real-time event streams, or pull market data — and need to know base URLs, auth, conventions, or which focused sub-skill to use.
alpacahq · AI review on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add alpacahq/alpaca-skills --skill alpaca-broker-integrationAbout this skill
name: alpaca-broker-integration description: Entry point for integrating with the Alpaca Broker API (plus Market Data and Trading APIs) in any programming language. Use when a developer wants to build on Alpaca — open brokerage accounts, run KYC, fund accounts, move money via journals, place orders, consume real-time event streams, or pull market data — and need to know base URLs, auth, conventions, or which focused sub-skill to use.
Alpaca Integration Assistant
You are an expert on the Alpaca APIs. Help developers integrate with Alpaca in any programming language. Generate working code, explain protocols, and debug integration issues.
This is the router / overview skill. It covers the things that are true across all of Alpaca's APIs — the API families, base URLs, auth, consumption styles, and wire conventions — and points you to a focused sub-skill for each domain. Read this first, then jump to the specific skill for the task.
Most of the hard-won value in these skills is in the lessons-learned sub-skills (reconciliation, rate limits, money precision, SSE reliability). Alpaca's reference docs tell you what the endpoints are; these skills tell you what breaks in production and why.
Reference Documentation
- Docs home:
https://docs.alpaca.markets/ - API reference:
https://docs.alpaca.markets/reference/ - Machine-readable index:
https://docs.alpaca.markets/llms.txtandhttps://docs.alpaca.markets/llms-full.txt - OpenAPI specs (4): Authentication API, Broker API, Market Data API, Trading API
Live schema lookups: if the alpaca-docs MCP server is connected, prefer it over guessing — list-specs, list-endpoints, get-endpoint (exact request/response schemas + servers), and search / fetch (guide pages). Always confirm an exact payload against the spec before generating code that posts money or orders.
1. The four API families
| Family | What it's for | Who uses it |
|---|---|---|
| Broker API | Open & manage brokerage accounts on behalf of your end users (KYC, funding, journals, trading-for-accounts, documents, events). You are the broker-of-record's tech partner; you custody many sub-accounts under your firm. | Apps that onboard their own users and hold their assets (neobrokers, fintechs). |
| Trading API | Trade a single account that belongs to the API-key holder. | Individual algo traders, bots. |
| Market Data API | Real-time + historical prices, bars, quotes, trades, news, corporate actions, screener. REST and WebSocket. | Everyone. |
| Authentication API | OAuth 2.0 flows for letting third parties act on an Alpaca account. | OAuth integrations. |
Decide first which family you're on — it changes the base URL, the auth, and the URL shape of every call. The most common confusion: Broker API places orders at /v1/trading/accounts/{account_id}/orders (the account is in the path because you act for a user), whereas the standalone Trading API places orders at /v2/orders (implicitly your own account).
These skills focus primarily on the Broker API, because that's where the lifecycle is hardest: onboarding, funding rails, journals, and event reconciliation.
2. Base URLs
| Family | Production | Sandbox / Paper |
|---|---|---|
| Broker API | https://broker-api.alpaca.markets | https://broker-api.sandbox.alpaca.markets |
| Trading API | https://api.alpaca.markets | https://paper-api.alpaca.markets (paper) |
| Market Data (REST) | https://data.alpaca.markets | (same host; sandbox data is limited) |
| Market Data (WebSocket) | wss://stream.data.alpaca.markets | wss://stream.data.sandbox.alpaca.markets |
Always start in sandbox. Switch by environment variable, never by code path — a single ENV flag that selects the base URL is the pattern that survives. Sandbox accounts can be funded with fake money and auto-approved, so you can exercise the full lifecycle without real KYC or cash.
3. Authentication
Auth differs by API family — this trips people up constantly.
Broker API → HTTP Basic
Authorization: Basic base64("<API_KEY_ID>:<API_SECRET_KEY>")
The same Basic credential authenticates Broker REST, Broker SSE event streams, and trading-on-behalf-of-accounts. Build the base64 token once at startup; don't recompute per request.
Market Data API → key/secret headers (or Basic in broker context)
APCA-API-KEY-ID: <API_KEY_ID>
APCA-API-SECRET-KEY: <API_SECRET_KEY>
For the WebSocket data stream, you don't use headers — you send an auth message after connecting:
{"action": "auth", "key": "<API_KEY_ID>", "secret": "<API_SECRET_KEY>"}
Broker API partners can usually authenticate market-data calls with their Broker Basic credentials too. Pick one scheme per data client and be consistent; mixing them is a frequent source of 401s.
Trading API → key/secret headers
Same APCA-API-* headers as market data.
Authentication API → OAuth 2.0 Bearer
For OAuth integrations, exchange the code for a token and send Authorization: Bearer <token>.
4. Three consumption styles
Alpaca gives you three transports. Use the right one for the job — and know that they have different auth and different reliability characteristics.
| Style | Transport | Use for | Skill |
|---|---|---|---|
| REST | HTTPS request/response | Everything transactional: create account, fund, journal, place order, query state. | the domain skills |
| SSE | text/event-stream over a long-lived HTTPS GET | Broker lifecycle events: account status, journals, transfers, trades, non-trade activities. Replayable via cursors. | alpaca-broker-sse-events |
| WebSocket | wss:// | Real-time market data (trades/quotes/bars). | alpaca-broker-market-data |
Key distinction: Broker events come over SSE
Read the complete source ↗