Convexity Docs

Everything you need to get started with the financial intelligence terminal. Quickstart guide, terminal commands, and full reference.

Getting Started

Get up and running with Convexity in under five minutes. Follow the steps below to create your account, explore the dashboard, and start using the platform.

1

Create an Account

Sign up at convexityos.com/login. The free tier is available immediately with no credit card required. You will have access to real-time market data, watchlists, market breadth, and yield curve tracking right away.

2

Dashboard Overview

Your home base. The dashboard shows your portfolio snapshot, live market indices, AI-powered analysis summaries, and today's top movers. Everything updates in real time so you always have a current view of the market.

Terminal (CLI)

Convexity includes a built-in command-line interface for power users. Access it via the sidebar under Terminal.

Tip
Type help in the terminal to see all available commands and their descriptions.
convexity ~ help

Available commands:
  quote       Get real-time quote for a symbol
  quotes      Multi-symbol quotes
  indices     Major index snapshot
  history     Price history for a symbol
  search      Search for tickers by name
  news        Latest news for a symbol
  portfolio   View your portfolio holdings
  watchlist   View your watchlist
  ai          Ask the AI assistant
  scan        Market scanner with filters
  earnings    Upcoming earnings this week
  insider     Recent insider trades
  movers      Today's top market movers
  clear       Clear terminal screen

convexity ~  

Commands Reference

CommandDescription
quote AAPLGet real-time quote for a symbol
quotes AAPL,MSFT,GOOGMulti-symbol quotes, comma-separated
indicesMajor index snapshot (SPY, QQQ, DIA, IWM)
history AAPL 30Price history for a symbol (default 30 days)
search querySearch for tickers by company name
news AAPLLatest news headlines for a symbol
portfolioView your portfolio holdings
watchlistView your watchlist
ai questionAsk the AI assistant a question
scan --sector technology --signal bullishMarket scanner with sector and signal filters
earningsUpcoming earnings this week
insider AAPLRecent insider trades for a symbol
moversToday's top market movers
whoamiDisplay current user info
statusSystem status and health check
clearClear terminal screen
versionShow terminal version

Terminal Keyboard Shortcuts

Navigate efficiently within the terminal using these shortcuts:

ShortcutAction
/ Cycle through command history
TabAutocomplete command or argument
Ctrl + LClear terminal screen

Example Session

convexity ~ quote NVDA

NVDA — NVIDIA Corporation
─────────────────────────────────
  Price:    $924.18
  Change:   +$36.58 (+4.12%)
  Volume:   62.1M
  Mkt Cap:  $2.28T
  P/E:      68.4
  52w Hi:   $974.00
  52w Lo:   $473.20

convexity ~ ai What is gamma exposure and why does it matter?

AI RESPONSE
─────────────────────────────────
Gamma exposure (GEX) measures how much options dealers need
to hedge when the underlying price moves. High positive GEX
typically suppresses volatility as dealers buy dips and sell
rallies. Negative GEX amplifies moves and can lead to rapid
directional swings. Tracking GEX helps identify potential
support/resistance levels and volatility regimes.

convexity ~  

Portfolio

Track your investments with real-time updates and AI-powered insights.

Adding Positions

Navigate to the Portfolio page from the sidebar. Add holdings by entering the ticker symbol, number of shares, and your cost basis. Positions update in real time as market prices change.

Tracking

The portfolio view provides real-time P&L calculations, portfolio attribution analysis, and sector allocation breakdowns. See exactly which positions are driving your returns and how your sector exposure compares to major indices.

Analysis

Use the AI-powered portfolio review for a comprehensive risk assessment. The analysis covers concentration risk, sector exposure, correlation analysis, and suggestions for portfolio optimization.

Export

Download your holdings and performance data as CSV for use in spreadsheets or other tools. Export includes cost basis, current value, unrealized P&L, and percentage returns.

AI Assistant

Convexity includes an AI assistant powered by Gemini 2.0 Flash with fallback to local LLM for offline operation. Access it from the sidebar or via the ai terminal command.

Three Modes

  • Chat — Ask any financial question. The assistant has context on market conditions, economic data, and investment concepts.
  • Market Brief — Enter a ticker symbol to receive an AI-generated market summary covering price action, technicals, fundamentals, and relevant news.
  • Portfolio Analysis — Get a comprehensive AI analysis of your holdings including risk assessment, diversification review, and actionable recommendations.
Offline Mode
The AI assistant supports local LLM fallback via Ollama. Set up Ollama on your machine to get AI insights even without an internet connection.

Market Data

Access real-time and historical market data across equities, indices, and crypto.

Quotes

Real-time streaming quotes delivered via WebSocket. See price, change, volume, market cap, P/E, and 52-week range at a glance. Data refreshes automatically without page reload.

Screener

