Build on top of the OIOption Eagle Eye system
A production-oriented REST reference for market data, signal intelligence, risk state, trading execution, account configuration and operational monitoring.
https://oioption.com/app/apiDashboard, market data, risk, trading and monitoring.
https://oioption.com/api/v1Account, 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
API access is available only to users with an active paid subscription. Public flows are limited to login/session bootstrap and basic service checks; market data, signals, risk state and trading execution require an active plan.
If a user has not purchased a plan, or the plan has expired, protected API requests are rejected. Trading APIs require the corresponding quantitative trading entitlement.
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. |
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 | Trading | Trading portfolio data view. |
| GET | /api/data/trading/strategy-signals | Trading | Strategy signal records by strategy/underlying. |
| GET | /api/strategy/status | Trading | Strategy runtime status. |
| GET | /api/strategy/signals | Trading | Recent strategy-level signals. |
Trading Execution
Live execution endpoints. These require quant trading entitlement and are protected by user scoping, risk controls, and audit logging.
14 endpoints
Trading Execution
Live execution endpoints. These require quant trading entitlement and are protected by user scoping, risk controls, and audit logging.
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /api/trading/realtime-price | Trading | Realtime underlying price. |
| GET | /api/trading/sr-levels | Trading | Support/resistance levels. |
| GET | /api/trading/positions | Trading | Scoped open positions. |
| GET | /api/trading/orders/active | Trading | Scoped active orders. |
| GET | /api/trading/orders/recent | Trading | Recent order history. |
| POST | /api/trading/execute/buy-option | Trading | Option buy IOC/taker execution. |
| POST | /api/trading/execute/buy-from-support | Trading | SR support-side execution. |
| POST | /api/trading/execute/sell-from-resistance | Trading | SR resistance-side execution. |
| POST | /api/trading/positions/close-long | Trading | Close scoped long exposure. |
| POST | /api/trading/positions/close-short | Trading | Close scoped short exposure. |
| POST | /api/trading/positions/reduce | Trading | Reduce scoped position by percentage. |
| GET | /api/trading/order-events | Trading | Order execution audit events. |
| GET | /api/trading/option-scan | Trading | Automated option candidate scan. |
| GET | /api/trading/signal-gate/history | 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>"Buy option through IOC/taker execution
curl -X POST https://oioption.com/app/api/trading/execute/buy-option \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{"inst_id":"BTC-20260529-70000-C","side":"buy","n_contracts":0.1,"tolerance_pct":0.05}'Exchange API key setup
OIOption connects to exchanges using official APIs. API keys should use the minimum permission required by the purchased product tier.
Binance
Read info by default; trading permission only if explicitly needed.
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.