mcpField
A
alpaca-broker-market-data

alpaca-broker-market-data

github.com/alpacahqData & databases157135 installsUpdated 1w ago
Repository

About alpaca-broker-market-data

A reference skill for developers integrating Alpaca's US stock market data APIs. It covers REST queries, WebSocket streaming, authentication, feed entitlements, pagination, and caching considerations.

Key features

  1. 01Stock snapshots, bars, trades, and quotes
  2. 02REST API hosts and authentication guidance
  3. 03WebSocket subscription and message handling
  4. 04Feed entitlement and pagination details
  5. 05Assets, market clock, and calendar endpoints
  6. 06Caching and rate-limit practices

Use cases

  1. 01Retrieve historical or current US equity data
  2. 02Consume live trades, quotes, and bars
  3. 03Plan pagination and caching for data workloads
  4. 04Check tradability and market session schedules

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/alpacahq/alpaca-skills --skill alpaca-broker-market-data

After installing, type/alpaca-broker-market-datain Claude Code to confirm it loaded.

Bundled filesreference.md

Details

From the project README

Alpaca Market Data API — Stocks (REST + WebSocket)

Real-time and historical US equity data. Unlike the Broker endpoints, market data lives on its own host with its own auth, and the real-time feed is WebSocket, not SSE.

Read alpaca-broker-integration first. Assets/clock/calendar live on the Trading API host; everything else here is the Market Data API host.

Reference

  • Guides: https://docs.alpaca.markets/docs/historical-stock-data, https://docs.alpaca.markets/docs/streaming-market-data
  • Live schema: alpaca-docs MCP → list-endpoints title "Market Data API"

0. Hosts & auth

SurfaceHost
Market data RESThttps://data.alpaca.markets (sandbox data.sandbox.alpaca.markets)
Market data WebSocketwss://stream.data.alpaca.markets/{version}/{feed}
Assets / clock / calendarhttps://api.alpaca.markets (Trading API) — paper: paper-api.alpaca.markets

