Lib Functions

On this page

Reference for lib function configuration, contracts, and runtime modules. For why lib functions exist and how they fit the architecture, see Concepts: Lib Functions.

  • API Dict — configuration: auth, endpoints, rate limits, pagination
  • Fetch Contract — inbound: kwargs, return format, pagination, async
  • Push Contract — outbound: change types, batch modes, delivery guarantees
  • Blueprint Contract — stability guarantees, dynamic behavior, empty-run handling
  • Starlark Modules — http, env, json, yaml, csv, xml, time, builtins
API Dict

API dict reference for lib/ blueprints. Unified configuration for fetch, push, HTTP, auth, and rate limiting.

Fetch Contract

Complete reference for the fetch() function contract: page object, return format, pagination, incremental state, and available modules.

Push Contract

Complete reference for the push() function contract: internal fields, change types, return values, and batch modes.

Blueprint Contract

Stable API surface, dynamic behavior, and empty-run guarantees for lib functions.

Starlark Modules

Runtime modules and builtins available in Starlark blueprints — http, env, json, yaml, time, xml, csv, lib_helpers, plus DuckDB-backed and Go-native helpers.