# Pit Officer

> Open-source, self-hosted pre-trade risk control around the OpenPit engine.
> A local operator panel, REST API and MCP tools share accounts, risk policies,
> automatic market prices, order decisions and audit history.

Built-in trading connections to
Interactive Brokers, Binance, Alpaca and eToro send approved orders and receive
execution updates. Verify provider and connection support in the running instance.

Start Officer with one command using the public Docker image:
`docker run -d --name pit-officer --restart unless-stopped -p 127.0.0.1:8787:8787 -v pit-officer-data:/data ghcr.io/openpitkit/officer`.
Install and start Docker first; no source checkout, local compilation or Compose file is required for
this path. Open the panel at http://127.0.0.1:8787 on the same computer.
The integration guide includes browser-opening commands and
`docker start pit-officer` for an existing stopped container.

Officer obtains market prices automatically through configured instrument
subscriptions and supplies quotes to the risk engine. Built-in price adapters
include Interactive Brokers, Binance, Kraken, Coinbase, Alpaca, OKX, Bybit,
OANDA and Finnhub, plus a custom source. Price-source support and order-sending
support are distinct; provider data entitlements and subscriptions still apply.

Use Officer for a running service and operator panel. Use the OpenPit SDK to
embed the engine in an application. Market-data adapters, risk decisions,
execution and execution reporting are separate capabilities.

For an approval-only integration, the executor must enforce a valid acceptance
bound to the exact order. Ed25519 signing is configurable, unsigned mode exists,
and ordinary request-validation errors are not signed risk decisions.
Native service access is loopback by default; the panel, REST API and HTTP MCP
have no built-in authentication. MCP mutations need operator opt-in by name.

## Start here

- [Officer integration guide](https://officer.openpit.dev/integrate.md): one-command Docker setup, opening the panel again, automatic prices, trading connections, first decision, REST/MCP discovery, integration boundaries, and a copyable prompt for a coding agent.
- [Trading connections and price feeds](https://officer.openpit.dev/#connections): provider lists and the distinction between sending orders and receiving prices.
- [Source and build guide](https://raw.githubusercontent.com/openpitkit/officer/main/README.md): prerequisites and supported build commands.

## API and deployment

- [REST and MCP notes](https://raw.githubusercontent.com/openpitkit/officer/main/docs/api.md): mount points, decimal strings, errors, tool permissions and audit sources.
- [OpenAPI schema](https://raw.githubusercontent.com/openpitkit/officer/main/httpapi/openapi.yaml): source schema; use /api/openapi.yaml from the running instance for the actual API contract.
- [Configuration](https://raw.githubusercontent.com/openpitkit/officer/main/docs/configuration.md): subcommands, loopback ports, database paths, authorization and optional secret encryption.
- [Development and composition](https://raw.githubusercontent.com/openpitkit/officer/main/docs/development.md): building a custom Officer from the public framework.

## OpenPit engine

- [Engine discovery index](https://openpit.dev/llms.txt): SDK language selection and public references.
- [Wiki discovery index](https://wiki.openpit.dev/llms.txt): concepts, lifecycle and executable examples.
- [Getting started](https://wiki.openpit.dev/Getting-Started/): SDK installation and engine flow, distinct from Officer installation.
- [API reference index](https://docs.openpit.dev/llms.txt): generated engine binding references.

## Optional

- [Officer site](https://officer.openpit.dev/): audience use cases and a concise product overview.
- [License](https://www.apache.org/licenses/LICENSE-2.0): Apache-2.0.