---
url: >-
  https://game-engine-io.github.io/enginex-frontend-sdk/reference/api/@getenginex/sdk/interfaces/EnginexClient.md
---
[Reference](../../../index.md) / [@getenginex/sdk](../index.md) / EnginexClient

# EnginexClient

EngineX SDK client: one object per app (browser) or per request (server).

## Properties

### auth

> `readonly` **auth**: [`AuthApi`](AuthApi.md)

Sign-up, login, verification, password and 2FA.

***

### config

> `readonly` **config**: [`ConfigApi`](ConfigApi.md)

The operator's public configuration.

***

### deposits

> `readonly` **deposits**: [`DepositsApi`](DepositsApi.md)

Deposits via PIX.

***

### kyc

> `readonly` **kyc**: [`KycApi`](KycApi.md)

Identity verification (KYC): status and document upload.

***

### notifications

> `readonly` **notifications**: [`NotificationsApi`](NotificationsApi.md)

The player's notifications and channel preferences.

***

### pixKeys

> `readonly` **pixKeys**: [`PixKeysApi`](PixKeysApi.md)

The player's PIX keys, the destination of withdrawals.

***

### profile

> `readonly` **profile**: [`ProfileApi`](ProfileApi.md)

The player's profile and their login sessions.

***

### responsibleGambling

> `readonly` **responsibleGambling**: [`ResponsibleGamblingApi`](ResponsibleGamblingApi.md)

Responsible gambling: limits, self-exclusion and reality check.

***

### session

> `readonly` **session**: [`SessionApi`](SessionApi.md)

Current session.

***

### wallet

> `readonly` **wallet**: [`WalletApi`](WalletApi.md)

Wallet balance and statement.

***

### withdrawals

> `readonly` **withdrawals**: [`WithdrawalsApi`](WithdrawalsApi.md)

Withdrawals via PIX, with OTP confirmation when the operator requires it.

## Methods

### dispose()

> **dispose**(): `void`

Disposes the client: releases the session subscription on the `tokenStore` (removes the `storage`
listener of `localStorageTokenStore` when this was the last one) and cancels nothing in flight.
Once called, every method of this client rejects with an `EnginexError` `CONFIGURATION_ERROR`
and `session.subscribe` becomes a no-op (it does not add the listener; the returned unsubscribe does not
throw). Idempotent. Use it when unmounting a client created per request (e.g. tests, short-lived
scripts) so as not to leave the `storage` listener hanging.

#### Returns

`void`

#### Example

```ts
client.dispose()
```

***

### setLocale()

> **setLocale**(`locale`): `void`

Switches the language sent in `Accept-Language`. The next requests already go out with the new locale —
including the *retry* of a call already in flight (after a renewed 401): only the attempt
that was already sent to `fetch` keeps the old locale.

#### Parameters

##### locale

`string`

#### Returns

`void`

#### Example

```ts
client.setLocale('en-US')
```
