Skip to content

API Reference

Complete API reference for the Events streaming service.

Base URL

https://events.matchstick.trading

Endpoints

GET /api/stream

Server-Sent Events stream of market events.

Headers:

Accept: text/event-stream

Query Parameters:

ParameterTypeRequiredDescription
typesstringNoComma-separated event types
issuersstringNoComma-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

FieldTypeDescription
eventTypestringEvent type (FORM_4, FILING, NEWS)
issuerstringCompany name
cikstringSEC Central Index Key
filedAtISO 8601Source timestamp
confidencenumberData quality score (0-1)
metadataobjectEvent-specific fields

Rate Limits

EndpointLimit
/api/stream5 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.

Built for traders who value data provenance.