> For the complete documentation index, see [llms.txt](https://elacity.gitbook.io/elacity-sdks/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://elacity.gitbook.io/elacity-sdks/documentation/api/getting-started/installation.md).

# Installation

The `@elacity-js/api` package provides a type-safe client for interacting with Elacity's backend services, including NFT management, authentication, and more.

## Prerequisites

Before installing, ensure you have a project set up with **Node.js (v18+)** and **TypeScript** (if applicable).

The SDK relies on **Ethers.js (v6)** for blockchain interaction and cryptographic signing (SIWE).

## Install the Package

Install the primary API package along with the core utilities and companion dependency:

```bash
npm install ethers @elacity-js/common @elacity-js/api
```

Or using yarn:

```bash
yarn add ethers @elacity-js/common @elacity-js/api
```

## TypeScript Configuration

If you are using TypeScript, ensure your `tsconfig.json` is configured to support modern modules and decorators if you plan to extend the SDK:

```json
{
  "compilerOptions": {
    "target": "ESNext",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "strict": true,
    "esModuleInterop": true
  }
}
```

## Next Steps

Once installed, proceed to the [Authentication](https://elacity.gitbook.io/elacity-sdks/documentation/api/getting-started/authentication.md) guide to learn how to sign in and interact with protected resources.
