> For the complete documentation index, see [llms.txt](https://ourzora.gitbook.io/zoraos/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ourzora.gitbook.io/zoraos/dev/zdk.md).

# ZDK

## Getting Started

To start, install the developer kit with `yarn` or `npm`

{% tabs %}
{% tab title="Yarn" %}

```bash
yarn add @zoralabs/zdk
```

{% endtab %}

{% tab title="NPM" %}

```bash
npm install -S @zoralabs/zdk
```

{% endtab %}
{% endtabs %}

The ZDK exposes utilities for the Zora contracts and an [ethers.js](https://docs.ethers.io/v5/) interface to interact with the Zora ecosystem.  

{% hint style="info" %}
The [ethers.js](https://docs.ethers.io/v5/) library is an incredibly powerful tool for interacting with the Ethereum blockchain. Most of the guides provided in this documentation interact with ethers.js as well.
{% endhint %}

\
The ZDK currently provides 6 modules, which can be used in combination or separately to read and write to the Zora protocol:

* [Zora Module](/zoraos/dev/zdk/zora-protocol.md)
* [Utility Module](/zoraos/dev/zdk/utility.md)
* [Addresses Module](/zoraos/dev/zdk/addresses.md)
* [Metadata Module](/zoraos/dev/zdk/metadata.md)
* [User Information Module](/zoraos/dev/zdk/users.md)
* [Auction House Module](/zoraos/dev/zdk/auction-house.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ourzora.gitbook.io/zoraos/dev/zdk.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.