Comprehensive CLI for the Adanos Finance Sentiment API
Project description
adanos-cli
Comprehensive CLI for the Finance Sentiment API at https://api.adanos.org.
The CLI is designed as a reliable workflow tool to retrieve social sentiment for stocks and crypto assets, with machine-readable output for automation.
Data Coverage
The API/CLI currently covers:
- Reddit Stocks
- X/Twitter Stocks
- Polymarket Stocks
- Reddit Crypto
What this means in practice:
- Stock reports aggregate multiple social sources (Reddit + X + Polymarket where available).
- Crypto reports currently use Reddit Crypto endpoints.
- If there are no mentions in the selected window, you can receive a valid response with no rows/no data.
Install
Recommended (PyPI)
python3 -m pip install adanos-cli
If you use pipx:
pipx install adanos-cli
If this returns No matching distribution found, the first PyPI release is not published yet.
Until first public release is available
# requires GitHub access + SSH key to this private repository
python3 -m pip install "git+ssh://git@github.com/alexander-schneider/api.adanos.org.git@main#subdirectory=sdk/cli"
Developer install (local clone)
python3 -m pip install -e sdk/cli
If adanos is not found in your shell
python3 -m adanos_cli --version
python3 -m adanos_cli
Maintainer: Publish to PyPI
Publishing is automated in .github/workflows/publish-sdk.yml (Trusted Publishing):
- triggers on
VERSIONchange (or manual dispatch) - syncs versions into SDK + CLI metadata
- tests and builds
sdk/pythonandsdk/cli - validates package metadata with
twine check - publishes both Python packages to PyPI
Typical release flow:
- bump
VERSION - update
CHANGELOG.md - merge to
main(or trigger workflow manually)
One-time PyPI setup (required before first publish):
- Create
adanos-clion PyPI (or use the existing project if already created). - In PyPI:
Project settings -> Publishing -> Add a new pending publisher. - Set publisher values:
- Owner:
alexander-schneider - Repository:
api.adanos.org - Workflow name:
publish-sdk.yml - Environment name:
pypi
- Owner:
Start Modes
# interactive shell (recommended for humans)
adanos
# force shell mode explicitly
adanos shell
# one-shot command mode
adanos stock TSLA --days 7
Quickstart By Perspective
1) First-time user (no API key yet)
# guided setup
adanos onboard wizard
# or manual setup
adanos onboard register --name "Your Name" --email "you@example.com" --purpose "CLI usage"
adanos onboard redeem --token kt_xxx --save
# first request
adanos ask "How does TSLA look?"
2) Existing user (already has key)
adanos config set --api-key sk_live_xxx
adanos config show
adanos account
adanos ask "How many users mention Microsoft?"
3) Stock sentiment workflow
# deep report for one ticker
adanos stock TSLA --days 7
# compare tickers
adanos ask "TSLA vs NVDA"
# or
adanos compare --platform x-stocks TSLA,NVDA --days 7
# top lists
adanos trending --platform reddit-stocks --dimension main --days 1 --limit 10
4) Crypto sentiment workflow
# single token
adanos crypto BTC --days 7
# pair comparison
adanos crypto BTC/ETH --days 7
# discovery
adanos scan --asset crypto --style daytrader
5) Portfolio/watchlist workflow
adanos watchlist add core --asset stocks --symbols MSFT,AAPL,NVDA
adanos watchlist add core --asset crypto --symbols BTC,ETH
adanos watchlist show core
adanos watchlist report core --asset all --days 7
6) Automation / agent workflow (JSON)
adanos --output json capabilities
adanos --output json endpoint list
adanos --output json ask "How does TSLA look?"
adanos --output json scan --asset stocks --style daytrader
Note: global flags are recommended before subcommands. The CLI also tolerates capabilities --output json style input.
Interactive Shell
Start:
adanos
Behavior:
- Plain text is interpreted as
ask. - Slash-prefixed commands run CLI commands directly.
scanshorthand works:/scan-> defaults to stocks starter scan/scan crypto-> crypto scan
/help,/clear,/exitare built-in shell controls.
Fullscreen and scrollback:
- Default keeps terminal scrollback usable.
- Optional fullscreen mode:
adanos shell --fullscreen
# or via env
ADANOS_CLI_FULLSCREEN=1 adanos shell
Global Flags
Available for all commands:
adanos [--api-key KEY] [--base-url URL] [--output text|json] [--version] <command> ...
--api-key: override configured key for this call--base-url: override API base URL--output: choosetextorjson--version: print version and exit
Complete Command Reference
onboard
adanos onboard
adanos onboard guide
adanos onboard wizard [--json]
adanos onboard register --name NAME --email EMAIL --purpose PURPOSE [--company-name NAME] [--json]
adanos onboard redeem --token kt_xxx [--save] [--json]
config
adanos config set --api-key sk_live_xxx [--base-url URL]
adanos config show
adanos config clear
capabilities
adanos capabilities
adanos --output json capabilities
account
adanos account
adanos account --json
Shows:
- current account plan (
free,hobby,professional) - monthly credits used/remaining (or
unlimitedfor paid plans) - out-of-credits state on free tier
- upgrade options + contact
shell
adanos shell [--fullscreen | --no-fullscreen]
stock
adanos stock TICKER [--days 7] [--json]
crypto
adanos crypto SYMBOL_OR_PAIR [--days 7] [--json]
# examples: BTC, ETH, BTC/ETH
ask
adanos ask "free text question" [--days 7] [--json]
scan
adanos scan --asset {stocks|crypto}
[--style {starter|daytrader|swing|investor}]
[--days N] [--limit N] [--top N]
[--min-buzz X] [--min-volume N] [--min-platforms N]
[--min-sentiment X] [--max-sentiment X]
[--json]
briefing
adanos briefing [--profile {starter|daytrader|swing|investor|crypto|research|portfolio}]
[--days N] [--limit N]
[--stocks CSV] [--crypto CSV]
[--from-watchlist NAME]
[--json]
watchlist
adanos watchlist list [--json]
adanos watchlist show NAME [--json]
adanos watchlist add NAME --asset {stocks|crypto} --symbols CSV [--json]
adanos watchlist remove NAME --asset {stocks|crypto} --symbols CSV [--json]
adanos watchlist delete NAME [--json]
adanos watchlist report NAME [--asset {stocks|crypto|all}] [--days N] [--json]
endpoint
adanos endpoint list [--json]
adanos endpoint call ENDPOINT_ID
[--ticker T] [--symbol S] [--q Q] [--query Q]
[--tickers CSV] [--symbols CSV] [--assets CSV]
[--days N] [--limit N] [--offset N] [--type stock|etf|all]
[--source SOURCE]
[--json]
trending
adanos trending --platform {news-stocks|reddit-stocks|reddit-crypto|x-stocks|polymarket-stocks}
[--dimension {main|sectors|countries|tokens}]
[--days N] [--limit N] [--offset N]
[--type {stock|etf|all}]
[--source SOURCE]
[--json]
search
adanos search --platform {news-stocks|reddit-stocks|reddit-crypto|x-stocks|polymarket-stocks} QUERY [--json]
compare
adanos compare --platform {news-stocks|reddit-stocks|reddit-crypto|x-stocks|polymarket-stocks} ASSETS_CSV [--days N] [--json]
stats
adanos stats --platform {news-stocks|reddit-stocks|reddit-crypto|x-stocks|polymarket-stocks} [--json]
health
adanos health [--platform {all|news-stocks|reddit-stocks|reddit-crypto|x-stocks|polymarket-stocks}] [--json]
Endpoint Coverage Guarantee
adanos endpoint list exposes one CLI endpoint ID per OpenAPI path.
adanos endpoint call <endpoint-id> ... allows direct invocation of every supported OpenAPI endpoint.
Config Resolution Order
- CLI flags (
--api-key,--base-url) - Environment (
ADANOS_API_KEY,ADANOS_BASE_URL) - Local config file (
~/.config/adanos-cli/config.json)
Reliability Recommendations
For the most stable sentiment snapshots:
- Use direct symbols/tickers (
stock,crypto,compare) when possible. - Use broader windows for less-liquid assets (
--days 7or--days 30). - Check service health first if results look stale:
adanos health --platform all
If you hit rate/credit limits:
adanos account
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 adanos_cli-1.19.1.tar.gz.
File metadata
- Download URL: adanos_cli-1.19.1.tar.gz
- Upload date:
- Size: 38.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0cf676eb1bac9fb6d68581a76e037c65078db3de0e1c2e2d0e90ed75b32eaa97
|
|
| MD5 |
bc578a06d6e1cd50bd4864dff048a3d9
|
|
| BLAKE2b-256 |
5dcfeec2f2ae0a450db3505d0b1e7c891c36b5d881c19fe884fabb686ec98fe0
|
Provenance
The following attestation bundles were made for adanos_cli-1.19.1.tar.gz:
Publisher:
publish-sdk.yml on alexander-schneider/api.adanos.org
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
adanos_cli-1.19.1.tar.gz -
Subject digest:
0cf676eb1bac9fb6d68581a76e037c65078db3de0e1c2e2d0e90ed75b32eaa97 - Sigstore transparency entry: 1057495667
- Sigstore integration time:
-
Permalink:
alexander-schneider/api.adanos.org@930dc3e75ba4fb8ad4ca272e90890d07ec6a6ff4 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/alexander-schneider
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-sdk.yml@930dc3e75ba4fb8ad4ca272e90890d07ec6a6ff4 -
Trigger Event:
workflow_run
-
Statement type:
File details
Details for the file adanos_cli-1.19.1-py3-none-any.whl.
File metadata
- Download URL: adanos_cli-1.19.1-py3-none-any.whl
- Upload date:
- Size: 36.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8fd06387b058570a4e7a4d6cdada8bb49675fba2d30dd10bcb66933322667ea5
|
|
| MD5 |
de3976183cb7a53d0ffeb6d88fe9743a
|
|
| BLAKE2b-256 |
506dc222933525acaf62c16abde1f5dfe3c78fcb9965e8e2f947399d922ecce7
|
Provenance
The following attestation bundles were made for adanos_cli-1.19.1-py3-none-any.whl:
Publisher:
publish-sdk.yml on alexander-schneider/api.adanos.org
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
adanos_cli-1.19.1-py3-none-any.whl -
Subject digest:
8fd06387b058570a4e7a4d6cdada8bb49675fba2d30dd10bcb66933322667ea5 - Sigstore transparency entry: 1057495668
- Sigstore integration time:
-
Permalink:
alexander-schneider/api.adanos.org@930dc3e75ba4fb8ad4ca272e90890d07ec6a6ff4 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/alexander-schneider
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-sdk.yml@930dc3e75ba4fb8ad4ca272e90890d07ec6a6ff4 -
Trigger Event:
workflow_run
-
Statement type: