# OpenPit Wiki

Wiki source revision: `71f5c7ef8a57ccb0c1dcaaca22341e22f2366c03`.
Source state: `committed`.
Source repository: https://github.com/openpitkit/pit.wiki.git
This is rolling development documentation, not a versioned SDK release.

> Documentation for Pit (Pre-trade Integrity Toolkit), an embeddable pre-trade
> risk toolkit for trading systems.

This wiki describes current development. For an installed SDK release, select
that release's source tag and use its binding README, examples, and API. Do not
assume a `main` link or an unversioned API reference matches the installed
package.

## Start Here

- [Integration route and AI coding prompt](https://wiki.openpit.dev/Getting-Started/#integration-route):
  choose a language and version, run a first example, and connect the host
  application's lifecycle responsibilities.
- [Getting Started](https://wiki.openpit.dev/Getting-Started/): install the SDK
  and run a first end-to-end engine flow.
- [Runtime Delivery](https://wiki.openpit.dev/Runtime-Delivery/): native
  prerequisites, supported platforms, runtime selection, and overrides.
- [Architecture](https://wiki.openpit.dev/Architecture/): public integration
  model and SDK surfaces.
- [Pre-trade Pipeline](https://wiki.openpit.dev/Pre-trade-Pipeline/):
  admission lifecycle, result handling, and reservation semantics.

## Core Concepts

- [Domain Types](https://wiki.openpit.dev/Domain-Types/): strongly typed
  prices, quantities, identifiers, and exact decimal values.
- [Errors](https://wiki.openpit.dev/Errors/): each binding's boundary errors,
  callback failures, and business rejection model.
- [Policies](https://wiki.openpit.dev/Policies/): built-in controls, stage
  behavior, synchronization, and the policy catalog.
- [Policy API](https://wiki.openpit.dev/Policy-API/): custom policy callbacks
  and language-specific interfaces.
- [Reject Codes](https://wiki.openpit.dev/Reject-Codes/): stable business
  reject codes and their timing.
- [Storage](https://wiki.openpit.dev/Storage/): synchronization-aware policy
  state storage.
- [Threading Contract](https://wiki.openpit.dev/Threading-Contract/): handle
  threading guarantees for each synchronization mode.

## Operational Topics

- [Spot Funds](https://wiki.openpit.dev/Spot-Funds/): per-account funds checks,
  reservations, and holdings lifecycle.
- [Pre-Trade Lock](https://wiki.openpit.dev/Pre-Trade-Lock/): persisted
  reservation lock data used for reconciliation.
- [Non-Mutating Dry-Run](https://wiki.openpit.dev/Non-Mutating-Dry-Run/):
  probe pre-trade outcomes without changing engine state.
- [Dynamic Policy Reconfiguration](https://wiki.openpit.dev/Dynamic-Policy-Reconfiguration/):
  retune built-in policy settings while the engine is running.
- [Market Data](https://wiki.openpit.dev/Market-Data/): shared quote cache,
  quote buckets, and read/write API.
- [Account Adjustments](https://wiki.openpit.dev/Account-Adjustments/):
  non-trade adjustment batches and rollback behavior.
- [Account Groups](https://wiki.openpit.dev/Account-Groups/): membership and
  group-scoped controls; account groups and policy groups are distinct.
- [Account Blocking](https://wiki.openpit.dev/Account-Blocking/): account,
  group, and engine blocking, including mutation finalizer failures.
- [Balance Reconciliation](https://wiki.openpit.dev/Balance-Reconciliation/):
  reconcile engine state with caller-supplied venue balances.
- [Account Retirement](https://wiki.openpit.dev/Account-Retirement/): remove
  zero, unused account state and handle refusal.

## SDK references and examples

- [Generated API index](https://docs.openpit.dev/llms.txt): direct API page
  links for text readers, without depending on browser navigation scripts.
- [SDK installation guides](https://openpit.dev/llms.txt): all language
  entry points and package/API hosts.
- [Runnable scenarios](https://github.com/openpitkit/pit/tree/main/examples):
  select the same source tag as the SDK before copying an example.
- [Building From Source](https://wiki.openpit.dev/Building-From-Source/):
  contributor build and test recipes, separate from consumer installation.

## Complete page index

- [Account Adjustments](https://wiki.openpit.dev/Account-Adjustments/) | [Markdown](https://wiki.openpit.dev/markdown/Account-Adjustments.md)
- [Account Blocking](https://wiki.openpit.dev/Account-Blocking/) | [Markdown](https://wiki.openpit.dev/markdown/Account-Blocking.md)
- [Account Groups](https://wiki.openpit.dev/Account-Groups/) | [Markdown](https://wiki.openpit.dev/markdown/Account-Groups.md)
- [Account Retirement](https://wiki.openpit.dev/Account-Retirement/) | [Markdown](https://wiki.openpit.dev/markdown/Account-Retirement.md)
- [Architecture](https://wiki.openpit.dev/Architecture/) | [Markdown](https://wiki.openpit.dev/markdown/Architecture.md)
- [Async Engine (Go and C++)](https://wiki.openpit.dev/Async-Engine/) | [Markdown](https://wiki.openpit.dev/markdown/Async-Engine.md)
- [Balance Reconciliation](https://wiki.openpit.dev/Balance-Reconciliation/) | [Markdown](https://wiki.openpit.dev/markdown/Balance-Reconciliation.md)
- [Building From Source](https://wiki.openpit.dev/Building-From-Source/) | [Markdown](https://wiki.openpit.dev/markdown/Building-From-Source.md)
- [Custom C++ Types](https://wiki.openpit.dev/Custom-Cpp-Types/) | [Markdown](https://wiki.openpit.dev/markdown/Custom-Cpp-Types.md)
- [Custom Go Types](https://wiki.openpit.dev/Custom-Go-Types/) | [Markdown](https://wiki.openpit.dev/markdown/Custom-Go-Types.md)
- [Custom JS Types](https://wiki.openpit.dev/Custom-JS-Types/) | [Markdown](https://wiki.openpit.dev/markdown/Custom-JS-Types.md)
- [Custom Python Types](https://wiki.openpit.dev/Custom-Python-Types/) | [Markdown](https://wiki.openpit.dev/markdown/Custom-Python-Types.md)
- [Custom Rust Types](https://wiki.openpit.dev/Custom-Rust-Types/) | [Markdown](https://wiki.openpit.dev/markdown/Custom-Rust-Types.md)
- [Domain Types](https://wiki.openpit.dev/Domain-Types/) | [Markdown](https://wiki.openpit.dev/markdown/Domain-Types.md)
- [Dynamic Policy Reconfiguration](https://wiki.openpit.dev/Dynamic-Policy-Reconfiguration/) | [Markdown](https://wiki.openpit.dev/markdown/Dynamic-Policy-Reconfiguration.md)
- [Errors](https://wiki.openpit.dev/Errors/) | [Markdown](https://wiki.openpit.dev/markdown/Errors.md)
- [Getting Started](https://wiki.openpit.dev/Getting-Started/) | [Markdown](https://wiki.openpit.dev/markdown/Getting-Started.md)
- [Market Data Pricing](https://wiki.openpit.dev/Market-Data-Pricing/) | [Markdown](https://wiki.openpit.dev/markdown/Market-Data-Pricing.md)
- [Market Data TTL](https://wiki.openpit.dev/Market-Data-TTL/) | [Markdown](https://wiki.openpit.dev/markdown/Market-Data-TTL.md)
- [Market Data](https://wiki.openpit.dev/Market-Data/) | [Markdown](https://wiki.openpit.dev/markdown/Market-Data.md)
- [Non-Mutating Dry-Run](https://wiki.openpit.dev/Non-Mutating-Dry-Run/) | [Markdown](https://wiki.openpit.dev/markdown/Non-Mutating-Dry-Run.md)
- [Policies](https://wiki.openpit.dev/Policies/) | [Markdown](https://wiki.openpit.dev/markdown/Policies.md)
- [Policy API](https://wiki.openpit.dev/Policy-API/) | [Markdown](https://wiki.openpit.dev/markdown/Policy-API.md)
- [Pre-Trade Lock](https://wiki.openpit.dev/Pre-Trade-Lock/) | [Markdown](https://wiki.openpit.dev/markdown/Pre-Trade-Lock.md)
- [Pre-trade Pipeline](https://wiki.openpit.dev/Pre-trade-Pipeline/) | [Markdown](https://wiki.openpit.dev/markdown/Pre-trade-Pipeline.md)
- [Reject Codes](https://wiki.openpit.dev/Reject-Codes/) | [Markdown](https://wiki.openpit.dev/markdown/Reject-Codes.md)
- [Runtime Delivery](https://wiki.openpit.dev/Runtime-Delivery/) | [Markdown](https://wiki.openpit.dev/markdown/Runtime-Delivery.md)
- [Spot Funds](https://wiki.openpit.dev/Spot-Funds/) | [Markdown](https://wiki.openpit.dev/markdown/Spot-Funds.md)
- [Storage](https://wiki.openpit.dev/Storage/) | [Markdown](https://wiki.openpit.dev/markdown/Storage.md)
- [Threading Contract](https://wiki.openpit.dev/Threading-Contract/) | [Markdown](https://wiki.openpit.dev/markdown/Threading-Contract.md)
- [OpenPit](https://wiki.openpit.dev/) | [Markdown](https://wiki.openpit.dev/markdown/index.md)