@apicity/simplefunctions

v0.6.2

Published

15 hours ago

SimpleFunctions analytical, authenticated, and real-time data API provider for prediction-market data.

0High
0Medium
0Low

justintanner

simplefunctions prediction-markets kalshi polymarket market-data real-time search apicity

@apicity/simplefunctions

SimpleFunctions analytical, authenticated, and real-time data API provider for prediction-market data.

SimpleFunctions exposes two REST surfaces here: analytical Query API calls use https://simplefunctions.dev, while real-time market-data calls under simplefunctions.data.v1.* use the separate https://data.simplefunctions.dev/v1 data API base URL. Authenticated dashboard, thesis, portfolio, alerting, tool, and runtime routes also live under simplefunctions.api.* on the analytical host. simplefunctions.api.public.market({ ticker }) mirrors sf inspect <ticker> --json; pass depth: true for the public orderbook view used by sf book <ticker> --json. The current public WebSocket endpoint is wss://app.simplefunctions.dev/ws; do not model wss://data.simplefunctions.dev/v1/ws as active until upstream routing changes.

Runtime dependencies:

zod@^4.4.3 — request schemas attached to provider endpoints as .schema

Installation

npm install @apicity/simplefunctions
# or
pnpm add @apicity/simplefunctions

Quick Start

import { createSimpleFunctions } from "@apicity/simplefunctions";

const simplefunctions = createSimpleFunctions({ apiKey: process.env.SIMPLEFUNCTIONS_API_KEY });

Public Market APIs

simplefunctions.api.public.* mirrors the hosted /api/public/* surface on https://simplefunctions.dev. Most basic reads work without an API key. Passing createSimpleFunctions({ apiKey }) adds the Authorization: Bearer ... header and may unlock higher rate limits, higher model tiers, or user-specific overlays on routes that support them.

Most public routes are CDN cached with Cache-Control: public, s-maxage=N; route TTLs vary. Common TTLs are: markets, scan, and screen at 60 seconds; query, query-gov, and query-econ at 5-10 minutes in memory plus 5 minute CDN stale-while-revalidate; index and regime at 30 seconds; legislation and congress members at 1 hour ISR.

| Group | Methods | Purpose | |-------|---------|---------| | Markets | markets, newmarkets, scan, screen, screenByTickers, search, market, market.history, marketMicrostructureHistory, liveTickers, market.candles | Market universe, recently listed markets, keyword/series/market scans, indicator screens, explicit ticker screens, search, detail, history, spread/depth/flow history, live-priced tickers, and OHLCV candles. | | Cross-venue | crossVenue.pairs, crossVenue.stats | Kalshi to Polymarket pairs, pair counts, and confidence distribution. | | Regime and index | regime.scan, index, index.history, calibration | Current regime labels, SimpleFunctions Index v2 gauges, index history, and calibration. | | Probability index | odds, oddsMd | Liquidity-weighted YES probability snapshot for the /odds page, refreshed every 15 minutes; oddsMd is the Markdown variant for agents, capped at 500 slugs upstream. | | Calendar and milestones | calendar, yieldCurves, yieldCurves.event | Upcoming resolutions and event yield curves. | | Liquidity and contagion | liquidityByTheme, contagion | Liquidity grouped by theme and lagging related markets. | | Government data | queryGov, legislation, legislation.byBillId, congress.members, congress.member | Congress-mirror-backed bill, member, and treaty search plus bill/member detail. | | Economic data | queryEcon, fred, databento, tradMarkets | FRED-mirror-backed series search, FRED details, Databento traditional markets, and traditional market anchors. | | Content | query, topic, answer, glossary, glossary.entry, guide, highlights, briefing, diff, discuss | Headline cross-venue search, topic and stable answer data, glossary, agent guide, editorial highlights, briefing, daily diff, and discussion topics. | | Skills | skills, skill | Public skill catalog and one skill by slug. | | Theses and opinions | theses, thesis, opinions, opinions.entry | Public theses and editorial opinions. | | Technicals | technicals, technicals.entry | Technical guides and one guide by slug. | | Ideas | ideas, ideas.byId | Trade ideas and one idea by id. | | Context | context | Global market context without thesis payloads. |

Market candles

simplefunctions.api.public.market.candles is the hosted API mapping for the strict market.candles SDK/Agent contract. The Vercel API route proxies to the terminal/Fly candle service and normalizes the response for SDK consumers.

const candles = await simplefunctions.api.public.market.candles({
  ticker: "KXRATECUT-26DEC31",
  venue: "kalshi",
  timeframe: "1m",
  limit: 500,
});

| Parameter | Values | Notes | |-----------|--------|-------| | venue | kalshi, polymarket | Optional. Use it when the ticker or id is ambiguous. | | timeframe / tf | 1m, 5m, 15m, 1h, 1d | Default is 1m. | | limit | number | Default is 500, max is 2000 upstream. |

The probability index routes accept category, band, and limit. band can be mid for probabilities near 50% or moving for recently shifted questions.

GET /api/public/regime/history is deprecated and returns 410 Gone. Use regime.scan for current regime labels and marketMicrostructureHistory for spread/depth history.

Authenticated APIs

Passing createSimpleFunctions({ apiKey }) adds Authorization: Bearer ... to authenticated dashboard, thesis, portfolio, alerting, tool, and runtime routes. The CLI-auth and session-oriented Market Watch routes can also be called with a custom fetch implementation that supplies browser/session cookies instead of a local API key.

| Group | Methods | Purpose | |-------|---------|---------| | API keys and auth | api.keys, api.keys.create, api.keys.delete, api.auth.cli.*, api.signup | API-key lifecycle, CLI login handshakes, and signup. | | Account | api.feed, api.dashboard.usage | Authenticated feed and usage telemetry. | | Theses | api.thesis.* | Create, retrieve, update, fork, evaluate, augment, publish, and attach positions, strategies, videos, or context to private theses. | | Portfolio | api.portfolio.* | Portfolio state, config, ticks, trades, ledger imports, fills, positions, activity, attribution, risk, views, strategy, secrets, and triggers. | | Execution | api.intents.*, api.runtime.exec.* | Execution-intent lifecycle and runtime execution triggers. | | Watch and alerts | api.watch.*, api.alertRules.*, api.webhookEndpoints.*, api.alertDeliveries.* | Watch objects, alert rules, webhook endpoints, delivery history, and test/refresh actions. | | Tools | api.contracts.tools, api.tools, api.skills, api.prompt, api.mcp.*, api.proxy.* | Tool catalogs, prompt payloads, MCP transport, and raw speech proxy responses. | | Market Watch | api.dashboard2.marketWatchV2, api.dashboard2.marketWatch.panels.* | Session-backed Market Watch dashboard reads and panel CRUD. |

API Reference

188 endpoints across 27 groups. Each method mirrors an upstream URL path.

agent

GET https://simplefunctions.dev/api/agent/feed/{topic}{query}

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@apicity/simplefunctions

Installation

Quick Start

Public Market APIs

Market candles

Authenticated APIs

API Reference

agent

alertDeliveries

alertRules

auth

calibration

changes

contracts

dashboard

dashboard2

data

edges

feed

intents

keys

mcp

portfolio

prompt

proxy

public