Filter stocks by market cap, P/E ratio, volume, sector, and technical signals. Build custom screens to find stocks matching your criteria and save them for quick access.

Indices

Track major indices including SPY, QQQ, DIA, IWM, and VIX. See real-time performance, intraday charts, and historical trends to monitor broad market conditions.

Crypto

Monitor Bitcoin, Ethereum, and the top 20 cryptocurrencies by market cap. See real-time prices, 24h change, volume, and market dominance metrics.

Options Intelligence

Institutional-grade options analytics to understand positioning and flow.

Options Flow

Track unusual options activity and large block trades as they happen. Filter by premium, volume, open interest, and sentiment to identify significant bets being placed by institutional traders.

Gamma Exposure (GEX)

Visualize dealer gamma positioning to understand expected support and resistance levels. See where options market makers are likely to buy or sell the underlying, creating pin levels and potential reversal zones.

Options Matrix

Full options chain visualization with Greeks (Delta, Gamma, Theta, Vega, Rho) for every strike and expiration. Identify mispriced options and unusual spreads at a glance.

Commitments of Traders (COT)

Futures positioning data from the CFTC Commitments of Traders report. See how commercials, large speculators, and small speculators are positioned across major futures markets.

Smart Money Tracking

Follow the money. Track what institutions, insiders, and whales are doing with their portfolios.

SEC Filings

Browse 10-K, 10-Q, 8-K, and 13F filings directly from SEC EDGAR. Full-text search across filings with automated parsing for key financial data and material disclosures.

Insider Trades

Track insider buying and selling activity with clustering signals. When multiple insiders at the same company buy within a short timeframe, the clustering indicator highlights it as a potential conviction signal.

Whale Watch

Monitor institutional portfolio changes via quarterly 13F filings. See which stocks the largest hedge funds and asset managers are buying, selling, and initiating new positions in.

Macro & Economics

Comprehensive macroeconomic data and analysis tools for understanding the big picture.

FRED Integration

Search and visualize 800,000+ economic data series from the Federal Reserve Economic Data database. GDP, unemployment, inflation, housing starts, retail sales, and hundreds of thousands more series with full historical data.

Fed Watch

Track FOMC decisions, the dot plot, and rate probabilities. Understand what the market is pricing in for future rate moves and compare to historical policy paths.

National Debt

Real-time U.S. debt clock with CBO projections. Visualize debt-to-GDP trends, interest expense as a percentage of revenue, and long-term fiscal trajectory scenarios.

Geopolitical

Global risk monitoring covering trade policy, sanctions, geopolitical tensions, and their potential market impact. Stay informed on macro events that could move markets.

API Reference ENTERPRISE

Enterprise users get full REST API access to build custom integrations, dashboards, and automated trading workflows.

Base Configuration

Base URLhttps://convexityos.com/api/
AuthBearer token (JWT)
FormatJSON or MsgPack
Rate LimitsConfigurable per plan

Authentication

# Include your JWT token in the Authorization header
curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://convexityos.com/api/market/quote/AAPL

Example Endpoints

GET /api/market/quote/{symbol}
GET /api/market/indices
GET /api/flow/unusual
POST /api/terminal/execute

Example Response

{
  "symbol": "AAPL",
  "price": 198.42,
  "change": 4.56,
  "changePercent": 2.35,
  "volume": 89200000,
  "marketCap": 3080000000000,
  "pe": 31.2,
  "week52High": 213.95,
  "week52Low": 164.08,
  "timestamp": "2026-04-12T16:00:00Z"
}

Keyboard Shortcuts

Global keyboard shortcuts available throughout the application.

ShortcutAction
Ctrl + KOpen command palette / search
Ctrl + /Open terminal
Ctrl + BToggle sidebar
Ctrl + DGo to dashboard
Ctrl + PGo to portfolio
Ctrl + Shift + AOpen AI assistant
EscClose modal / overlay
?Show keyboard shortcuts help

FAQ

How do I change my password?
Navigate to your Profile settings from the sidebar. You can update your password, display name, and notification preferences from the settings page.
Can I use a local AI model?
Yes. Convexity supports local LLM inference via Ollama. Install Ollama on your machine, pull a model, and Convexity will automatically detect and use it as a fallback when the cloud AI is unavailable or for fully offline operation.
Is there a mobile app?
The web application is fully responsive and works well on mobile devices. A native iOS and Android app is currently in development and coming soon.
How do I report a bug?
Email hello@convexityos.com with a description of the issue, steps to reproduce, and any screenshots. We typically respond within 24 hours.
What data sources does Convexity use?
Convexity aggregates data from institutional-grade sources including SEC EDGAR, FRED, Yahoo Finance, CBO, CBOE, Treasury.gov, and others. All data is real — no synthetic or mock data is ever used.
How do I access the API?
API access is available on the Enterprise plan. Contact hello@convexityos.com for pricing and to receive your API credentials.