Interactive subscriptions
WebSocket
Client Server
Send subscriptions →← Receive updates
Choose it when your client sends subscription messages over the same connection.
Streaming market data
Keep your
interface moving.
Receive market updates over WebSocket or Server-Sent Events. Choose the transport that fits your application.
Preview: neutral streaming URLs and example connections are pending validation. Samples below are integration drafts, not a live demo.
01 / Choose your connection
Two transports. One starting point.
Both begin with a streaming JWT. Access, token lifetime and connection limits depend on the plan.
One-way updates
Server-Sent Events
Client Server
← Receive an HTTP event stream
Choose it for server-to-client updates using straightforward HTTP tooling.
02 / Generate a credential
Keep the API key
on your server.
Set up the API base and key in the quickstart, then mint a streaming token. Check the response’s success status, token and expiration before connecting.
POST /api/token/generate
curl --fail-with-body "$NAVQUOTE_API_BASE/api/token/generate" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
--data '{}'Use the returned wsUrl / sseUrl only after confirming the neutral-address contract.
03 / Subscribe and inspect
Wait for actual market data.
These examples show the connection shape. Add expiration handling and recovery for your application.
WEBSOCKET · JAVASCRIPT
// Proposed endpoint. Use a short-lived streaming JWT.
const url = new URL("wss://stream.navquote.com/ws");
url.searchParams.set("token", "YOUR_STREAM_TOKEN");
const socket = new WebSocket(url);
socket.addEventListener("open", () => {
socket.send(JSON.stringify({
action: "subscribe_quote",
symbols: ["NASDAQ:AAPL"],
fields: "all"
}));
});
socket.addEventListener("message", event => {
const message = JSON.parse(event.data);
console.log(message);
// A subscription acknowledgement is not a data update.
});Browser WebSocket API · short-lived token only.
SERVER-SENT EVENTS · CURL
# Proposed endpoint. STREAM_TOKEN is a generated JWT.
curl --no-buffer --get "https://stream.navquote.com/sse/stream" \
--data-urlencode "token=$STREAM_TOKEN" \
--data-urlencode "symbols=NASDAQ:AAPL"Keep credential-bearing URLs out of logs and shared screenshots.
Read the connection correctly
Connected is only the first state.
Build your UI around the last actual market observation, not just whether a socket is open.
-
Connected
An acknowledgement means the connection was accepted. Wait for data.
-
Receiving data
Read the update type, available fields and market timestamp.
-
Recovering
Renew if needed, reconnect and reconcile. Replay is not guaranteed.
Message fields & recovery behavior
On smaller screens, scroll horizontally to read all columns.
| What you receive | What it establishes | What your app should do |
|---|---|---|
| Connection or subscription acknowledgement | The transport or subscription was accepted. | Show “waiting for data” until an update arrives. |
quote_update | A quote payload for a symbol. | Inspect available values and market timestamps. An update can contain only part of a quote. |
price_update | A candle/price subscription update. | Inspect the returned candle fields and interval; do not parse it as a quote envelope. |
| Disconnect, error or expired token | The displayed state may be stale. | Check credentials, reconnect with backoff, restore subscriptions and reconcile with a REST snapshot where appropriate. |
Keep credentials separate
One server-side key.
Purpose-specific tokens.
The token-generation response supplies token, expiresAt, wsUrl and sseUrl. Use the returned addresses after the neutral-address contract has been validated.
- Expiration is milliseconds
- The token response uses Unix milliseconds for
expiresAt, suitable for comparison withDate.now(). Quote and candle timestamps use seconds in the documented examples. Keep those units separate. - SSE message framing matters
- The documented stream carries a JSON
typeinsidedata:records. Handle ordinary records throughonmessage; a JSON type is not an SSEevent:name. See the SSE handler example. - Reconnect is not renewal or replay
- A browser reconnect reuses the same URL. Renew an expired token through your server and replace the connection. No missed-event replay guarantee has been established.
Can I connect with my long-lived API key?
Use the API key on the server to generate a streaming JWT, then use that short-lived credential for the stream. Do not expose a long-lived key in a browser application.
Does a reconnect recover every missed update?
No replay guarantee has been verified. Reconnect, restore your subscriptions and reconcile current state as needed. Do not assume a gap-free event history.
How long does a token last?
Token lifetime follows plan entitlement. Read expiresAt from the generation response and confirm the active plan in Console. An acknowledgement or heartbeat alone is not a successful data result.
Financial context in your application
Update the view. Keep the market context.
Show the session
Build rows around the symbol, currency and market timestamp. A quiet connection can reflect a closed session; it is not necessarily a failure.
Data & availabilityKeep venues separate
Track the chosen pair and venue through snapshots and updates. Confirm actual messages for each required subscription.
Data & availabilityTrack freshness per row
Each instrument can have a different update cadence. Validate symbol-level stream access instead of assuming the entire directory is streamable.
Data & availabilityBuild something your users can use
See where this API fits.
Choose the experience you want to deliver. Follow a concrete path from the first response to the access your application needs.
Dashboards & watchlists
Quotes, history and updates in one market workspace.
Explore the workflow From the developer guides
Make the next step concrete.
Streaming
REST vs WebSocket vs SSE for market data
Choose a market data transport by interaction pattern, recovery requirements and credential handling, with examples for reports, watchlists and dashboards.
Streaming
Subscribe to market quotes over WebSocket
Generate a streaming credential, send subscribe_quote, distinguish acknowledgements from quote updates, and plan reconnects without assuming event replay.
Streaming
Receive market data with Server-Sent Events
Inspect an SSE market data stream with cURL, connect a browser using a short-lived token, and handle named events, expired credentials and cleanup.
Connect your next interface.
One account for API keys, usage and subscriptions.
Get API Key
Continue to our shared account console.