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

# Getting Started

> The official Monei Node.js / TypeScript SDK install, configure, and use every service in one place

<Note>
  The Monei Node.js SDK is written in TypeScript and ships with full type definitions. It works in any Node.js ≥ 18 environment and supports both CommonJS and ESM.
</Note>

## Installation

<CodeGroup>
  ```bash npm theme={null}
  npm install monei-sdk
  ```

  ```bash yarn theme={null}
  yarn add monei-sdk
  ```

  ```bash pnpm theme={null}
  pnpm add monei-sdk
  ```
</CodeGroup>

***

## Initialization

```typescript theme={null}
import MoneiSDK from 'monei-sdk';

const monei = new MoneiSDK({
  apiKey: process.env.MONEI_API_KEY!,
});
```

### Configuration Options

| Option    | Type     | Required | Description                                               |
| --------- | -------- | -------- | --------------------------------------------------------- |
| `apiKey`  | `string` | Yes      | Your API key from the [Monei dashboard](https://monei.cc) |
| `baseUrl` | `string` | No       | Override the base URL (useful for sandbox)                |

***

## SDK Services Overview

| Namespace               | Service Class                | What it does                            |
| ----------------------- | ---------------------------- | --------------------------------------- |
| `monei.user`            | `UserService`                | Fetch and update the authenticated user |
| `monei.walletAccount`   | `WalletAccountService`       | Wallet info and virtual accounts        |
| `monei.deposit`         | `DepositService`             | Naira wallet deposits                   |
| `monei.payout`          | `PayoutService`              | Bank & peer transfers                   |
| `monei.walletUtility`   | `WalletUtilityService`       | Bank lookup & account verification      |
| `monei.paymentMethod`   | `PaymentMethodService`       | Saved payment methods                   |
| `monei.evm`             | `EvmService`                 | EVM blockchain operations               |
| `monei.solana`          | `SolanaService`              | Solana blockchain operations            |
| `monei.evmExchange`     | `EvmExchangeService`         | Token swaps (EVM)                       |
| `monei.solExchange`     | `SolanaExchangeService`      | Token swaps (Solana)                    |
| `monei.bills`           | `BillService`                | Airtime, data, electricity, cable TV    |
| `monei.transactions`    | Transaction history & lookup |                                         |
| `monei.billDiscovery`   | `BillDiscoveryService`       | Fecth available biller items            |
| `monei.offrampPayouts`  | `OfframpPayoutService`       | Offramp bank lookup & Verification      |
| `monei.billPay`         | `BillPayService`             | Payment for bills                       |
| `monei.offrampLedger`   | `OfframpLedgerService`       | Offramp transaction history & lookup    |
| `monei.billRecords`     | `BillRecordsService`         | Bills history & lookup                  |
| `monei.offrampExchange` | `OfframpExchangeService`     | Swap crypto to fiat                     |
| `monei.billValidation`  | `BillValidateService`        | Validate bills                          |
| `monei.business`        | `BusinessService`            | business customer operations            |

***