> ## Documentation Index
> Fetch the complete documentation index at: https://docs-test.rye.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get started

> The Rye SDK provides convenient access to the Rye API via the Rye client from which users can make queries and mutations easily.

## Installation

Install the package with:

```bash theme={null}
npm install @rye-api/rye-sdk
# or
yarn add @rye-api/rye-sdk
# or
pnpm add @rye-api/rye-sdk
```

## Client initialization

The client needs to be created with your account's API authorization header and the IP address of your end shopper.

Headers can be found in the [Rye Console](https://console.rye.com/account), although note that the value provided for "Shopper IP" represents *your* IP address. For production use cases, you should use the end shopper's IP address rather than a hardcoded constant.

The client will automatically make requests to the correct environment based on your `authHeader`.

```ts theme={null}
import { RyeClient, ENVIRONMENT } from "@rye-api/rye-sdk";

const ryeClient = new RyeClient({
  authHeader: "<AUTH_HEADER>",
  shopperIp: "<SHOPPER_IP>",
});
```

## Resources

* [npm package](https://www.npmjs.com/package/@rye-api/rye-sdk)
* [GitHub repository](https://github.com/rye-com/rye-sdk) - pull requests welcome!