> For the complete documentation index, see [llms.txt](https://dev.strixlab.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.strixlab.io/readme.md).

# Developer Docs

Strix Lab runs a central-limit order book. Orders match off-chain in milliseconds and settle on-chain in USDC — and everything the app does, your code can do too.

There are two ways in:

* [**`strix-sdk`**](/get-started/installation.md) — the official TypeScript client. Typed responses, HMAC signing, order-book caching, and auto-reconnecting WebSocket channels. **Start here.**
* [**The raw HTTP + WebSocket API**](/http-and-websocket-api/rest.md) — for any other language. The SDK is a thin wrapper over it, so everything below maps one-to-one.

{% hint style="success" %}
**Never used the platform before?** Read [Core Concepts](/get-started/concepts.md) first — five minutes there saves an afternoon of debugging `tokenId`.
{% endhint %}

### Hello, order book

{% code title="hello-strix.ts" %}

```ts
import { StrixClient } from 'strix-sdk';

const client = new StrixClient({ baseUrl: 'https://api.strixlab.io/api' });

const { items } = await client.events.list({ status: 'open', limit: 1 });
const tokenId   = items[0].markets[0].outcomes[0].tokenId;

const book = await client.orderbook.snapshot(tokenId, { depth: 5 });
console.log(book.bids[0], book.asks[0]);
```

{% endcode %}

No credentials needed for that — market data is public. Add API keys when you want to trade.

### Start here

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>⚡ Quickstart</strong></td><td>Install, authenticate, and place your first programmatic order.</td><td><a href="/pages/SlqdFxrDUfV11rbsE5Rf">/pages/SlqdFxrDUfV11rbsE5Rf</a></td></tr><tr><td><strong>🧠 Core Concepts</strong></td><td>Events, markets, outcomes, <code>tokenId</code>, ticks, and async settlement.</td><td><a href="/pages/6DUIiB3sInixDYLXPCpp">/pages/6DUIiB3sInixDYLXPCpp</a></td></tr><tr><td><strong>📈 Orders</strong></td><td>Limit, market, and batch orders — plus the cancel kill-switch.</td><td><a href="/pages/5iM2Q95kto2jNUN0e6DO">/pages/5iM2Q95kto2jNUN0e6DO</a></td></tr><tr><td><strong>🔌 WebSocket Streams</strong></td><td>Live book, public trades, and your own fills on one socket.</td><td><a href="/pages/1MneMLLPWYYx5FlnbhNy">/pages/1MneMLLPWYYx5FlnbhNy</a></td></tr><tr><td><strong>🤖 Market-Maker Bot</strong></td><td>A complete two-sided quoting bot, built up step by step.</td><td><a href="/pages/1NsCD3rc77y0rO3heIVA">/pages/1NsCD3rc77y0rO3heIVA</a></td></tr><tr><td><strong>📚 SDK Reference</strong></td><td>Every method on the client, on one page.</td><td><a href="/pages/IzcqCgwXj6DVGThFC3qu">/pages/IzcqCgwXj6DVGThFC3qu</a></td></tr></tbody></table>

### What the API covers

<table><thead><tr><th width="220">Area</th><th>What you get</th></tr></thead><tbody><tr><td><strong>Market data</strong></td><td>Events, markets, outcomes, order-book snapshots, midpoints, OHLCV candles, public trade feed — all without credentials.</td></tr><tr><td><strong>Trading</strong></td><td>Limit orders (GTC/GTD/FOK/FAK), market orders, batches of up to 15, single/batch/bulk cancel.</td></tr><tr><td><strong>Account</strong></td><td>Balances, positions, trade history, deposits and withdrawals.</td></tr><tr><td><strong>Conditional tokens</strong></td><td>Split USDC into a full outcome set, merge it back, redeem winnings after resolution.</td></tr><tr><td><strong>Real time</strong></td><td>Order-book snapshots and deltas, last trade price, your order updates, fills, and position deltas.</td></tr></tbody></table>

{% hint style="warning" %}
**Availability.** Opening new positions is not available in every jurisdiction. See [Restricted Regions](https://docs.strixlab.io/policies/restricted-regions) before you deploy a bot.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://dev.strixlab.io/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
