Skip to main content

Thin Python SDK for the Sentinel AI Trading API — 62+ tools via REST

Project description


██╗  ██╗██╗   ██╗██████╗ ███████╗██████╗
██║  ██║╚██╗ ██╔╝██╔══██╗██╔════╝██╔══██╗
███████║ ╚████╔╝ ██████╔╝█████╗  ██████╔╝
██╔══██║  ╚██╔╝  ██╔═══╝ ██╔══╝  ██╔══██╗
██║  ██║   ██║   ██║     ███████╗██║  ██║
╚═╝  ╚═╝   ╚═╝   ╚═╝     ╚══════╝╚═╝  ╚═╝

Hyper-Sentinel

The AI Trading SDK — 62+ tools · 3 venues · 1 API key

Web4: AI agents + crypto infrastructure + zero-trust developer tooling


PyPI Python License Downloads

API Docs · PyPI · Website · GitHub


Quick Start

1. Install

pip install hyper-sentinel

Requires Python 3.10+ — Run python3 --version to check.

2. Launch

sentinel

That's it. On first run, Sentinel prompts you to paste an LLM API key from any supported provider:

Welcome to Sentinel!
Let's get you set up. This only takes 10 seconds.

Step 1 — AI Provider Key (required)

  Paste any API key from a supported provider:
    • Anthropic (Claude)  → console.anthropic.com
    • OpenAI (GPT)        → platform.openai.com
    • Google (Gemini)     → aistudio.google.com  (free tier available)
    • xAI (Grok)          → console.x.ai

  Paste your AI API key: █

Your LLM key is exchanged for a Sentinel API key + secret key. Both are saved locally to ~/.sentinel/. You won't be asked again.

3. Chat

Once authenticated, the AI terminal launches automatically:

⚡ You → What's BTC at?
🛡️  Sentinel
  BTC $83,421 (+1.2%) · Vol $28.4B · MCap $1.65T

⚡ You → Show my HL positions
🛡️  Sentinel
  | Coin | Size | Entry    | PnL      | Leverage |
  |------|------|----------|----------|----------|
  | BTC  | 0.05 | $82,100  | +$66.05  | 10x      |
  | ETH  | 1.2  | $3,840   | -$12.40  | 5x       |

Terminal Commands

Command Description
/status Connection health + account info
/tools List all 62+ available tools
/help Show available commands
/quit Exit terminal
anything else Chat with the AI agent — it has all the tools

Alternative Install Methods

macOS (Homebrew + pipx)

brew install pipx && pipx install hyper-sentinel

macOS / Linux (venv)

python3 -m venv ~/.sentinel && source ~/.sentinel/bin/activate && pip install hyper-sentinel

Python SDK

Use Sentinel programmatically in your own code:

from hyper_sentinel import Sentinel

# Initialize with your API key (from ~/.sentinel/api_key after first run)
client = Sentinel(api_key="sk-sentinel-xxx")

# Chat with AI + 62 tools
response = client.chat("What's the price of BTC?")
print(response)

# Call any tool directly
price = client.get_price("bitcoin")
top = client.get_top_coins(10)
macro = client.get_macro()

# Streaming responses
for token in client.chat("Analyze ETH outlook", stream=True):
    print(token, end="", flush=True)

Trading

# Hyperliquid
positions = client.get_positions()
client.place_order("BTC", "buy", 0.01)                     # market
client.place_order("ETH", "sell", 0.5, price=2000.0)        # limit
client.call("close_hl_position", coin="BTC")

# Aster DEX
client.call("aster_place_order", symbol="BTCUSDT", side="buy", size=0.01)
client.call("aster_set_leverage", symbol="BTCUSDT", leverage=5)

# Polymarket
markets = client.search_markets("election")
client.call("buy_polymarket", token_id="...", amount=10, price=0.65)

Market Data

# Crypto
client.get_price("ethereum")
client.get_top_coins(25)
client.call("get_crypto_chart", coin_id="bitcoin", days=30)
client.get_orderbook("BTC")

# Stocks & ETFs
client.call("get_stock_price", symbol="NVDA")

# Macro Economics
client.get_macro()                                    # GDP, CPI, Fed rate, VIX
client.call("get_fred_series", series_id="GDP")

Intelligence

# News & Sentiment
client.get_news()
client.call("get_news_sentiment", query="bitcoin")
client.call("get_intelligence_reports")

# Social
client.get_trending()
client.call("search_x", query="BTC")
client.call("get_top_mentions")

