Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.simplefunctions.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authenticated SDK reads require an API key:
import { SimpleFunctions } from "@spfunctions/sdk"

const sf = new SimpleFunctions({
  apiKey: process.env.SF_API_KEY,
  baseUrl: process.env.SF_API_URL,
})

Theses

const theses = await sf.theses.list({ status: "active", limit: 10 })
const thesis = await sf.theses.get("thesis-id")

Portfolio

const state = await sf.portfolio.state()
const ticks = await sf.portfolio.ticks.list({ limit: 10, envelope: true })
const trades = await sf.portfolio.trades.list({ limit: 10, envelope: true })

Intents

const intents = await sf.intents.list({ active: true })
This is a read wrapper. The rollout does not implement live trade execution.

Watchlists and alerts

const watched = await sf.watchlists.list({ limit: 20 })
const alerts = await sf.alerts.list({ status: "active", limit: 20 })
These are user-scoped reads with sideEffect: none.