Skip to content
openoms
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Getting Started
Installation
Getting started
Your first paper trade
Your first API call
Configuration
oms.toml reference
Config file locations
Login (OIDC)
Concepts
Architecture
Strategies
Strategies over FIX
Strategies over REST
Co-located strategies
Integrations
Alpaca
Binance
Interactive Brokers (FIX)
Bybit
Coinbase
OKX
Databento / OPRA
Operations
Updating
Running as a service
Database commands
Master key and backups
Troubleshooting
API Reference
Overview
orders
Overview
Search instruments
Get an option chain for an underlying and expiry
List option expiries for an underlying
The caller's own blotter.
Cancel an order
Submit an order
Get an order's current state
List an order's allocations
Allocate a block order's fills across portfolios
Get an order's event history
The portfolios this principal may act on.
List a portfolio's positions
List the venues a portfolio can route an instrument to
What the calling strategy may trade.
admin
Overview
list_accounts
create_account
get_account
update_account
list_broker_connections
create_broker_connection
get_broker_connection
update_broker_connection
What is configured for one broker connection, with every secret withheld.
Save (create or edit) a broker connection's credential.
Clear a broker connection's stored credential.
Test the credential already stored for a broker connection, changing
Get a broker connection's instrument universe status
Enrich a broker connection's instruments with FIGIs
Load or reload a broker connection's instrument universe
Re-read the credential store and apply what can be applied without a
The configured feed connections themselves (rows), distinct from
What is configured for one feed connection, with every secret withheld.
Save (create or edit) a feed connection's credential. See
Clear a feed connection's stored credential. See
Test the credential already stored for a feed connection, changing
The configured data feeds: the ranked market-data source policy plus how many
Restart the FIX acceptor with a session per strategy as registered now.
list_instruments
Run the instrument expiry pass now, as a job, instead of waiting for the hourly tick
List recent background jobs
Get a background job and its log
get_orders_blotter
get_order_events_admin
list_portfolios
create_portfolio
get_portfolio
update_portfolio
list_principals
create_principal
get_principal
update_principal
list_grants
create_grant
delete_grant
update_grant
list_principal_keys
register_principal_key
revoke_principal_key
Cut a principal off immediately: revoke every one of its live sessions.
list_risk_limits
create_risk_limit
get_risk_limit
delete_risk_limit
update_risk_limit
What is left to configure. Reuses `credentials::load_brokers`/`load_feeds`
list_strategies
create_strategy
delete_strategy
update_strategy
The strategy's connections: one account per broker code.
Replace the strategy's connections. Each account must belong to the
Let a killed or flattened strategy trade and log on again.
Kill, leave the strategy reducing only, and close every position with a
Store the OMS's follow-only key for a co-located strategy, sealed with the
Halt the strategy, refuse its REST token, cancel every open order and log
Set a new FIX password and return it once.
Backfill FIGIs for instruments that have none, as a job
resolve_symbology
list_trading_tokens
create_trading_token
revoke_trading_token
auth
Overview
Completes a login: validates the callback, exchanges the code, resolves
Starts a login: mints `state`/`nonce`/a PKCE verifier, remembers them in
Local logout only: revokes our session and clears our cookie. The IdP's
Who the caller is signed in as, and what they can act on.
handlers
health
GitHub
Select theme
Dark
Light
Auto
Overview
orders
Section titled “orders”
Order submission and cancellation
Operations
Section titled “Operations”
GET
/instruments
GET
/instruments/options/chain
GET
/instruments/options/expiries
GET
/orders
POST
/orders/cancel
POST
/orders/submit
GET
/orders/{id}
GET
/orders/{id}/allocations
POST
/orders/{id}/allocations
GET
/orders/{id}/events
GET
/portfolios
GET
/portfolios/{id}/positions
GET
/portfolios/{id}/venues
GET
/strategies/securities