Call Any Tool

# Generic tool call — works with all 62+ tools
result = client.call("tool_name", param1="value", param2=123)

# List all available tools
tools = client.list_tools()
for tool in tools:
    print(f"{tool['name']}: {tool.get('description', '')}")

How It Works

pip install hyper-sentinel
         │
         ▼
  Your Code (Sentinel SDK)
  api_key = sk-sentinel-xxx
         │
         ▼
┌────────────────────────────┐
│  Go API Gateway            │
│  Auth · Billing · Metering │
│  api.hyper-sentinel.com    │
└────────────┬───────────────┘
             │
┌────────────▼───────────────┐
│  Python Engine (FastAPI)   │
│  62+ tools · 12 scrapers  │
│  HL · Aster · PM · FRED   │
└────────────────────────────┘

Every call is authenticated, metered, and billed through the gateway.


Zero-Trust Architecture

Key Purpose Storage
API Key (sk-sentinel-xxx) Authenticates API calls Server (hashed)
Secret Key (sdg-vault-xxx) Encrypts your config vault Client only
AI Provider Key Forwarded to LLM provider Never stored

Your AI provider keys are forwarded securely and never stored on our servers.


LLM Providers

Provider Prefix Get a Key
Anthropic (Claude) sk-ant- console.anthropic.com
OpenAI (GPT) sk- platform.openai.com
Google (Gemini) AIza aistudio.google.com
xAI (Grok) xai- console.x.ai

Tip: Google Gemini has a free tier — great for getting started.


Pricing

No feature gating. Everyone gets full access. Subscriptions reduce your fees.

Tier Price LLM Markup Trade Fee Rate Limit
Free $0 40% 0.10% / 0.07% 300/min
Pro $100/mo 15% 0.04% / 0.03% 1,000/min
Enterprise $1,000/mo 5% 0.02% / 0.01% 5,000/min

Changelog

v0.5.9 — Auth Header Fix

  • FIX: SDK now sends API key as X-API-Key header (was sending Authorization: Bearer which gateway rejected)
  • FIX: Resolves 401 "invalid x-api-key" errors on all tool calls and chat

v0.5.8 — First-Run Fix

  • FIX: sentinel now prompts for LLM key on first run (was erroring with "run sentinel-setup")
  • FIX: Removed dead sentinel-setup references
  • IMPROVED: Simplified quickstart — just pip install and sentinel

v0.5.0 — Web4 Thin Client

  • BREAKING: SDK is now a thin REST client — all calls go through api.hyper-sentinel.com
  • NEW: Sentinel(api_key="sk-sentinel-xxx") — one-liner setup
  • NEW: client.chat(message, stream=True) — SSE streaming
  • NEW: client.call(tool, **params) — call any of 62+ tools
  • NEW: Secret recovery key for zero-trust config vault
  • REMOVED: All heavy local dependencies (anthropic, openai, etc.)
  • DEPS: httpx, click, rich — 3 total deps

Links

License

AGPL-3.0 — © 2026 Sentinel Labs LLC


Soli Deo Gloria — To the Glory of God alone.

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

hyper_sentinel-0.5.10.tar.gz (123.4 kB view details)

Uploaded Source

Built Distribution

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

hyper_sentinel-0.5.10-py3-none-any.whl (138.0 kB view details)

Uploaded Python 3

File details

Details for the file hyper_sentinel-0.5.10.tar.gz.

File metadata

  • Download URL: hyper_sentinel-0.5.10.tar.gz
  • Upload date:
  • Size: 123.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for hyper_sentinel-0.5.10.tar.gz
Algorithm Hash digest
SHA256 6d38bff6049ee3896e56989e824a4590e159910e9b5f3222799ad40bcf975389
MD5 87523ced05fc0816fa274accd9c015c4
BLAKE2b-256 05a0a821bce5524dcb96670208de4ce2fb53762993d17e7271476a10f66d08a3

See more details on using hashes here.

File details

Details for the file hyper_sentinel-0.5.10-py3-none-any.whl.

File metadata

File hashes

Hashes for hyper_sentinel-0.5.10-py3-none-any.whl
Algorithm Hash digest
SHA256 134980b7913b7e182f5608004cecf2b9362c59c9e045fccf8694d15c9175292b
MD5 b4aaee20401a3f6087d55fb92004337f
BLAKE2b-256 321f4861f8acabad6de836b6553de749a9f0c4febc26dd6d11d4b9f4de7c3ece

See more details on using hashes here.

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