Skip to main content
Figranium’s official SDKs connect your code to a running Figranium server. Use them to save and run tasks, stream execution events, and manage schedules, captures, and Cabinets from JavaScript, Python, Swift, or Kotlin, without hand-writing HTTP requests.

​
Choose an SDK

Every SDK wraps the same Figranium REST and Server-Sent Events API, so features match across languages. Pick the one that fits your stack.

JavaScript SDK

@figranium/sdk for Node.js 18+ and modern browsers. TypeScript first, ESM and CommonJS, no runtime dependencies.

Python SDK

figranium-sdk for Python 3.9+. Sync and async clients built on httpx, with TypedDict types.

Swift SDK

Figranium package for macOS, iOS, tvOS, watchOS, and server-side Swift. Native async/await, zero dependencies.

Kotlin SDK

dev.figranium:figranium for Kotlin and Android API 23+. Coroutines on OkHttp, Flow streams, optional Android AppFunctions.

​
Compare SDKs

​
Install an SDK

​
What every SDK can do

  • Save, update, version, and roll back tasks.
  • Run tasks with runtime variables, or call scrape, agent, and headful directly.
  • Stream live execution and selector events over Server-Sent Events.
  • Manage schedules, captures, cookies, and Cabinets.
  • Open and inspect headful browser sessions.

​
Before you start

1

Run a Figranium server

Every SDK talks to a running Figranium instance. Local installs listen on http://localhost:11345 by default. See Docker Compose to set one up.
2

Create an API key

Generate a key so the SDK can authenticate requests. See API key.
3

Follow your SDK's quickstart

Build and run your first task with the JavaScript, Python, Swift, or Kotlin quickstart.
Prefer calling HTTP directly? The REST API exposes the same endpoints the SDKs wrap.