Quickstart

Integrate in minutes.

Skuvix exposes a stability-first execution surface. You can run signals, schedule jobs, and receive run events via webhooks.

Sign in with Google
Create an API key in the Operator Console
Call your first endpoint
Configure webhooks for run events

Authentication

API keys

Use an API key for server-to-server access. Keep it secret. Rotate if leaked.

Authorization: Bearer <YOUR_API_KEY>

Code examples

curl

curl -X POST https://api.starwayquant.com/v1/runs \
  -H "Authorization: Bearer $STARWAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "type": "signal_scan", "symbol": "SPY" }'

TypeScript

const res = await fetch("https://api.starwayquant.com/v1/runs", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.STARWAY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ type: "signal_scan", symbol: "SPY" }),
});
const data = await res.json();
console.log(data);

Python

import os, requests

r = requests.post(
  "https://api.starwayquant.com/v1/runs",
  headers={"Authorization": f"Bearer {os.environ['STARWAY_API_KEY']}"},
  json={"type": "signal_scan", "symbol": "SPY"},
)
print(r.json())

Core endpoints

Method	Path	Description
POST	/v1/runs	Start a run (signal scan / backtest / hook).
GET	/v1/runs/{id}	Fetch run status and logs.
GET	/v1/signals	List signals (time range / symbol).
POST	/v1/webhooks	Register a webhook endpoint.
GET	/v1/usage	Usage + rate limits.

Webhooks

Events

run.created — a run is accepted.
run.completed — finished successfully.
run.failed — failed with error.
subscription.updated — billing lifecycle updates (Stripe).

Payload shape

{
  "id": "evt_...",
  "type": "run.completed",
  "createdAt": "2026-01-01T00:00:00Z",
  "data": {
    "runId": "run_...",
    "status": "SUCCESS",
    "metrics": { "latencyMs": 128 }
  }
}

Next steps

Connect Stripe subscription + webhook verification
Provision Cloud SQL + Prisma user table
Issue API keys and enforce rate limits
Add Runs list + Run detail pages in Console