# 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

```npm
npm i @mysten/kiosk
```

## 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 extension accepts any Sui client that implements `ClientWithCoreApi`. Use `SuiGrpcClient`
for new Kiosk code; `SuiGraphQLClient` and the deprecated `SuiJsonRpcClient` are also compatible.

> **Note:** The gRPC object API returns Display v2 metadata. Use GraphQL or JSON-RPC when reading objects
> whose types still rely on legacy Display metadata.

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