API Reference
Complete API reference for the Events streaming service.
Base URL
https://events.matchstick.tradingEndpoints
GET /api/stream
Server-Sent Events stream of market events.
Headers:
Accept: text/event-streamQuery Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
types | string | No | Comma-separated event types |
issuers | string | No | Comma-separated CIKs or names |
Response:
SSE stream with JSON-encoded Event objects.
Example:
bash
curl -N -H "Accept: text/event-stream" \
"https://events.matchstick.trading/api/stream?types=FORM_4"GET /api/health
Health check endpoint.
Response:
json
{
"status": "healthy",
"timestamp": "2025-01-15T12:00:00Z"
}Event Object
| Field | Type | Description |
|---|---|---|
eventType | string | Event type (FORM_4, FILING, NEWS) |
issuer | string | Company name |
cik | string | SEC Central Index Key |
filedAt | ISO 8601 | Source timestamp |
confidence | number | Data quality score (0-1) |
metadata | object | Event-specific fields |
Rate Limits
| Endpoint | Limit |
|---|---|
/api/stream | 5 concurrent connections per IP |
Error Handling
SSE errors appear as events:
event: error
data: {"code":"CONNECTION_LIMIT","message":"Too many connections"}Implement automatic reconnection in your client.