CLI for the QuantGist macro event API — qgist events today
Project description
qgist
Command-line interface for the QuantGist macro event API. Check upcoming economic events, export historical data, and configure your key — all from the terminal.
The PyPI package is qgist-cli; it installs the qgist command.
Install
pip install qgist-cli
# or (recommended — installs as an isolated tool)
uv tool install qgist-cli
Quick start
# 1. Set your API key (get one free at quantgist.com/signup)
qgist config set api-key qg_live_your_key_here
# 2. Check today's events
qgist events
# 3. Check this week's high-impact events
qgist events week --impact high
Commands
qgist events [today|week]
Show upcoming macro events in a formatted table.
Usage: qgist events [PERIOD] [OPTIONS]
Arguments:
PERIOD today (default) | week
Options:
-s, --symbol TEXT Filter by symbol (e.g. XAUUSD)
-c, --country TEXT ISO country code (e.g. us, eu, gb)
-i, --impact TEXT Impact filter: low | medium | high
--json Output raw JSON
Examples:
qgist events # Today, all impacts
qgist events week # Next 7 days
qgist events week --impact high # This week, high-impact only
qgist events today --country us # Today, US events
qgist events today --symbol XAUUSD # Today, Gold-affecting events
qgist events today --json # Raw JSON output
# Example output:
# ┌──────────────┬────────┬─────────┬──────────────────────────────┬──────────┬──────────┬────────┐
# │ Time (UTC) │ Impact │ Country │ Event │ Forecast │ Previous │ Actual │
# ├──────────────┼────────┼─────────┼──────────────────────────────┼──────────┼──────────┼────────┤
# │ 08:30 │ HIGH │ US │ Non-Farm Payrolls │ 185K │ 175K │ — │
# │ 10:00 │ HIGH │ US │ ISM Manufacturing PMI │ 48.5 │ 47.8 │ — │
# └──────────────┴────────┴─────────┴──────────────────────────────┴──────────┴──────────┘
qgist config set|get|show
Manage your API key and settings stored at ~/.config/qgist/config.toml.
Usage: qgist config set KEY VALUE
qgist config get KEY
qgist config show
Examples:
qgist config set api-key qg_live_abc123
qgist config get api-key
# api-key = qg_live_abc*****
qgist config show
# ╭── QuantGist Config ──────────────────╮
# │ api-key = qg_live_abc***** │
# │ base-url = https://api.quantgist.com │
# ╰──────────────────────────────────────╯
Config file location: ~/.config/qgist/config.toml
qgist export <keyword>
Export historical events matching a keyword to CSV or JSON.
Usage: qgist export KEYWORD [OPTIONS]
Arguments:
KEYWORD Keyword to search (e.g. nfp, cpi, fomc)
Options:
--from TEXT Start date (YYYY-MM-DD), default 30 days ago
--to TEXT End date (YYYY-MM-DD), default today
--format TEXT csv (default) | json
--output TEXT Output file path (default: stdout)
Examples:
qgist export nfp # NFP events, last 30 days, CSV to stdout
qgist export cpi --from 2024-01-01 --to 2024-12-31 --format json
qgist export fomc --output fomc_history.csv
qgist status
Check your connection and API key status.
qgist status
# ╭─ QuantGist Status ──────────────────────────────╮
# │ Connection ✓ Connected │
# │ API Key qg_live_abc***** (active) │
# │ Plan free │
# │ Rate limit 47 / 100 remaining today │
# ╰─────────────────────────────────────────────────╯
Configuration
The CLI stores settings in ~/.config/qgist/config.toml:
api-key = "qg_live_..."
base-url = "https://api.quantgist.com/v1"
Environment variable override — set QUANTGIST_API_KEY to bypass the config file:
export QUANTGIST_API_KEY=qg_live_...
qgist events
Free API key
quantgist.com/signup — 100 calls/day, 365-day history. No credit card.
License
MIT
Project details
Release history Release notifications | RSS feed
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 qgist_cli-0.1.0.tar.gz.
File metadata
- Download URL: qgist_cli-0.1.0.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
55ba3473e3ada294ee3d82ab8c4a4eb084fd157dc80e0e607017f622daf07f4d
|
|
| MD5 |
7ca00b5d9f74c94132a624654f94bc03
|
|
| BLAKE2b-256 |
bbf0b3d9a669ea7eb56f69e952fb79425ec4d3ee8b5569f365946708e58adbf1
|
Provenance
The following attestation bundles were made for qgist_cli-0.1.0.tar.gz:
Publisher:
ci.yml on QuantGist-Technologies/quantgist-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qgist_cli-0.1.0.tar.gz -
Subject digest:
55ba3473e3ada294ee3d82ab8c4a4eb084fd157dc80e0e607017f622daf07f4d - Sigstore transparency entry: 1999079268
- Sigstore integration time:
-
Permalink:
QuantGist-Technologies/quantgist-cli@c4747744199fa84f3124f7c82a54d8cd0e908c4c -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/QuantGist-Technologies
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@c4747744199fa84f3124f7c82a54d8cd0e908c4c -
Trigger Event:
push
-
Statement type:
File details
Details for the file qgist_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: qgist_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0652fb35e608dbf2344e0a9261a31525cb46725cf35bc3247ce9d20e751c1baf
|
|
| MD5 |
b07805dd22ac3a1aafce5bffbcc71173
|
|
| BLAKE2b-256 |
03a57c47d204479a9bfe8242b9d77d88461655a94e05e3412030b4d395e835a4
|
Provenance
The following attestation bundles were made for qgist_cli-0.1.0-py3-none-any.whl:
Publisher:
ci.yml on QuantGist-Technologies/quantgist-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qgist_cli-0.1.0-py3-none-any.whl -
Subject digest:
0652fb35e608dbf2344e0a9261a31525cb46725cf35bc3247ce9d20e751c1baf - Sigstore transparency entry: 1999079622
- Sigstore integration time:
-
Permalink:
QuantGist-Technologies/quantgist-cli@c4747744199fa84f3124f7c82a54d8cd0e908c4c -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/QuantGist-Technologies
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@c4747744199fa84f3124f7c82a54d8cd0e908c4c -
Trigger Event:
push
-
Statement type: