Skip to main content

Python SDK for QuantJourney qj-api product contracts.

Project description

quantjourney-api

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

Canonical package metadata:

Field Value
Repository _repo_qj_api_sdk
Distribution quantjourney-api
Python import qj.api
Runtime client QJ
Backend boundary qj-api / https://api.quantjourney.cloud
Version 0.1.1
Git tag api-v0.1.1

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)

# 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.

Environment variables:

Variable Purpose
QJ_API_URL qj-api base URL, default https://api.quantjourney.cloud
QJ_API_TOKEN bearer token
QJ_AUTH_URL qj-auth base URL for token exchange
QJ_API_KEY QJ_live_* API key used to mint QJ_API_TOKEN
QJ_API_CLIENT_ID service account client id for client_credentials
QJ_API_CLIENT_SECRET QJ_svc_* service secret for client_credentials
QJ_API_TENANT_ID optional tenant projection
QJ_API_TEAM_ID optional team projection

Install from PyPI:

pip install quantjourney-api==0.1.1

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quantjourney_api-0.1.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quantjourney_api-0.1.1-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file quantjourney_api-0.1.1.tar.gz.

File metadata

  • Download URL: quantjourney_api-0.1.1.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for quantjourney_api-0.1.1.tar.gz
Algorithm Hash digest
SHA256 72b7e5542a97eb326b39e3cf26e28bc20dfdd41b9194dc6862636d3a27e81fd4
MD5 c3e122156cf0ee1fb60264e90687bfe8
BLAKE2b-256 3bccf8b56457b4fbd543c207024d3640154f6cbd50414f51b4a5e14c358052ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for quantjourney_api-0.1.1.tar.gz:

Publisher: publish-api.yml on QuantJourneyOrg/qj-api-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quantjourney_api-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for quantjourney_api-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bab2590df06ac7cfc5945bda27c8fea07d1ddcacf0f87c5eb724b6d70812246e
MD5 b05557b02fc7fa02cc9b48c821035c83
BLAKE2b-256 b934a5316d78cb7557c92c30b19cd416c79a605e31494fad2e743dd990884964

See more details on using hashes here.

Provenance

The following attestation bundles were made for quantjourney_api-0.1.1-py3-none-any.whl:

Publisher: publish-api.yml on QuantJourneyOrg/qj-api-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page