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.2 |
| Git tag | api-v0.1.2 |
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>",
)
# 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.2
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quantjourney_api-0.1.2.tar.gz.
File metadata
- Download URL: quantjourney_api-0.1.2.tar.gz
- Upload date:
- Size: 8.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ad1fbda935f4f2c74bc718985d755dfe0eac761137c2e59c4ad580ed50723104
|
|
| MD5 |
e842212da77cde2f0b0b9ecd3084a8cb
|
|
| BLAKE2b-256 |
63320daecdda1991633fd23884a48841c4b1172951bee66a3998dfc983e88908
|
Provenance
The following attestation bundles were made for quantjourney_api-0.1.2.tar.gz:
Publisher:
publish-api.yml on QuantJourneyOrg/qj-api-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quantjourney_api-0.1.2.tar.gz -
Subject digest:
ad1fbda935f4f2c74bc718985d755dfe0eac761137c2e59c4ad580ed50723104 - Sigstore transparency entry: 2487256567
- Sigstore integration time:
-
Permalink:
QuantJourneyOrg/qj-api-sdk@9ddbbea96f0af55320fb7609157f977c7d851355 -
Branch / Tag:
refs/tags/api-v0.1.2 - Owner: https://github.com/QuantJourneyOrg
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-api.yml@9ddbbea96f0af55320fb7609157f977c7d851355 -
Trigger Event:
push
-
Statement type:
File details
Details for the file quantjourney_api-0.1.2-py3-none-any.whl.
File metadata
- Download URL: quantjourney_api-0.1.2-py3-none-any.whl
- Upload date:
- Size: 8.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5daa005394d7b24c55e4233fbea77748ad0203d93583594bd34b67a32019c8f8
|
|
| MD5 |
b3944681fd1a28a761b0d296da26f13f
|
|
| BLAKE2b-256 |
a5b106590b2f04a000c0e4a9ada26097a5813ae5067023b66d45e82c048ceeb4
|
Provenance
The following attestation bundles were made for quantjourney_api-0.1.2-py3-none-any.whl:
Publisher:
publish-api.yml on QuantJourneyOrg/qj-api-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quantjourney_api-0.1.2-py3-none-any.whl -
Subject digest:
5daa005394d7b24c55e4233fbea77748ad0203d93583594bd34b67a32019c8f8 - Sigstore transparency entry: 2487257670
- Sigstore integration time:
-
Permalink:
QuantJourneyOrg/qj-api-sdk@9ddbbea96f0af55320fb7609157f977c7d851355 -
Branch / Tag:
refs/tags/api-v0.1.2 - Owner: https://github.com/QuantJourneyOrg
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-api.yml@9ddbbea96f0af55320fb7609157f977c7d851355 -
Trigger Event:
push
-
Statement type:
