quantjourney-api

Python SDK for the public/product qj-api contract.

Canonical package metadata:

quantjourney-api is the public product/API SDK. The quantjourney umbrella package lives in packages/quantjourney and installs quantjourney-api.

from qj.api import QJ, QuantJourneyAPI

qj = QJ.from_env()
health = qj.health()
capabilities = qj.capabilities()

# Provider connectors through qj-api
profile = qj.fmp.get_company_profile(symbol="NVDA")
gdp = qj.fred.get_series(series_id="GDP")
filings = qj.sec.get_recent_filings(limit=5)
trades = qj.massive.get_stock_trades(ticker="AAPL", limit=100)
legacy_quotes = qj.polygon.get_stock_quotes(ticker="AAPL", limit=100)
cpi = qj.tradingeconomics.get_historical_indicators(
    country="United States",
    indicator="Consumer Price Index CPI",
)
macro_revision = qj.dbnomics.get_series(
    provider_code="ECB",
    dataset_code="EXR",
    series_code="D.USD.EUR.SP00.A",
    revision="<commit-sha>",
)

# Research-source expansion (requires a backend with these routes deployed)
approvals = qj.openfda.get_drug_approvals(search='sponsor_name:"PFIZER"', limit=5)
attention = qj.apewisdom.get_mentions(filter="all-stocks")
pageviews = qj.wikimedia.get_pageviews(article="Apple_Inc.")
fear_greed = qj.alternative.get_fear_greed(limit=30)
dvol = qj.deribit.get_dvol(currency="BTC")
fees = qj.defillama.get_protocol_fees(protocol_slug="aave", data_type="dailyRevenue")

# Provider-agnostic domain routes
routes = qj.domains.list()
prices = qj.domains.equity.pricing.get_historical_prices(symbol="NVDA")

# Product API surfaces
analytics = qj.analytics.registry()
ratios = qj.ratios.available(source="eod")
indicators = qj.technical.available()

# Compatibility aliases
qj2 = QuantJourneyAPI.from_env()

Local smoke from this checkout:

python scripts/qj_api_smoke.py --env .env
python scripts/endpoint_matrix.py --env .env
python scripts/endpoint_matrix.py --env .env --list
python scripts/endpoint_matrix.py --env .env --group connectors --allow-failures
python scripts/endpoint_matrix.py --env .env --group connector_examples --include-connector-examples --allow-failures
python scripts/connector_matrix.py --env .env

scripts/connectors.json stores one smoke example per connector. The endpoint matrix verifies every connector route; connector_matrix.py runs the examples and prints a compact result table.

The September research-source expansion adds openfda, apewisdom, wikimedia, alternative, quiver, ember, opensky, manifold, deribit, mempool, blockscout and blockchain, plus DefiLlama fee/revenue methods. Calls use the normal QJ tenant/scopes and credentials. Configure upstream Quiver and Ember keys in QJ Data Sources; do not send them as SDK method parameters. Provider data remains in the response's value envelope.

Environment variables:

Install from PyPI:

pip install quantjourney-api==0.1.3

quantjourney-common-sdk is installed automatically as a dependency. Local development can still use editable path installs for sibling checkouts.

The new surface keeps the smaller qj.api namespace, uses quantjourney-common-sdk for auth/transport, exposes dynamic qj-api connector clients, and keeps warehouse data-plane concerns in quantjourney-data.