Metadata-Version: 2.5
Name: mantis-ib
Version: 0.3.0
Summary: Interactive Brokers source provider for MANTIS
Author-email: Louis Zhuang <yzhuang@outlook.com>
Requires-Python: >=3.14
Requires-Dist: adbc-driver-postgresql>=1.12.0
Requires-Dist: asof-store[sql-postgres,sql-sqlite]
Requires-Dist: mantis-imf
Requires-Dist: polars[adbc,pyarrow]>=2.0.0
Requires-Dist: pydantic>=2.0
Requires-Dist: service-registrar>=0.2.1
Requires-Dist: zapros>=0.20.0
Description-Content-Type: text/markdown

# MANTIS Interactive Brokers provider

Install `mantis-ib` alongside `mantis-imf` to register the IB resolver source
and install the provider-specific `ib` command.

## Commands

```console
ib index
ib scrape-instruments
ib scrape-reconcile
ib scrape-funds
ib scrape-exchanges
```

`ib index` requires PostgreSQL and creates trigram indexes for the instrument
and template tables. Run it after configuring the IB store and before large
wildcard queries. Pass `--table-name` and
`--missing-primary-key-table-name` when using non-default tables; pass
`--sql-uri URI` to select another database.

`ib scrape-instruments` and `ib scrape-reconcile` accept repeated
`--product-type` and `--product-country` filters. `ib scrape-instruments`
supports `--dry-run` to print a remote product summary without scraping or
storing records. Scraping commands accept `--sql-uri URI` to override the
configured SQL URI. See `ib <command> --help` for command-specific options.

Shared SQL configuration and resolver search behavior are documented in the
[resolver guide](../../docs/instrument-resolver.md).
