Quincy News API & Wire Format

Heartbeat v0.1

// Body may be zero bytes; presence indicates liveness from a publisher.
// MessageHeader.message_type = Heartbeat (0)

Lightweight liveness indicator. No payload parsing required.

Headline Message v0.1

struct HeadlineMessage {
  uint8_t  schema_version;  // 0x01 => v0.1
  uint8_t  language_id;     // uint8 -> registry mapping to ISO 639-1
  uint8_t  ticker_count;    // number of 12B, UTF-8 NUL-terminated tickers
  uint16_t headline_length; // number of UTF-8 bytes
}; /* trailing data follows:
  char tickers[ticker_count][12]; // "MIC:TICKER"
  char headline_text[headline_length]; // UTF-8, not NUL-terminated
*/

Ticker-tagged headline with UTF-8 text.

Story Body Fragment v0.1

struct StoryBodyFragmentMessage {
  uint8_t  schema_version;   // 0x01 => v0.1
  uint16_t fragment_index;   // 0-based
  uint16_t fragment_count;   // > 0
  uint16_t fragment_length;  // number of UTF-8 bytes
}; /* trailing data follows:
  char fragment_text[fragment_length]; // UTF-8, not NUL-terminated
*/

Multipart UTF-8 content tied to a headline. Reassembly by content_id + (fragment_index, fragment_count).

Someone Said Something v0.1

struct SomeoneSaidSomethingMessage {
  uint8_t  schema_version; // 0x01 => v0.1
  uint16_t someone_id;     // registry of tracked figures (https://quincy.news/someone_registry.json)
  uint8_t  speech_type;    // 0 == speaking, 1 == spoke
};

Alert of statements by key public figures. Signal only; no inline content.

Someone Said X v0.1

struct SomeoneSaidXMessage {
  uint8_t  schema_version;    // 0x01 => v0.1
  uint16_t someone_id;        // registry of tracked figures (https://quincy.news/someone_registry.json)
  uint8_t  speech_type;       // 0 == speaking, 1 == spoke
  uint8_t  ticker_count;      // max 4
  uint8_t  country_code_count;
  uint16_t statement_length;  // number of UTF-8 bytes
}; /* trailing data follows:
  char tickers[ticker_count][12]; // "MIC:TICKER"
  char country_codes[country_code_count][2]; // ISO 3166-1 alpha-2
  char statement[statement_length]; // UTF-8, not NUL-terminated
*/

Real-time alerts including the (maybe partial) statement. Ticker- and country-tagged where applicable. Tagging is contextless & extremely simplistic with false positive matching likely.

Raw News v0.1

struct RawMessage {
  uint8_t  schema_version;    // 0x01 => v0.1
  uint8_t  source_wire;       // registry of third party sources 
                              // (e.g., machine readable news licensed
                              // by third-party providers)
}; /* trailing data follows:
  char* vendor_message;       // third-party specific message format,
                              // in its native multicast format
*/

This structure shows how we deliver third-party licensed news contentacross our global platform. The message preserves the provider’soriginal wire format, so clients can consume it exactly as intended by the vendor, while still benefiting from our distribution and transport advantages.

Event Indicators v0.1

struct EventMessage {
  uint8_t  schema_version; 
  uint8_t  event_count;
}; /* trailing data follows:
  Event    events[event_count];
*/

struct Event {
  uint32_t event_id;         // event registry
  uint8_t  indicator_count;       
}; /* trailing data follows:
  EventIndicator indicators[indicator_count];
*/

struct EventIndicator {
  uint8_t  indicator_id;     // event-specific indicator registry
  void*    value;            // event-specific indicator registry mapped types occupying 1-8 bytes total
                             // ... one of bool u/int8 u/int16 u/int32 u/int64 float32 float64
};

Each Event references an event-specific registry that defines its indicator_id values and the concrete wire type for each indicator.
Messages may carry multiple events, particularly when originating from the same primary source.

Congressional Trading Disclosure v0.1

struct DisclosureMessage {
  uint8_t  schema_version; 
  uint16_t someone_id;     // registry of tracked figures (https://quincy.news/someone_registry.json)
  uint8_t  trade_count;   
}; /* trailing data follows:
  DisclosureTradeMessage disclosure_trades[trade_count];
*/

