IIAI API

Programmatic access to IIAI's holistic opportunity scores. Available on the Institutional plan. Authenticate every request with an API key you generate from your dashboard.

⚠️ Algorithmic analysis only — not investment advice, not a prediction. You are responsible for any decisions made using this data.

Authentication

Pass your key in the X-API-Key header. Keys are issued in your dashboard under API Access and shown once at creation.

curl https://YOUR-DOMAIN/api/v1/opportunities \
  -H "X-API-Key: iiai_live_xxxxxxxxxxxxxxxxxxxx"

Keys map to your account. Inactive subscription or a non-Institutional plan → 402/403. Revoked or invalid key → 401.

Rate limits

Institutional keys are metered per day (default 5,000 calls). Exceeding the limit returns 429 Too Many Requests. Contact us for higher volume.

Endpoints

GET/api/v1/opportunities

Ranked opportunity scores from the live engine.

Query parameters

Param	Type	Default	Description
limit	int	50	Max results (1–500)

Response

{
  "available": true,
  "count": 2,
  "opportunities": [
    {
      "symbol": "NVDA",
      "score": 88.0,
      "decision": "BUY",
      "price": 900.12,
      "confidence_label": "High",
      "factors": [
        {"name": "Momentum %", "value": 3.2},
        {"name": "Volume spike (x avg)", "value": 2.1},
        {"name": "RSI", "value": 61.0}
      ],
      "as_of": "2026-05-31T12:00:00Z"
    }
  ],
  "disclaimer": "Algorithmic analysis for informational purposes only..."
}

Response fields

Field	Meaning
score	Holistic score. Sign = direction, magnitude = conviction.
decision	The engine's signal label (BUY / SELL / NEUTRAL).
factors	The real feature contributions behind the score.
confidence_label	High / Moderate / Low / Very Low from score magnitude.

Errors

Code	Meaning
401	Missing / invalid / revoked API key
402	Subscription inactive
403	Plan lacks API access (needs Institutional)
429	Daily rate limit reached

← Back to dashboard