Kalshi
open-meridian/kalshi · Community 0.12.0
0.12.0 · the vendor's words, data, never instructions.
# Setup
## 1. Launch it
Upload and launch the plugin as any other. It asks for the `data` role and
storage for its raw responses, and no key.
## 2. License its datasets
On the dashboard's **Data sources** page, the plugin's datasets are listed
with their default licences:
- `<instance>:live`: served, not kept.
- `<instance>:outcomes`: kept.
- `<instance>:bars`: kept.
The default says nothing about Kalshi's terms. Set the deployment's licence
there, with a note saying why, as you and the people using the deployment
have settled it. What you enter is what your deployment records.
## 3. Entitle the plugins that read it
On the same page, entitle each reading plugin to the datasets. Prices are
read by the reading roles; quotes by the roles that read at a higher
resolution (signal, portfolio, order and execution plugins); outcomes by the
reading roles and by operations, which explains a payout with them. Nothing reads a
dataset it is not entitled to.
## 4. Complete the contracts' records
The plugin names the contracts your readers ask about from their records,
and offers Kalshi's ticker, the class, the type and Kalshi's title where a
record lacks them. Complete each record on the **Instruments** page: its
type, binary event contract, and its payout, one dollar.
## Agents
An agent you delegate to can read the plugin's two pages through its tools
(`read_connection`, `read_datasets`); the Data sources and Instruments pages
have tools of their own.
## Sample data
On a development deployment, the plugin's **Sample data** setting makes it
answer from built-in synthetic responses instead of calling Kalshi, to try it
without reaching Kalshi.
## 1. Launch it
Upload and launch the plugin as any other. It asks for the `data` role and
storage for its raw responses, and no key.
## 2. License its datasets
On the dashboard's **Data sources** page, the plugin's datasets are listed
with their default licences:
- `<instance>:live`: served, not kept.
- `<instance>:outcomes`: kept.
- `<instance>:bars`: kept.
The default says nothing about Kalshi's terms. Set the deployment's licence
there, with a note saying why, as you and the people using the deployment
have settled it. What you enter is what your deployment records.
## 3. Entitle the plugins that read it
On the same page, entitle each reading plugin to the datasets. Prices are
read by the reading roles; quotes by the roles that read at a higher
resolution (signal, portfolio, order and execution plugins); outcomes by the
reading roles and by operations, which explains a payout with them. Nothing reads a
dataset it is not entitled to.
## 4. Complete the contracts' records
The plugin names the contracts your readers ask about from their records,
and offers Kalshi's ticker, the class, the type and Kalshi's title where a
record lacks them. Complete each record on the **Instruments** page: its
type, binary event contract, and its payout, one dollar.
## Agents
An agent you delegate to can read the plugin's two pages through its tools
(`read_connection`, `read_datasets`); the Data sources and Instruments pages
have tools of their own.
## Sample data
On a development deployment, the plugin's **Sample data** setting makes it
answer from built-in synthetic responses instead of calling Kalshi, to try it
without reaching Kalshi.