Metadata-Version: 2.4
Name: openbb-atlantis
Version: 0.2.0
Summary: Bond data for the OpenBB Platform: search 162,000+ CUSIPs and ISINs, per-bond reference and price history, 72 sovereign yield curves, US corporate and municipal curves, sovereign ratings. No API key.
Keywords: bonds,fixed-income,yield-curves,openbb,cusip,municipal,sovereign
Author: Atlantis Data Solutions
Author-email: carb.fa@gmail.com
Requires-Python: >=3.9
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: openbb-core (>=1.0,<2.0)
Project-URL: Homepage, https://atlantisdatasolutions.com
Project-URL: Repository, https://github.com/atlantisdatasolutions/openbb-atlantis
Description-Content-Type: text/markdown

# openbb-atlantis

Bond data for the [OpenBB Platform](https://openbb.co), from
[Atlantis Data Solutions](https://atlantisdatasolutions.com).

OpenBB ships 30+ provider extensions and none of them covers individual bonds.
This one does:

- **Bond lookup** across 162,000+ CUSIPs and ISINs: US Treasuries, corporates,
  municipals, sovereigns, European exchange listings, India G-secs and more
- **Yield curves**: 72 sovereign curves (including India, Indonesia and
  Switzerland), US corporate rating band curves, US municipal state curves
- **Curve placement**: every bond comes back with its fitted reference yield and
  its residual in basis points, so relative value is one call
- **Price and yield history**: the most recent 12 observations per bond, with a
  link to the full multi-year series
- **Sovereign ratings** (S&P long term foreign currency)

No API key required.

## Install

```bash
pip install openbb-atlantis
```

**Upgrading from 0.1.0?** Run this once, otherwise the new commands will not
appear:

```python
import openbb; openbb.build()
```

OpenBB caches its generated interface and only rebuilds when the set of
installed extensions changes, so an in-place version bump needs a nudge. Fresh
installs build automatically and need nothing.

## Use

```python
from openbb import obb

# Find bonds by issuer name, CUSIP or ISIN fragment
obb.atlantis.bond_search(query="apple")

# One bond in full, including where it sits against its curve
obb.atlantis.bond_reference(symbol="037833BX7")

# Recent price and yield observations
obb.atlantis.bond_history(symbol="037833BX7")

# A country's government curve
obb.atlantis.yield_curve(country="India")
```

Sovereign curves are also available through OpenBB's own standard command, so
you can compare providers side by side:

```python
obb.fixedincome.government.yield_curve(provider="atlantis", country="India")
```

## Why the `atlantis` namespace

Bond search, bond reference and bond history live under `obb.atlantis.*` rather
than `obb.fixedincome.*` because the OpenBB Platform has no router command for
them yet. It defines `BondReference`, `BondPrices` and `BondTrades` models in
`openbb-core`, but nothing exposes them, so a provider has nothing to attach to.
This package ships its own router alongside the provider so the data is usable
today. We would rather these lived in the fixedincome router and are happy to
contribute them upstream.

## Fair use

Free for individual queries, with attribution. Rate limits apply per IP, and
there are deliberately **no bulk endpoints**: this answers questions, it is not
a feed. Higher limits come with an API key, included with an annual
subscription. Full price histories and the downloadable universe live at
[atlantisdatasolutions.com/bond-lookup](https://atlantisdatasolutions.com/bond-lookup).

The underlying REST API is documented at
[atlantisdatasolutions.com/api](https://atlantisdatasolutions.com/api) and works
from anything that speaks HTTP.

Data © Atlantis Data Solutions. Attribution required on redisplay.

