# Kotlin SDK

The SurrealDB SDK for Kotlin is a coroutine-based, Kotlin Multiplatform client for querying a remote SurrealDB instance.

The SurrealDB SDK for Kotlin lets you connect to [SurrealDB](/docs) from any Kotlin application. It is a [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) library targeting the JVM, Android, and iOS, with a coroutine-based, `suspend`-friendly API. The SDK connects to remote instances over WebSocket or HTTP and provides methods for querying with [SurrealQL](/docs/reference/query-language.md), managing data, [authentication](/docs/learn/security/authentication/authentication.md), live queries, transactions, and multiple sessions. Its design closely mirrors the [JavaScript SDK](/docs/languages/javascript.md).

> [!NOTE]
> The Kotlin SDK is currently in early development. The latest version is `0.1.0-SNAPSHOT`, and it is not yet published to Maven Central. The coordinates and APIs documented here are provisional and may change before the first stable release.

## Getting started

- [Installation](/docs/reference/kotlin/installation.md) - Install the SDK and add it to your project.

- [Getting started guide](/docs/languages/kotlin.md) - Connect to SurrealDB and run your first queries.

## Learn

- [Concepts](/docs/reference/kotlin/concepts/connecting-to-surrealdb.md) - Guides for connecting, authenticating, querying, and working with data.

- [API Reference](/docs/reference/kotlin/api/core/surreal-client.md) - Complete reference for the SDK's methods, types, and errors.

## Contributing

To contribute to the SDK code, submit an Issue or Pull Request in the [surrealdb.kotlin](https://github.com/surrealdb/surrealdb.kotlin) repository. To contribute to this documentation, submit an Issue or Pull Request in the [docs.surrealdb.com](https://github.com/surrealdb/docs.surrealdb.com) repository.

## Sources

- [GitHub repository](https://github.com/surrealdb/surrealdb.kotlin)