Perspicium API Docs

Official documentation for the Perspicium Public API v0.

Perspicium exposes key-protected market analytics endpoints for options intelligence, gamma exposure, portfolio analytics, seasonality, sector breadth, and historical pattern matching.

Start Here

• Quickstart
• Authentication and key generation
• Endpoint reference
• Errors and rate limits
• Language examples
• OpenAPI spec

Base URL

https://perspicium.com/api/v0

All endpoints currently use GET and return a consistent JSON envelope:

{
  "success": true,
  "data": {}
}

Errors use the same top-level shape:

{
  "success": false,
  "error": {
    "code": "invalid_api_key",
    "message": "API key invalid"
  }
}

Five-Minute Test

export PERSPICIUM_API_KEY="your_api_key"

curl "https://perspicium.com/api/v0/ping" \
  -H "Authorization: ApiKey $PERSPICIUM_API_KEY"

Expected response:

{
  "success": true,
  "data": {
    "status": "ok"
  }
}

Repository Layout

.
├── docs/
│   ├── authentication.md
│   ├── quickstart.md
│   ├── guides/
│   └── reference/
├── examples/
│   ├── curl/
│   ├── javascript/
│   ├── python/
│   └── r/
├── openapi/
│   └── perspicium-api-v0.yaml
└── mkdocs.yml

Local Preview

These docs are plain Markdown and can be read directly on GitHub. If you want a local documentation site:

python -m pip install -r requirements.txt
mkdocs serve

Then open http://127.0.0.1:8000.

Cloudflare Pages

Use these build settings:

Build command: pip install -r requirements.txt && mkdocs build
Build output directory: site