jwlutz commited on
Commit
23a0fcc
·
verified ·
1 Parent(s): e48730e

card, license and attribution for release 2026-08-02

Browse files
Files changed (1) hide show
  1. README.md +11 -8
README.md CHANGED
@@ -115,21 +115,24 @@ trades = knowable.congress_trades(since="2026-01-01", ticker="NVDA")
115
  The SDK wraps the HTTP contract below, so an SDK query and a direct API query
116
  return identical rows.
117
 
118
- **Status: the read API is not hosted yet.** The FastAPI app and a client both
119
- exist and are tested against real release bytes, but no public endpoint serves
120
- them today. Use the Parquet paths above until that lands. The contract, so you
121
- can write against it now:
 
122
 
123
  ```
124
  GET /v1/{resource}?cursor=&limit=&as_of=
125
- -> {"data": [...], "next_cursor": str|null, "as_of": timestamp}
 
126
 
127
  resources: congress/trades, house/filings, senate/filings,
128
- insider/transactions, fund/holdings, coverage
129
  ```
130
 
131
- `as_of` applies the point-in-time bound server-side. Paging is keyed on
132
- `(published_at, id)`, so a cursor stays valid across releases.
 
133
 
134
  ## What it covers
135
 
 
115
  The SDK wraps the HTTP contract below, so an SDK query and a direct API query
116
  return identical rows.
117
 
118
+ **The read API is live at
119
+ <https://knowable-api-production.up.railway.app>.** It serves the verified
120
+ release through one sealed read-only DuckDB connection. The unversioned
121
+ Congress route also carries a small MIT-licensed Kadoa current tail; dated
122
+ release routes remain immutable. Contract:
123
 
124
  ```
125
  GET /v1/{resource}?cursor=&limit=&as_of=
126
+ -> {"data": [...], "next_cursor": str|null,
127
+ "resume_cursor": str|null, "as_of": timestamp}
128
 
129
  resources: congress/trades, house/filings, senate/filings,
130
+ sec/form4, sec/holdings, coverage
131
  ```
132
 
133
+ `as_of` applies the point-in-time bound server-side. Persist `resume_cursor`
134
+ after every non-empty page so a caught-up client does not re-download the same
135
+ short tail. The token is opaque and versioned.
136
 
137
  ## What it covers
138