Documentation Index
Fetch the complete documentation index at: https://benzinga-2-mrrancy-patch-1.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Subscribe to real-time bull and bear case analyses for securities. Get balanced perspectives on both positive (bullish) and negative (bearish) scenarios for stocks.
Key Features
- Balanced Analysis: Receive both bull and bear cases for comprehensive market insight
- Real-time Updates: Get instant notifications when cases are created, updated, or removed
- Filter by Security: Subscribe to specific tickers or ISINs
- Market Sentiment: Understand both optimistic and pessimistic viewpoints
Use Cases
- Build sentiment analysis dashboards showing both sides of the argument
- Track changes in bull/bear sentiment over time
- Alert users to significant shifts in market perspective
- Provide balanced investment research to clients
Quick Start
Use the interactive WebSocket tester above to connect and test the stream in real-time.
Connection URL
wss://api.benzinga.com/api/v1/bulls_bears_say/stream?token=YOUR_TOKEN
Query Parameters
| Parameter | Required | Description |
|---|
token | Yes | Your Benzinga WebSocket API token (bz.production***) |
tickers | No | Comma-separated list of ticker symbols (e.g., AAPL,TSLA) |
isins | No | Comma-separated list of ISINs to filter |
Message Example
{
"id": "websocket123",
"api_version": "websocket/v1",
"kind": "bull_bear_case",
"data": {
"action": "created",
"id": "case123",
"timestamp": "2024-10-01T10:00:00Z",
"content": {
"bull_case": "Strong earnings growth and market expansion expected.",
"bear_case": "Increased competition and regulatory pressures.",
"ticker": "AAPL",
"updated": 1696153200
}
}
}
Message Actions
| Action | Description |
|---|
created / Created | New bull/bear case published |
updated / Updated | Existing case modified |
deleted / Deleted | Case removed |
Interactive Commands
| Command | Description |
|---|
ping | Keep connection alive (responds with pong) |
replay | Replay up to the last 100 cached messages |
Best Practices
- Deduplication: Use the
id field to prevent processing duplicate messages
- Heartbeat: Send
ping commands every 30-60 seconds
- Balanced Presentation: Display both bull and bear cases to provide fair analysis
- Update Tracking: Monitor the
updated timestamp to identify recent changes