Technical Documentation
Exchange API setup guide & system interface reference
System Overview
The OIOption Eagle Eye system connects to major exchanges via their official APIs to provide real-time options and derivatives market monitoring, analysis, and decision support. This guide will help you obtain exchange API keys and get started.
Data Sources
The system fetches options quotes, open interest, and trade data through official exchange APIs — all data comes from verified public endpoints
Supported Exchanges
Currently supports Deribit, OKX, and Binance — covering BTC/ETH and other major crypto options data
Data Freshness
Automated 24/7 data collection with typically < 5s latency, ensuring you always have the latest market information
Security
All API keys are stored with AES-256 encryption. The system only requires read-only access — no fund operations involved
Exchange API Setup Guide
Before using the Eagle Eye system, you need to create API keys on the exchanges you want to monitor. Follow the steps below for each exchange:
- 1Log in to OKX, go to "Profile" → "API"
- 2Click "Create API Key", set a label (e.g., "OIOption")
- 3Permissions: check "Read Only" — do NOT enable "Trade" or "Withdraw"
- 4Set a Passphrase (remember it — required for configuration)
- 5Bind IP address (optional but recommended for security)
- 6Save your API Key, Secret Key, and Passphrase
https://www.okx.com/account/my-apiDeribit
Official Docs- 1Log in to Deribit, go to "My Account" → "API" tab
- 2Click "+ Add new key" to create a new API key
- 3Set scope to "read" (use "read_write" only if trading)
- 4Select the sub-account scope for monitoring
- 5The system will display Client ID and Client Secret
- 6Save the Client Secret immediately (shown only once)
https://www.deribit.com/main#/account?tab=apiBinance
Official Docs- 1Log in to Binance, go to "Account" → "API Management"
- 2Enter a label (e.g., "OIOption"), click "Create API"
- 3Complete security verification (email + 2FA)
- 4Permissions: enable "Read Info" only — disable "Spot Trading" and "Withdrawals"
- 5(Recommended) Set IP restriction to allow only your server IP
- 6Save the API Key and Secret Key (Secret shown only at creation)
https://www.binance.com/en/my/settings/api-managementAPI Permission Guide
To ensure the security of your funds, please configure API keys with the following permission guidelines:
Fetch account info, positions, and order history. Core features like monitoring, net position analysis, and signal detection all depend on this permission.
Place, cancel, or modify orders. Only needed if you use the quantitative trading features. Pure monitoring users do not need this.
The system does not need and will never use withdrawal access. Always keep this disabled to prevent fund loss even if keys are compromised.
Bind your API keys to specific server IPs. Even if keys are leaked, they cannot be used from unauthorized IPs.
System Data API
The Eagle Eye system provides RESTful API endpoints. After login, all requests are authenticated via JWT tokens. Below are the main data endpoints:
| Endpoint | Method | Description | Auth |
|---|---|---|---|
/api/ping | GET | System health check | None |
/api/auth/login | POST | User login, obtain JWT token | None |
/api/data/options/recent | GET | Get recent options data | Bearer |
/api/data/options/statistics | GET | Get options statistics overview | Bearer |
/api/data/signals/recent | GET | Get recent signal events | Bearer |
/api/data/net-positions/snapshot | GET | Get net position snapshot | Bearer |
/api/data/net-positions/grid | GET | Get net position grid data | Bearer |
/api/data/eagle-decision/fusion | GET | Get Eagle fusion analysis results | Bearer |
/api/data/visualization/anomalies | GET | Get anomaly data (visualization) | Bearer |
/api/data/kline/ohlcv | GET | Get K-line / OHLCV data | Bearer |
/api/system/health | GET | System status and health | Bearer |
/api/system/exchange-status | GET | Per-exchange connection status | Bearer |
Authentication
For all authenticated endpoints, include the JWT token in the HTTP header:
Authorization: Bearer <your_access_token>Quick Start
Create Account
Register on the website, purchase a subscription plan to get system access
Create API Keys
Follow the guide above to create API keys on each exchange you want to monitor (read-only is sufficient)
Configure API
Log in to your dashboard and enter each exchange's API Key, Secret, and Passphrase in the "API Settings" section
Enter System
Once configured, click "Enter System" to start using Dashboard, monitoring, signal analysis, and more
Start Using
The system will automatically begin collecting data. Explore real-time quotes, anomaly detection, net position analysis, and other modules
FAQ
Are my API keys safe?
All API keys are stored with AES-256 encryption and transmitted over TLS. We strongly recommend enabling IP whitelisting and disabling withdrawal permissions for maximum security.
Do I need trade permissions?
If you only use monitoring and analysis features (Dashboard, Signals, Net Positions, etc.), read-only permission is sufficient. Trade permission is only needed for the Quant Trading module.
Which exchanges are supported?
Currently supports OKX, Deribit, and Binance. Deribit is the world's largest crypto options exchange; OKX and Binance provide rich derivatives data.
Are there API rate limits?
The system handles rate limiting internally and will not exceed exchange rate limits. Users don't need to worry about API bans.
What is the data latency?
Data collection latency is typically < 5 seconds, running 24/7. You can check each exchange's data freshness on the Dashboard page.
How do I update or delete API keys?
You can update or remove saved API keys anytime in the "API Settings" section of your dashboard. We recommend rotating keys periodically for enhanced security.