← API Keys

AkshayaAI Public Data API

REST/JSON access to live stock signals, screening, movers, market data, and natural-language queries. Interactive docs (Swagger) ↗

Base URL & versioning

https://www.akshayaai.com/llm/api/v1

All endpoints below are relative to this base. The API is versioned under /api/v1; new endpoints are added without breaking existing ones.

Authentication

Every endpoint (except /health) requires an API key. Create and manage keys on the API Keys page. Send it with either header:

Authorization: Bearer fin_xxxxxxxxxxxxxxxxxxxx
X-API-Key: fin_xxxxxxxxxxxxxxxxxxxx

Rate limits (per key, by tier)

Tier	Per minute	Per day
free	10	100
basic	30	1,000
pro	100	10,000
institutional	1,000	1,000,000

Each response carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Remaining-Day, and X-Request-ID. Exceeding a limit returns 429 with a Retry-After header. Check your live usage on the API Keys page or via GET /usage.

Endpoints

GET/ticker/{symbol}

Quote + technical/AI signals for one ticker (US or NSE symbol).

curl -H "X-API-Key: fin_xxx" \
  https://www.akshayaai.com/llm/api/v1/ticker/AAPL

Returns: symbol, company, price, change_pct, rsi, score, composite_score, signal, sector, sma20/50/200, high52_pct, low52_pct, ret5, ret10, exhaustion_score, exhaustion_dir, ai_signal, ai_prob.

POST/screen

Field screener using the same natural-language filter grammar as the app.

curl -H "X-API-Key: fin_xxx" -H "Content-Type: application/json" \
  -d '{"filter":"rsi above 70 and score above 8","limit":25}' \
  https://www.akshayaai.com/llm/api/v1/screen

Filter examples: "rsi above 70", "exhaustion score below 3", "5 day return below -5", "ai probability above 80 and fwd pe below 20". Returns {filter, parsed, total, results:[…]}.

GET/movers

Top gainers and losers. Query params: period = today|5d|10d|20d, limit (default 10), sector (optional).

curl -H "X-API-Key: fin_xxx" \
  "https://www.akshayaai.com/llm/api/v1/movers?period=5d&limit=10"

GET/market

Market overview: index AI signals, advance/decline breadth, and top movers.

curl -H "X-API-Key: fin_xxx" https://www.akshayaai.com/llm/api/v1/market

POST/query

Natural-language question against the full engine. Generative answers require a paid tier (free tier returns data-only answers). Optional {"rag": true|false}.

curl -H "X-API-Key: fin_xxx" -H "Content-Type: application/json" \
  -d '{"query":"how is NVDA doing today?"}' \
  https://www.akshayaai.com/llm/api/v1/query

Returns {query, answer, route, method, tickers, sources, rag, request_id}.

GET/usage

Your key's tier, configured limits, and current usage counts.

curl -H "X-API-Key: fin_xxx" https://www.akshayaai.com/llm/api/v1/usage

GET/health

Liveness check — no authentication required.

Errors

Status	Meaning
`401`	Missing, invalid, revoked, or expired API key
`404`	Unknown ticker / resource
`400`	Bad request (e.g. unparseable screener filter)
`429`	Rate limit exceeded — see `Retry-After`

Error bodies are JSON: {"detail": "…"}. Every response includes X-Request-ID for support/tracing.

← Back to API Keys · Interactive Swagger ↗