struct DisclosureTradeMessage {
  uint8_t  asset_type;            // enum registry
  char     underlying_ticker[12]; // "MIC:TICKER"
  uint32_t trade_date;            // Unix time, UTC seconds
  uint8_t  transact_type;         // enum registry 
  uint8_t  value_range;           // enum registry
  uint8_t  asset_name_length;     // <= 255
  uint8_t  description_length;    // <= 255
}; /* trailing data follows:
  char asset_name[asset_name_length];   // UTF-8, not NUL-terminated  
  char description[description_length]; // UTF-8, not NUL-terminated  
*/

Structured disclosures including asset details and transaction types. trade_date uses Unix epoch seconds (UTC).

DisclosureMessage Registry

// code -> symbol -> description
0   -> "UK" -> "Unknown"
1   -> "4K" -> "401K and Other Non-Federal Retirement Accounts"
2   -> "5C" -> "529 College Savings Plan"
3   -> "5F" -> "529 Portfolio"
4   -> "5P" -> "529 Prepaid Tuition Plan"
5   -> "AB" -> "Asset-Backed Securities"
6   -> "BA" -> "Bank Accounts, Money Market Accounts and CDs"
7   -> "BK" -> "Brokerage Accounts"
8   -> "CO" -> "Collectibles"
9   -> "CS" -> "Corporate Securities (Bonds and Notes)"
10  -> "CT" -> "Cryptocurrency"
11  -> "DB" -> "Defined Benefit Pension"
12  -> "DO" -> "Debts Owed to the Filer"
13  -> "DS" -> "Delaware Statutory Trust"
14  -> "EF" -> "Exchange Traded Funds (ETF)"
15  -> "EQ" -> "Excepted/Qualified Blind Trust"
16  -> "ET" -> "Exchange Traded Notes"
17  -> "FA" -> "Farms"
18  -> "FE" -> "Foreign Exchange Position (Currency)"
19  -> "FN" -> "Fixed Annuity"
20  -> "FU" -> "Futures"
21  -> "GS" -> "Government Securities and Agency Debt"
22  -> "HE" -> "Hedge Funds & Private Equity Funds (EIF)"
23  -> "HN" -> "Hedge Funds & Private Equity Funds (non-EIF)"
24  -> "IC" -> "Investment Club"
25  -> "IH" -> "IRA (Held in Cash)"
26  -> "IP" -> "Intellectual Property & Royalties"
27  -> "IR" -> "IRA"
28  -> "MA" -> "Managed Accounts (e.g., SMA and UMA)"
29  -> "MF" -> "Mutual Funds"
30  -> "MO" -> "Mineral/Oil/Solar Energy Rights"
31  -> "OI" -> "Ownership Interest (Holding Investments)"
32  -> "OL" -> "Ownership Interest (Engaged in a Trade or Business)"
33  -> "OP" -> "Options"
34  -> "OT" -> "Other"
35  -> "PE" -> "Pensions"
36  -> "PM" -> "Precious Metals"
37  -> "PS" -> "Stock (Not Publicly Traded)"
38  -> "RE" -> "Real Estate Invest. Trust (REIT)"
39  -> "RF" -> "REIT (EIF)"
40  -> "RN" -> "REIT (non-EIF)"
41  -> "RP" -> "Real Property"
42  -> "RS" -> "Restricted Stock Units (RSUs)"
43  -> "SA" -> "Stock Appreciation Right"
44  -> "ST" -> "Stocks (including ADRs)"
45  -> "TR" -> "Trust"
46  -> "VA" -> "Variable Annuity"
47  -> "VI" -> "Variable Insurance"
48  -> "WU" -> "Whole/Universal Insurance"

// code -> symbol/meaning
0 -> "unknown"
1 -> "P"           // Purchase
2 -> "S"           // Sale
3 -> "S (Partial)" // Partial Sale

// code -> dollar range (USD)
0  -> "unknown"
1  -> "1,001 - 15,000"
2  -> "15,001 - 50,000"
3  -> "50,001 - 100,000"
4  -> "100,001 - 250,000"
5  -> "250,001 - 500,000"
6  -> "500,001 - 1,000,000"
7  -> "1,000,001 - 5,000,000"
8  -> "5,000,001 - 25,000,000"
9  -> "25,000,001 - 50,000,000"
10 -> "50,000,001 +"