Metadata-Version: 2.4
Name: nfin-client
Version: 0.1.0
Summary: Unofficial Python client for the hosted nfin Nasdaq data API.
Project-URL: Homepage, https://github.com/bluedoor-ai/nfin
Project-URL: Documentation, https://github.com/bluedoor-ai/nfin
Project-URL: Source, https://github.com/bluedoor-ai/nfin
Author-email: BlueDoor <sam@bluedoor.sh>
License: MIT
Keywords: finance,market-data,nasdaq,nfin,stocks
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# nfin-client

Unofficial Python client for the hosted nfin Nasdaq data API.

The hosted API exposes CP2-confirmed public Nasdaq.com contracts behind a
cached, rate-limited REST surface. It is not affiliated with, endorsed by, or
sponsored by Nasdaq, Inc.

## Install

```bash
pip install nfin-client
```

## Quick Start

```python
from nfin_client import Client

client = Client(contact="you@example.com")
summary = client.quote_summary("AAPL")
results = client.search("apple")
raw = client.raw("api.quote.<symbol>.info", params={"symbol": "MSFT"})
```

Convenience wrappers are also available:

```python
import nfin_client

data = nfin_client.quote("AAPL")
```

## Common Methods

- `Client.endpoints()` and `Client.openapi()` expose discovery metadata.
- `Client.raw(endpoint_id, params=None)` calls any shipped contract by ID.
- `Client.quote(symbol, view="info")` fetches quote views such as `summary`,
  `historical`, `dividends`, and `realtime-trades`.
- `Client.quote_options(symbol, view=None)` fetches option-chain routes.
- `Client.search(query)`, `Client.calendar(kind)`, `Client.market_movers()`,
  `Client.market_list(list_id)`, and `Client.screener(type)` cover common
  Nasdaq routes.
- `Client.nordic_search()`, `Client.nordic_instrument()`, and
  `Client.nordic_screener()` cover the public Nasdaq Nordic surface.

Set `NFIN_BASE_URL`, `NFIN_CONTACT`, or `NFIN_API_KEY` in the environment to
configure the default client.