Auth: Broker partners authenticate with a client-credentials access token (POST https://authx.alpaca.markets/v1/oauth2/token — flow in alpaca-broker-integration): send Authorization: Bearer <token> on REST and on the WS handshake, or authenticate over WS with {"action":"auth","key":"access_token","secret":"<token>"} (the literal string access_token is the key). Tokens are valid 15 minutes — cache and refresh one, don't mint per call. Key/secret (APCA-API-* headers, or {"action":"auth","key":"…","secret":"…"} on WS) is the Trading API path and the documented legacy Broker path.

1. REST endpoints

PathPurpose
GET /v2/stocks/snapshots?symbols=… · GET /v2/stocks/{symbol}/snapshotSnapshot (latest trade/quote + bars)
GET /v2/stocks/bars?symbols=… · GET /v2/stocks/{symbol}/barsHistorical OHLCV bars
GET /v2/stocks/bars/latest · …/{symbol}/bars/latestLatest bar(s)
GET /v2/stocks/trades[/latest] · GET /v2/stocks/quotes[/latest]Historical / latest trades & quotes
GET /v2/stocks/auctionsOpening/closing auctions
GET /v2/stocks/meta/conditions/{trade|quote} · /meta/exchangesCode lookups
GET /v1beta1/news?symbols=…News (max limit 50)
GET /v1beta1/screener/stocks/most-actives · /screener/{stocks|crypto}/moversScreeners
GET /v2/assets (Trading API host) · GET /v1/assets (Broker API host)Asset master / tradability
GET /v2/clock · GET /v2/calendar (Trading API host)Market hours

Clock/calendar/assets paths are host-dependent — verified live against the sandbox:

PathTrading API host (api.alpaca.markets)Broker API host (broker-api.*)
/v1/clock—200
/v2/clock200200
/v1/calendar—200
/v2/calendar200404
/v1/assets—200
/v2/assets200404

So: on the Trading/Market-Data API host use /v2/clock, /v2/calendar, /v2/assets. On the Broker API host use /v1/clock, /v1/calendar, /v1/assets (/v1/clock and /v2/clock both work there; /v2/calendar and /v2/assets 404). A Broker-API integration hitting /v1/clock is correct, not stale.

2. Bars — params

ParamNotes
timeframe[1-59]Min/T, [1-23]Hour/H, 1Day/D, 1Week/W, [1,2,3,4,6,12]Month/M. Case-sensitive. e.g. 1Min, 5Min, 1Hour, 1Day
start / endRFC3339 or YYYY-MM-DD, inclusive
limitdefault 1000, max 10000 — counts data points across all symbols, not per symbol
page_tokenpagination cursor (from next_page_token)
adjustmentraw (default), split, dividend, spin-off, all — comma-combinable
feedsee §3
sortasc (default) / desc
asofYYYY-MM-DD for symbol/name-change mapping; - skips mapping

Pagination lesson: results are sorted by symbol, then timestamp. A multi-symbol request that hits limit may return only the first symbol(s) — you must follow next_page_token until empty to get them all. Don't assume one page = all symbols.

3. Feeds (entitlement matters)

  • iex — single exchange (~2.5% of volume). The only feed available without a paid subscription. Good for dev/testing.
  • sip — consolidated, all exchanges (100% volume). Requires a paid data plan.
  • delayed_sip — SIP delayed 15 min (latest/snapshot endpoints).
  • otc, boats (Blue Ocean overnight ATS), overnight (Alpaca-derived, cheaper).

Lessons:

  • Don't hard-pin feed=iex — latest/snapshot endpoints default to the best feed your subscription entitles you to, and historical endpoints default to sip but default end to 15 minutes ago when you lack real-time access, so historical SIP is queryable unsubscribed as long as end is at least 15 minutes old. A 403 ({"code":42210000,"message":"subscription does not permit querying recent SIP data"}) comes from explicitly asking for feed=sip on data you aren't entitled to.
  • Without real-time access, start/end windows withhold the most recent 15 minutes.
  • Trade/quote sizes are in shares as of 2025-11-03 (were round lots before).

4. Object shapes (compact keys)

Snapshot per symbol: latestTrade, latestQuote, minuteBar, dailyBar, prevDailyBar. Multi-symbol response is a map { "AAPL": {…} }.

  • Bar: t time, o open, h high, l low, c close, v volume, n trade count, vw VWAP.
  • Trade: t time, p price, s size, x exchange, c conditions, z tape, i id.
  • Quote: bp/bs/bx bid price/size/exchange, ap/as/ax ask price/size/exchange, c conditions, z tape. (price 0 = no active bid/ask.)

5. WebSocket protocol

URL: wss://stream.data.alpaca.markets/{version}/{feed} — e.g. v2/iex, v2/sip, v2/delayed_sip, v1beta1/boats, v1beta1/overnight, or v2/test (always-on, use symbol FAKEPACA).

Connect flow:

  1. Connect → [{"T":"success","msg":"connected"}]
  2. Auth within 10s: {"action":"auth","key":"…","secret":"…"} → [{"T":"success","msg":"authenticated"}]
  3. Subscribe: {"action":"subscribe","trades":["AAPL"],"quotes":["AMD"],"bars":["*"]} → server echoes full subscription state. * = all symbols. unsubscribe removes.

Message types (every message is a JSON array; T discriminates): t trade, q quote, b minute bar, d daily bar, u updated bar, s trading status (halt/resume), l LULD, c correction, x cancel/error, i imbalance; control: success, error, subscription. Subscribing to trades auto-adds corrections + cancelErrors.

WebSocket lessons:

  • Connection limits are per correspondent, shared by every process you run — Broker plans allow 5 concurrent streams (Standard, StandardPlus3000, StandardPlus5000) or 10 (StandardPlus10000). Exceeding it → [{"T":"error","code":406,"msg":"connection limit exceeded"}]. Centralize the stream in one process and fan out to your own clients (don't open a socket per user).
  • Authenticate within 10s or get dropped (404).
  • Other error codes: 401 not auth'd, 402 auth failed, 405 symbol limit, 407 slow client, 409 insufficient subscription (feed not entitled), 410 invalid action for feed.
  • Messages are batched — always iterate the array; don't assume one frame = one event.
  • Handle u (updated bar) and c/x (corrections/cancels): a streamed bar/trade can be revised after the fact.

6. Assets, clock, calendar

Use the host-appropriate path (see the table in §1): /v2/... on the Trading API host, /v1/... on the Broker API host.

  • Assets (GET /v2/assets on Trading host · GET /v1/assets and /v1/assets/{symbol} on Broker host) — tradability metadata: tradable, fractionable, marginable, shortable, borrow_status (replaces deprecated easy_to_borrow), status (active/inactive), class (us_equity/us_option/crypto/ipo), exchange, attributes[] (e.g. has_options, overnight_tradable). Filter Broker /v1/assets by status, asset_class, attributes — there is no exchange filter there; Trading /v2/assets adds exchange. Cache this — it changes slowly; query it before trading to confirm tradable/fractionable (see alpaca-broker-trading-orders).
  • Clock (/v2/clock on Trading host · /v1/clock on Broker host) — is_open, next_open, next_close, timestamp. Use this to gate market-hours logic instead of hardcoding 9:30–16:00 ET.
  • Calendar (/v2/calendar on Trading host · /v1/calendar on Broker host — note there is no /v2/calendar on the Broker host) — per-day open/close (HH:MM), session_open/session_close (HHMM, extended hours), settlement_date. Use the calendar for holidays — a naive "weekdays only" check runs jobs on market holidays (harmless but wasteful) and miscomputes "previous trading day."

7. Caching strategy (cost & rate-limit lesson)

Market data is the highest-volume, highest-cost surface. Production lesson:

  1. Persist historical bars in your own store keyed by (symbol, timeframe, timestamp) with upsert/skip-duplicate, and serve charts from there — only fetch the gap from Alpaca.
  2. Cache snapshots/quotes in a short-TTL cache (TTL tuned to market-open vs closed).
  3. Run one bulk backfill job for searchable symbols on a schedule rather than fetching per user request.
  4. Always follow next_page_token and watch X-RateLimit-Remaining (see alpaca-broker-rate-limits-resilience).

Related skills: tradability before ordering → alpaca-broker-trading-orders; rate limits/pagination → alpaca-broker-rate-limits-resilience; the broker event stream (SSE, different from this WS) → alpaca-broker-sse-events.

Comments

Markdown supported