API Reference
This section documents the complete public API of Supabase KMP — every client interface, extension function, data type, enum, and value class that ships in the 1.0.0 artifacts. Each page is organized by module and lists real signatures, every parameter, the return type, and a short example.
Looking to learn a feature rather than look up a symbol? Start with the task-oriented guides — Getting Started, Database, Authentication, Storage, Realtime. This reference is the exhaustive companion to those.
How to read these pages
Every fallible call returns a SupabaseResult<T> — a sealed Success<T> /
Failure type (it is not kotlin.Result). You branch with
onSuccess / onFailure and transform with map / flatMap / recover; no
exceptions leak onto the happy path. See Results & Errors
for the full contract, and the Core reference for the type
itself.
Each module is published independently under the group
io.github.androidpoet — depend only on what you use.
Modules
| Reference | Artifact | What it covers |
|---|---|---|
| Core | supabase-core | SupabaseResult, error model, value-class IDs, typed filter DSL |
| Client | supabase-client | Supabase.create, configuration, HTTP transport |
| Authentication | supabase-auth | Email/phone/OTP, OAuth, MFA, PKCE, sessions, passkeys |
| Auth Admin | supabase-auth-admin | Service-role user management (server-side only) |
| Native Sign-In | supabase-auth-google · -apple · -passkey | Native Google / Apple / WebAuthn ceremonies |
| Database | supabase-database | PostgREST CRUD, RPC, typed read/write helpers |
| Storage | supabase-storage | Buckets, objects, signed & public URLs |
| Realtime | supabase-realtime | WebSocket channels, postgres changes, broadcast, presence |
| Edge Functions | supabase-functions | Typed edge-function invocation |
| End-to-End Encryption | supabase-e2ee | ECDH → HKDF → AES-256-GCM client-side crypto |
| Offline Sync | supabase-sync-core · -sqldelight · -sync · -paging | Offline-first pull/merge/push engine |
| Codegen | supabase-codegen · Gradle plugin | Generate typed models from your schema |