Developer Documentation

API Integration

Seamless integration with your existing systems. RESTful API, Python SDK, and webhooks for real-time market intelligence.

Get API Key

Quick Start

1. Get Your API Key

Apply for our pilot program to receive your API key via email within 24-48 hours.

2. Install Python SDK (Optional)

pip install arcane-intelligence

3. Make Your First Request

import requests

API_KEY = "your-api-key-here"
BASE_URL = "http://localhost:8000"

headers = {"X-API-Key": API_KEY}
response = requests.get(
    f"{BASE_URL}/snapshot",
    headers=headers
)

print(response.json())

Available Endpoints

RESTful JSON API with OpenAPI 3.0 specification

GET/snapshot

Current market signals for all monitored instruments

GET/history

90-day signal timeline for visualization

GET/factors

multi-factor risk attribution and exposures

GET/alerts

Alert transition history with durations

GET/market-news

Real-time market news with sentiment analysis

Authentication

JWT Token-Based Auth

Include your API key in the X-API-Key header for every request:

X-API-Key: your-api-key-here

Rate Limits

Professional: 1000 requests/minute • Enterprise: Unlimited

Webhooks

Receive real-time push notifications when new signals are detected. Configure webhook endpoints in your dashboard settings.

{
  "event": "signal.created",
  "timestamp": "2025-11-09T21:11:15Z",
  "data": {
    "symbol": "SPY",
    "state": 1,
    "confidence": 83.3,
    "note": "Vol spike detected: 2.1σ"
  }
}

Code Examples

Python

from arcane import Client

client = Client(api_key="...")
signals = client.get_snapshot()

for signal in signals:
    if signal.state == 1:
        print(f"Alert: {signal.symbol}")

JavaScript

const response = await fetch(
  'http://localhost:8000/snapshot',
  {
    headers: {
      'X-API-Key': 'your-key'
    }
  }
);
const signals = await response.json();

cURL

curl -H "X-API-Key: your-key" \
  http://localhost:8000/snapshot

R

library(httr)
response <- GET(
  "http://localhost:8000/snapshot",
  add_headers("X-API-Key" = "...")
)
data <- content(response)

Full API Documentation

Complete API reference with request/response schemas, error codes, and advanced examples.

View Full Reference Get API Key