Perspicium Public API v0
Unlock institutional-grade options intelligence and quantitative analytics. Integrate real-time expected moves, IV surfaces, and dealer positioning flows directly into your research notebooks, proprietary trading tools, and execution workflows.
Core Capabilities
- ● Real-time Greeks: Instant GEX, DEX, and Vanna/Charm exposure profiles.
- ● Quant Engine: Market memory matching, portfolio optimization, and risk modeling.
- ● Market Intel: Unusual options activity (UOA) and expected move bands.
Quickstart
# Test connectivity with your API key
curl -H "Authorization: ApiKey YOUR_KEY" \
"https://perspicium.com/api/v0/ping"
# Get expected move for SPY
curl -H "Authorization: ApiKey YOUR_KEY" \
"https://perspicium.com/api/v0/options/expected-move?ticker=SPY"
Authentication
Perspicium uses API keys for authentication. You can generate and rotate your keys in your Account Dashboard.
Supported Headers
- Authorization: ApiKey
- Authorization: Bearer
- X-API-Key:
Error Responses
{
"success": false,
"error": {
"code": "invalid_api_key",
"message": "API key invalid"
}
}
Rate Limits
| Scope | Daily Limit | Monthly Limit |
|---|---|---|
| Default Tier | 10 requests | 100 requests |
| Ping / Health | Burst limit: 60 per minute | |
| Analytics Tier | Burst limit: 30 per minute | |
Standard
/api/v0/ping
Health Check
curl -H "Authorization: ApiKey YOUR_KEY" \
"https://perspicium.com/api/v0/ping"
{ "success": true, "data": { "status": "ok" } }
Options Intelligence
/api/v0/options/expected-move
Expected Move Bands
Query Parameters
ticker
Underlying asset symbol.
Example: SPY
range_pct
Percentage window for strike search (default 1.0).
Example: 1.0
curl -H "Authorization: ApiKey YOUR_KEY" \
"https://perspicium.com/api/v0/options/expected-move?ticker=SPY&range_pct=1.0"
{
"success": true,
"data": {
"ticker": "SPY",
"spot": 522.41,
"term": [
{ "expiry": "2024-04-19", "move": 5.42, "upper": 527.83, "lower": 516.99 }
]
}
}
/api/v0/options/iv
Implied Volatility Surface
Query Parameters
ticker
Symbol for which to fetch IV term and smile.
Example: SPX
range_pct
Filter strikes within X% of spot (default 0.15).
Example: 0.15
curl -H "Authorization: ApiKey YOUR_KEY" \
"https://perspicium.com/api/v0/options/iv?ticker=SPX&range_pct=0.15"
{
"success": true,
"data": {
"ticker": "SPX",
"smile": [
{ "strike": 5200, "iv": 0.142, "expiry": "2024-05-17" }
],
"term": [
{ "expiry": "2024-04-19", "atm_iv": 0.125 }
]
}
}
/api/v0/options/uoa
Unusual Options Activity
Query Parameters
ticker
Filter for a specific symbol.
Example: TSLA
include_0dte
Include zero-days to expiration (default false).
Example: true
limit
Maximum number of trades to return (max 100).
Example: 50
curl -H "Authorization: ApiKey YOUR_KEY" \
"https://perspicium.com/api/v0/options/uoa?ticker=TSLA&include_0dte=true&limit=50"
{
"success": true,
"data": {
"ticker": "TSLA",
"trades": [
{ "strike": 180, "type": "CALL", "volume": 5200, "details": "Sweep" }
]
}
}
Dealer Flows (Greeks)
/api/v0/greeks/gex
Gamma Exposure Profile
Query Parameters
ticker
Underlying symbol.
Example: SPY
basis
Aggregate by open_interest or volume.
Example: open_interest
expiration
Filter to specific expiry (multiples allowed).
Example: 2024-06-21
curl -H "Authorization: ApiKey YOUR_KEY" \
"https://perspicium.com/api/v0/greeks/gex?ticker=SPY&basis=open_interest&expiration=2024-06-21"
{
"success": true,
"data": {
"ticker": "SPY",
"zero_level": 521.8,
"series": {
"net": [ { "strike": 520, "value": 4.2e9 } ]
}
}
}
Quantitative Engine
/api/v0/quant/risk
Risk & Performance
Query Parameters
ticker
Asset symbol.
Example: NVDA
benchmark
Benchmark for beta/alpha (default SPY).
Example: SPY
period
Timeframe for analysis.
Example: 5y
curl -H "Authorization: ApiKey YOUR_KEY" \
"https://perspicium.com/api/v0/quant/risk?ticker=NVDA&benchmark=SPY&period=5y"
{
"success": true,
"data": {
"ticker": "NVDA",
"summary": { "beta": 1.42, "sharpe": 2.1 }
}
}
/api/v0/quant/market-memory
Memory Pattern Matching
Query Parameters
ticker
Core asset for pattern detection.
Example: SPY
kernel_size
Window length for lookup.
Example: 30
similarity
Metric: cosine or euclidean.
Example: cosine
curl -H "Authorization: ApiKey YOUR_KEY" \
"https://perspicium.com/api/v0/quant/market-memory?ticker=SPY&kernel_size=30&similarity=cosine"
{
"success": true,
"data": {
"matches": [
{ "score": 0.98, "trailing_prices": { ... } }
]
}
}