Pro API

Name: HOOX
Availability: InStock
Author: HOOX

Flask Pro API — /run with mode=auto, /optimize strategy search, plot_meta/fill, alerts + L2 webhooks, preview, backtest, and shared evaluate contract.

This page

Manuals

Section PDFAPI Full PDFComplete

The PYNE Pro API is a Flask HTTP service that runs Pine scripts over caller-supplied OHLCV, returns plots / series / plot_meta (incl. fill bands) / strategy events / drawings / alerts, optional L2 alert webhooks, and gates thumbnail + backtest routes behind API keys. Default evaluate path is mode=auto (compile when safe, interpret on fallback). It is intentionally not the language server: different auth, scaling, and failure domains.

Abstract

Where the LSP answers static editor questions, the Pro API answers dynamic evaluate questions:

POST JSON { script, data: OHLCV[], mode?, libraries?, webhook_url?, … }
  → pynescript.runtime.Runtime.run  (Pro API re-export; mode default: auto)
  → { plots, series, plot_meta, events, drawings, alerts,
      mode, auto_backend?, compile_fallback_reason?,
      script_id, run_id, alert_forward?, … }

Free-tier evaluate (POST /run, POST /run/batch) validates bodies with hand-rolled schemas, enforces a 5 MB body cap, and restricts CORS. Optional bar/script/rate/concurrency guards (backend/middleware/free_limits.py) are off unless FREE_TIER_LIMITS is 1/true/yes/on. GET / and GET /health are the same unauthenticated readiness payload (features.free_tier_limits reports the switch). Optional L2 webhooks POST last-bar alert() / alertcondition() firings to webhook_url or env ALERT_WEBHOOK_URL (see Alerts). Pro routes under /preview/* and /backtest/* use track_usage (Bearer / ApiKey / query key). Chart PNGs are matplotlib Agg renders encoded as base64.

The same evaluate contract is mirrored by pyne-worker so AXIS and HOOX can swap hosts without redesigning payloads — see contract.

Conceptual model

Rendering…

Interface surface

Method	Path	Auth	Role
`GET`	`/` · `/health`	none	Health + endpoint map + compile cache section
`GET`	`/stats`	none	Process runtime counters, latencies, gauges (docs)
`POST`	`/run`	none (free)	Single-script evaluate (`mode` default `auto`; `libraries[]`; `from_bar`/`to_bar`; alerts + optional webhooks)
`POST`	`/run/batch`	none (free)	≤8 scripts, shared OHLCV
`POST`	`/session`	none (free)	Live session — O(1) ticks, O(delta) appends (docs)
`GET`/`POST`/`DELETE`	`/session/<id>` · `…/tick` · `…/append`	none (free)	Advance / inspect / release a live session
`GET`/`POST`	`/data/series` · `/data/series/bars` · `/data/series/provide` · `/data/series/fetch`	API key	Engine-owned OHLCV store (docs)
`POST`	`/data/session` · `/data/session/<id>/tick`	API key	Live session bound to a stored series
`POST`	`/scripts` · `/cron/*`	optional runner	Hosted scripts + bar-close — off unless `PYNE_RUNNER=1` (runner)
`POST`	`/optimize`	none (free)	Strategy `input.*` search — N interpret Runtime runs (docs)
`WS`	`/ws/run`	none (free)	Same evaluate contract over JSON frames (`flask-sock` optional)
`POST`	`/preview/chart`	API key + usage	Line / OHLCV PNG
`POST`	`/preview/indicator`	API key + usage	Expression series PNG
`POST`	`/backtest/quick`	API key + usage	Quick strategy metrics + equity PNG
`POST`	`/auth/create_key`	admin decorator	Mint `pyn_…` key (fail-closed `ADMIN_TOKEN`)
`GET`	`/auth/usage`	API key	Usage counters
`POST`	`/auth/validate`	none (body key)	Validate without consuming quota
`POST`	`/compile/prewarm`	none (free, rate-gated)	Product warm-compile — skip cold Numba JIT
`POST`	`/lsp/*`	none (free)	AXIS editor completion / hover / diagnostics
`POST`	`/api/git/oauth/device/*`	none (device flow)	Optional GitHub/GitLab device OAuth for SPA git (blueprint)

`/run` response highlights

Field	Role
`series` / `plots` / `plot_meta`	Bar values + display meta (color, linewidth, `kind`, `fill` band refs)
`events`	Strategy broker events
`drawings`	Drawing registry / compile `__drawings`
`alerts`	Structured `alert()` / `alertcondition()` firings
`mode` / `auto_backend`	Effective path (`interpret` \| `compile`)
`compile_fallback_reason`	Why `auto` chose interpret (eligibility or compile error)
`alert_forward`	Present when a webhook URL was configured
`error_kind`	On failure: `parse` \| `compile` \| `runtime` \| `data` \| `order` \| `mode`

Local runner: make run → python -m backend.app (default 127.0.0.1:5002).

Tracks in this tab

App lifecycle — Flask app, CORS, limits, blueprints
Auth and keys — tiers, stores, decorators
Run · Live sessions · Data plane · Stats
Optimize · Preview · Backtest · Runner
Chart renderer
Runtime bridge — Runtime / series / evaluator glue
Contract — shared evaluate schema across Flask and workers

Internals (map)

Path	Role
`backend/app.py`	App object, `/run`, `/session`, `/data/session`, `/health`, `/stats`, `/compile/prewarm`, `/auth`, CORS
`backend/api/preview.py`	Preview + backtest blueprints
`backend/api/data_series.py`	Engine-owned OHLCV store routes
`backend/api/datafeed.py`	CCXT gateway + `WS /datafeed/watch`
`backend/datafeed_app.py`	Standalone compose `datafeed` app (same blueprint)
`backend/datastore/*`	SQLite OHLCV store, session ↔ series binding
`backend/middleware/sessions.py`	Process-local live-session store (TTL + capacity)
`backend/middleware/window.py`	`apply_window` — response windowing
`backend/logging_setup.py`	`PYNE_DEBUG` level policy
`backend/api/git_oauth.py`	Optional device OAuth for SPA git
`backend/api/lsp_http.py`	Free AXIS editor LSP-HTTP
`backend/middleware/*`	Auth, schemas, free_limits, optional Redis/SQLite key stores
`src/pynescript/runtime/host.py`	Package SoT bar-loop (`mode=auto`, sessions, alerts pack)
`src/pynescript/stats.py`	Runtime counter / latency / gauge registry
`backend/runtime.py`	Compat re-export of the package host
`backend/alert_forwarder.py`	L2 HTTP webhook delivery
`backend/evaluator.py` / `backend/series.py`	Compat shims
`backend/services/*`	Charts + backtest simulation