Metadata-Version: 2.4
Name: adalia-undertow
Version: 0.2.0
Summary: Typed, read-only Python client for the Adalia Undertow liquidation-map API.
Author: Adalia Holding OÜ
License: MIT
Project-URL: Documentation, https://liq.adalia.ee/api.html
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Intended Audience :: Developers
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx<1,>=0.27
Provides-Extra: pandas
Requires-Dist: pandas>=2.0; extra == "pandas"
Provides-Extra: mcp
Requires-Dist: mcp==1.29.0; extra == "mcp"
Dynamic: license-file

# adalia-undertow

Typed, read-only Python client for the Adalia Undertow liquidation-map API.

API reference: https://liq.adalia.ee/api.html

## Install

    pip install adalia-undertow
    pip install "adalia-undertow[pandas]"

## Example

    from adalia_undertow import Client

    client = Client()  # reads the key from the UNDERTOW_API_KEY environment variable
    snap = client.get_latest("BTC")
    print(snap.as_of, snap.ref_price, snap.exact_fraction, snap.stale)

## MCP server

    pip install "adalia-undertow[mcp]"

The package ships a local MCP server exposing the six API routes as read-only
tools over stdio. It authenticates with your existing API key and forwards
requests unchanged: responses, tier limits, and rate limits are exactly those
of the HTTP API. Configure your MCP client to spawn it:

    {
      "mcpServers": {
        "undertow": {
          "command": "adalia-undertow-mcp",
          "env": {"UNDERTOW_API_KEY": "<your key>"}
        }
      }
    }

MCP tool access is a Quant-tier feature. Entitlement is decided and enforced
by the API server, never by this adapter: the MCP server verifies the key
against a tier-restricted route and mirrors the verdict. A key the API denies
gets an error naming this requirement; `get_health` works without any key.
Questions: undertow-support@adalia.ee

## License

MIT — see LICENSE.
