OIOption authenticated product API
A production-oriented REST reference for authorized product data, signal intelligence, risk state, account configuration and operational monitoring.
https://oioption.com/app/apiAuthenticated dashboard, market data, risk and monitoring. Trading routes are enterprise-only.
https://oioption.com/api/v1Public market research, account, payment, user API-key configuration and RFQ.
/app/api/* or /api/v1/*Recommended for frontend clients.
The public website, system frontend and API gateway are separated. Browser traffic should use the same-origin paths below.
Authentication
This is a product API, not an unrestricted developer API. Public OIOption market routes expose delayed research observations; account, signal history, risk state and system data require an active plan. Trading connectivity is enterprise-only and requires a separate written scope and review.
If a user has not purchased a plan, or the plan has expired, protected API requests are rejected. Trading endpoints, private deployment, source-code delivery and custom integrations are not standard-subscription entitlements; they require enterprise authorization, technical review and compliance review.
Cookie session
Default browser session for website and dashboard users.
Bearer token
Authorization: Bearer <access_token>Endpoint groups
Public System Flows
Only login/session bootstrap and lightweight health checks are public flows. They do not grant market, signal, risk or trading data access.
6 endpoints
Public System Flows
Only login/session bootstrap and lightweight health checks are public flows. They do not grant market, signal, risk or trading data access.
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /api/ping | Public flow | Lightweight service health check. |
| POST | /api/auth/login | Public flow | Create a browser session after account authentication. |
| POST | /api/auth/exchange-sso | Public flow | Exchange a one-time SSO code for a system session. |
| POST | /api/auth/refresh | Public flow | Refresh an existing access session. |
| GET | /api/auth/session | User | Return current authenticated user and plan scope. |
| POST | /api/auth/logout | User | Clear browser session cookies. |
Market Data
Options, VIX, OHLCV, net-position, visualization and news data used by the dashboard and research workflow.
11 endpoints
Market Data
Options, VIX, OHLCV, net-position, visualization and news data used by the dashboard and research workflow.
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /api/data/options/recent | User | Recent normalized options rows. |
| GET | /api/data/options/statistics | User | Options statistics and summary metrics. |
| GET | /api/data/options/table-counts | User | Data table counts for operational visibility. |
| GET | /api/data/kline/ohlcv | User | OHLCV candles for supported underlyings. |
| GET | /api/data/net-positions/snapshot | User | Latest net-position snapshot. |
| GET | /api/data/net-positions/grid | User | Net-position grid for strike/expiry structure. |
| GET | /api/data/visualization/anomalies | User | Anomaly visualization data. |
| GET | /api/data/visualization/vol-surface | User | Volatility surface data. |
| GET | /api/data/trading/vix/history | User | VIX history records. |
| GET | /api/data/trading/vix/signal/latest | User | Latest VIX-derived signal. |
| GET | /api/data/news/recent | User | Recent macro and market news context. |
Public OIOption Market API
Public, delayed research endpoints used by the OIOption marketing site. These routes expose market observations only; they do not grant account, order or trading access.
11 endpoints
Public OIOption Market API
Public, delayed research endpoints used by the OIOption marketing site. These routes expose market observations only; they do not grant account, order or trading access.
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /api/v1/market/options/meta | Public flow | Supported underlyings, option types, sort modes, source weights and venue heartbeat metadata. |
| GET | /api/v1/market/options/summary?underlying=BTC | Public flow | Aggregated BTC/ETH option summary with asOf, ATM IV, total OI, 24h volume, source coverage and stale-row count. |
| GET | /api/v1/market/options/snapshot?underlying=BTC&type=all&expiry=all&sortBy=oi&hideStale=false&limit=1500 | Public flow | Aggregated option chain rows with bid/ask/mark, IV, Greeks, openInterest, volume24h, spreadPct, updatedAt and stale. |
| GET | /api/v1/market/options/stream?underlying=BTC&type=all&expiry=all&sortBy=oi&hideStale=false&limit=1500 | Public flow | Server-sent event stream for the same aggregated option snapshot filters. |
| GET | /api/v1/market/kline/ohlcv?symbol=BTC&timeframe=1h&limit=120&exchange=okx | Public flow | Public OHLCV candles with asOf, cached and stale indicators. |
| GET | /api/v1/market/search-trends?geo=US,GB | Public flow | Public search-interest trend observations for supported geographies. |
| GET | /api/v1/market/equity/options-universe | Public flow | Validated US-equity option universe and capability metadata. |
| GET | /api/v1/market/equity/options-chain?symbol=SPY&limit=20000 | Public flow | Delayed US-equity option chain; numeric fields include an observation quality marker. |
| GET | /api/v1/market/equity/market-summary | Public flow | Delayed QQQ/SPY/DIA benchmark regime summary with coverage and option breadth. |
| GET | /api/v1/market/equity/options-turnover-breadth | Public flow | Delayed top-symbol option turnover, OI and session-volume breadth summary. |
| GET | /api/v1/onchain-whale/public | Public flow | Public delayed BTC/ETH whale-rank flow research payload. |
Signals & Decisions
Signal history, doomsday options evaluation, Eagle fusion decision output, and strategy signal records.
9 endpoints
Signals & Decisions
Signal history, doomsday options evaluation, Eagle fusion decision output, and strategy signal records.
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /api/data/signals/recent | User | Recent signal events. |
| GET | /api/data/signals/history | User | Signal history series. |
| GET | /api/data/signals/doomsday/evaluate | User | Doomsday options signal evaluation. |
| GET | /api/data/signals/doomsday/history | User | Historical doomsday signal rows. |
| GET | /api/data/eagle-decision/fusion | User | Eagle decision fusion output. |
| GET | /api/data/trading/portfolio | Enterprise trading | Trading portfolio data view. |
| GET | /api/data/trading/strategy-signals | Enterprise trading | Strategy signal records by strategy/underlying. |
| GET | /api/strategy/status | Enterprise trading | Strategy runtime status. |
| GET | /api/strategy/signals | Enterprise trading | Recent strategy-level signals. |
Trading Execution
Enterprise-only live execution endpoints. These are not a public developer API and require separate written scope, technical review, compliance review, user scoping, risk controls and audit logging.
14 endpoints
Trading Execution
Enterprise-only live execution endpoints. These are not a public developer API and require separate written scope, technical review, compliance review, user scoping, risk controls and audit logging.
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /api/trading/realtime-price | Enterprise trading | Realtime underlying price. |
| GET | /api/trading/sr-levels | Enterprise trading | Support/resistance levels. |
| GET | /api/trading/positions | Enterprise trading | Scoped open positions. |
| GET | /api/trading/orders/active | Enterprise trading | Scoped active orders. |
| GET | /api/trading/orders/recent | Enterprise trading | Recent order history. |
| POST | /api/trading/execute/buy-option | Enterprise trading | Option buy IOC/taker execution. |
| POST | /api/trading/execute/buy-from-support | Enterprise trading | SR support-side execution. |
| POST | /api/trading/execute/sell-from-resistance | Enterprise trading | SR resistance-side execution. |
| POST | /api/trading/positions/close-long | Enterprise trading | Close scoped long exposure. |
| POST | /api/trading/positions/close-short | Enterprise trading | Close scoped short exposure. |
| POST | /api/trading/positions/reduce | Enterprise trading | Reduce scoped position by percentage. |
| GET | /api/trading/order-events | Enterprise trading | Order execution audit events. |
| GET | /api/trading/option-scan | Enterprise trading | Automated option candidate scan. |
| GET | /api/trading/signal-gate/history | Enterprise trading | Signal gate decision history. |
Risk & Controls
Risk control state, circuit breakers, tactical controls, global hedge status, and emergency shutdown.
13 endpoints
Risk & Controls
Risk control state, circuit breakers, tactical controls, global hedge status, and emergency shutdown.
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /api/risk/strategy-controller/status | User | Per-user strategy controller status. |
| POST | /api/risk/strategy-controller/toggle | User | Enable/disable user strategy controller. |
| GET | /api/risk/controls/status | User | Risk control status. |
| POST | /api/risk/controls/toggle | Admin | Toggle global risk controls. |
| GET | /api/risk/circuit-breaker/status | User | Circuit breaker state. |
| POST | /api/risk/circuit-breaker/reset | User | Reset user circuit breaker state. |
| GET | /api/risk/tactical-cb/status | User | Tactical circuit breaker state. |
| GET | /api/risk/vix/status | User | VIX factor status. |
| GET | /api/risk/systemic/status | User | Systemic risk state. |
| GET | /api/risk/global-hedge/status | User | Global hedge status. |
| GET | /api/risk/emergency/status | User | Emergency shutdown status. |
| POST | /api/risk/emergency/trigger | Admin | Trigger emergency shutdown. |
| POST | /api/risk/emergency/reset | Admin | Reset emergency shutdown. |
System & Configuration
System status, monitoring, scheduler visibility, configuration and credential metadata.
12 endpoints
System & Configuration
System status, monitoring, scheduler visibility, configuration and credential metadata.
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /api/system/health | User | System health view with role-based redaction. |
| GET | /api/system/stats | User | System statistics. |
| GET | /api/system/control-plane | User | Control-plane snapshot. |
| GET | /api/system/exchange-status | User | Exchange connection and freshness status. |
| POST | /api/system/cache/clear | Admin | Clear cache by feature. |
| GET | /api/monitor/scheduler/status | User | Scheduler status. |
| GET | /api/monitor/scheduler/tasks | User | Scheduler task list. |
| GET | /api/monitor/signal-modules/status | User | Signal module health. |
| GET | /api/config/me/credentials | User | Current user credential metadata, never raw secrets. |
| GET | /api/config/strategies | Admin | Strategy configuration summary. |
| GET | /api/config/signals | Admin | Signal configuration. |
| POST | /api/config/signals | Admin | Update signal configuration. |
Landing Account API
Account and license surfaces used to enter the Eagle Eye system and manage exchange API-key metadata.
6 endpoints
Landing Account API
Account and license surfaces used to enter the Eagle Eye system and manage exchange API-key metadata.
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| POST | /api/v1/auth/login | Public flow | Landing account login. |
| POST | /api/v1/auth/generate-sso-code | User | Generate one-time SSO code for system entry. |
| GET | /api/v1/user/dashboard | User | Dashboard account/license status. |
| POST | /api/v1/user/api-settings | User | Save encrypted exchange API credentials. |
| GET | /api/v1/user/api-settings | User | List masked exchange API settings. |
| POST | /api/v1/user/test-connection | User | Test exchange API credentials. |
Request examples
Login and create browser session
curl -X POST https://oioption.com/app/api/auth/login \
-H "Content-Type: application/json" \
-d '{"email":"desk@example.com","password":"********"}'Read recent signal events
curl https://oioption.com/app/api/data/signals/recent?limit=50 \
-H "Authorization: Bearer <access_token>"Read public aggregated option data
curl "https://oioption.com/api/v1/market/options/snapshot?underlying=BTC&type=all&expiry=all&sortBy=oi&hideStale=false&limit=1500" \
-H "Accept: application/json"Exchange API key setup
OIOption connects to exchanges using official APIs. Use read-only keys by default. Trading keys are never required for public research and are only permitted under an explicitly approved enterprise workflow. Withdrawal permission is never required.
OKX
Read-only by default. Trading permission is restricted to an explicitly approved workflow. Never enable Withdraw.
Deribit
Read for analytics. Use read_write only under an explicitly approved enterprise trading workflow.
Binance
Read info by default. Trading permission requires explicit product authorization.
Rate limits & errors
All APIs are protected by rate limits. If the request frequency exceeds the limit, the API returns an error response. Reduce request frequency before retrying.
Trading APIs are live-money surfaces. Human operators should control global switches and strategy switches; strategy execution itself is automated and must be governed by risk controls, audit logs and exchange-side API permissions.