> For the complete documentation index, see [llms.txt](/llms.txt)

# Kiosk SDK

TypeScript SDK for interacting with Sui Kiosk onchain commerce.



Kiosk SDK is a tool to interact with Sui and Mysten Kiosk. You can use it to query kiosk related
data, build transactions to interact, and extend Kiosk to support custom rules.

## Installation [#installation]

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npm i @mysten/kiosk
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm add @mysten/kiosk
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn add @mysten/kiosk
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun add @mysten/kiosk
    ```
  </CodeBlockTab>
</CodeBlockTabs>

## About [#about]

The Kiosk SDK exports a client extension that integrates with Sui clients. Add it to your client
using `$extend(kiosk())` to access kiosk functionality through `client.kiosk`.

> The Kiosk SDK requires `SuiJsonRpcClient` or `SuiGraphQLClient`. It does not work with
> `SuiGrpcClient` because it uses event queries that are not available in gRPC.

* [Read more about setting up the Kiosk client extension](/kiosk/kiosk-client/introduction)