API (Common Tasks)
Common tasks (what to call)
Section titled “Common tasks (what to call)”| I want to… | Use | Notes |
|---|---|---|
| Generate a dataset (Parquet) | POST /data/generate | Best first success path |
| Stream events (SSE) | GET /stream/live | Real-time event stream |
| Validate a manifest + get a hash | MCP tool validate_config | Reproducibility envelope |
| Get manifest JSON Schema | MCP tool get_config_schema | Client-side validation |
| Generate via MCP | MCP tool generate_dataset | MCP-native workflow |
| Export cached output as Parquet | MCP tool export_cache | Cache → Parquet |
| Normalize exchange events | MCP tool normalize_events | Canonical schema |
| Simulate funding | MCP tool simulate_funding_regime | Venue-aware funding |
Generate a dataset (Parquet)
Section titled “Generate a dataset (Parquet)”export ALEATORIC_API_KEY="your-api-key"
curl -sS -X POST "https://mcp.aleatoric.systems/data/generate" \ -H "X-API-Key: $ALEATORIC_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "config": { "symbol": "BTC", "seed": 42 }, "duration_seconds": 60 }' -o response.json
python3 -c 'import json; print(json.load(open("response.json"))["download_url"])' > download_url.txtcurl -L "$(cat download_url.txt)" -o aleatoric.parquetStream events (SSE)
Section titled “Stream events (SSE)”curl -N "https://mcp.aleatoric.systems/stream/live?symbol=BTCUSDT&seed=42" \ -H "X-API-Key: $ALEATORIC_API_KEY"Errors and retries
Section titled “Errors and retries”See Auth & Rate Limits for retry/backoff guidance and common status codes.