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

# @getenginex/sdk

Main entry point: client, session, authentication, configuration, profile, wallet, KYC, responsible gambling, notifications and errors.

## Client

* [CallOptions](interfaces/CallOptions.md)
* [CursorPage](interfaces/CursorPage.md)
* [CursorPageInput](interfaces/CursorPageInput.md)
* [EnginexClient](interfaces/EnginexClient.md)
* [EnginexClientHooks](interfaces/EnginexClientHooks.md)
* [EnginexClientOptions](interfaces/EnginexClientOptions.md)
* [FormDataFieldSummary](interfaces/FormDataFieldSummary.md)
* [Page](interfaces/Page.md)
* [RequestBodySummary](interfaces/RequestBodySummary.md)
* [RequestHookContext](interfaces/RequestHookContext.md)
* [ResponseHookContext](interfaces/ResponseHookContext.md)
* [ValidationIssue](interfaces/ValidationIssue.md)
* [FetchOptions](type-aliases/FetchOptions.md)
* [HttpMethod](type-aliases/HttpMethod.md)
* [NoParams](type-aliases/NoParams.md)
* [ValidationMode](type-aliases/ValidationMode.md)
* [createEnginexClient](functions/createEnginexClient.md)

## Session

* [LocalStorageTokenStoreOptions](interfaces/LocalStorageTokenStoreOptions.md)
* [Session](interfaces/Session.md)
* [SessionApi](interfaces/SessionApi.md)
* [StorageLike](interfaces/StorageLike.md)
* [Tokens](interfaces/Tokens.md)
* [TokenStore](interfaces/TokenStore.md)
* [SessionStatus](type-aliases/SessionStatus.md)
* [localStorageTokenStore](functions/localStorageTokenStore.md)
* [memoryTokenStore](functions/memoryTokenStore.md)

## Authentication

* [AuthApi](interfaces/AuthApi.md)
* [CpfLookupResult](interfaces/CpfLookupResult.md)
* [RegisterInput](interfaces/RegisterInput.md)
* [RegisterResult](interfaces/RegisterResult.md)
* [SaveLeadInput](interfaces/SaveLeadInput.md)
* [TwoFactorSetup](interfaces/TwoFactorSetup.md)
* [LoginInput](type-aliases/LoginInput.md)
* [LoginResult](type-aliases/LoginResult.md)
* [VerifyEmailInput](type-aliases/VerifyEmailInput.md)

## Configuration

* [Branding](interfaces/Branding.md)
* [BrandingContact](interfaces/BrandingContact.md)
* [BrandingIntegrations](interfaces/BrandingIntegrations.md)
* [BrandingLegal](interfaces/BrandingLegal.md)
* [BrandingLicense](interfaces/BrandingLicense.md)
* [BrandingLogos](interfaces/BrandingLogos.md)
* [BrandingPwa](interfaces/BrandingPwa.md)
* [CaptchaConfig](interfaces/CaptchaConfig.md)
* [ConfigApi](interfaces/ConfigApi.md)
* [CurrencyInfo](interfaces/CurrencyInfo.md)
* [FirstSportsbookSettings](interfaces/FirstSportsbookSettings.md)
* [OperatorConfig](interfaces/OperatorConfig.md)
* [OperatorLimits](interfaces/OperatorLimits.md)
* [OtpConfig](interfaces/OtpConfig.md)
* [PaymentMethod](interfaces/PaymentMethod.md)
* [Product](interfaces/Product.md)
* [ProductsConfig](interfaces/ProductsConfig.md)
* [SportsbookConfig](interfaces/SportsbookConfig.md)
* [SupportConfig](interfaces/SupportConfig.md)
* [BrandingColorName](type-aliases/BrandingColorName.md)
* [BrandingColors](type-aliases/BrandingColors.md)

## Profile

* [Profile](interfaces/Profile.md)
* [ProfileApi](interfaces/ProfileApi.md)
* [ProfileSession](interfaces/ProfileSession.md)
* [UpdateProfileInput](type-aliases/UpdateProfileInput.md)

## Wallet

* [Balance](interfaces/Balance.md)
* [ListTransactionsInput](interfaces/ListTransactionsInput.md)
* [Transaction](interfaces/Transaction.md)
* [Wallet](interfaces/Wallet.md)
* [WalletApi](interfaces/WalletApi.md)
* [TransactionCategory](type-aliases/TransactionCategory.md)
* [TransactionStatus](type-aliases/TransactionStatus.md)
* [TransactionType](type-aliases/TransactionType.md)

## Deposits

* [Deposit](interfaces/Deposit.md)
* [DepositsApi](interfaces/DepositsApi.md)
* [DepositSummary](interfaces/DepositSummary.md)
* [ListDepositsInput](interfaces/ListDepositsInput.md)
* [PixDeposit](interfaces/PixDeposit.md)
* [DepositStatus](type-aliases/DepositStatus.md)

## Withdrawals

* [ListWithdrawalsInput](interfaces/ListWithdrawalsInput.md)
* [Withdrawal](interfaces/Withdrawal.md)
* [WithdrawalsApi](interfaces/WithdrawalsApi.md)
* [WithdrawalSubmission](interfaces/WithdrawalSubmission.md)
* [RequestWithdrawalInput](type-aliases/RequestWithdrawalInput.md)
* [WithdrawalRequestResult](type-aliases/WithdrawalRequestResult.md)
* [WithdrawalStatus](type-aliases/WithdrawalStatus.md)

## PIX keys

* [PixKey](interfaces/PixKey.md)
* [PixKeysApi](interfaces/PixKeysApi.md)
* [PixKeyType](type-aliases/PixKeyType.md)

## KYC

* [KycApi](interfaces/KycApi.md)
* [KycDocumentUpload](interfaces/KycDocumentUpload.md)
* [KycStatus](interfaces/KycStatus.md)
* [UploadKycDocumentInput](interfaces/UploadKycDocumentInput.md)
* [KycDocumentType](type-aliases/KycDocumentType.md)
* [KycLevel](type-aliases/KycLevel.md)
* [KycStatusValue](type-aliases/KycStatusValue.md)

## Responsible gaming

* [LimitUsage](interfaces/LimitUsage.md)
* [RealityCheck](interfaces/RealityCheck.md)
* [ResponsibleGamblingApi](interfaces/ResponsibleGamblingApi.md)
* [ResponsibleGamblingLimits](interfaces/ResponsibleGamblingLimits.md)
* [SelfExcludeInput](interfaces/SelfExcludeInput.md)
* [SelfExclusionResult](interfaces/SelfExclusionResult.md)
* [SetLimitsInput](interfaces/SetLimitsInput.md)
* [SetLimitsResult](interfaces/SetLimitsResult.md)
* [SelfExclusionDuration](type-aliases/SelfExclusionDuration.md)

## Notifications

* [ListNotificationsInput](interfaces/ListNotificationsInput.md)
* [Notification](interfaces/Notification.md)
* [NotificationPreferences](interfaces/NotificationPreferences.md)
* [NotificationsApi](interfaces/NotificationsApi.md)
* [NotificationsPage](type-aliases/NotificationsPage.md)
* [NotificationType](type-aliases/NotificationType.md)

## Realtime

* [WebSocketLikeInstance](interfaces/WebSocketLikeInstance.md)
* [WebSocketLike](type-aliases/WebSocketLike.md)

## Money

* [formatMoney](functions/formatMoney.md)
* [fromMinorUnits](functions/fromMinorUnits.md)
* [toMinorUnits](functions/toMinorUnits.md)

## Errors

* [EnginexError](classes/EnginexError.md)
* [CaptchaRequiredDetails](interfaces/CaptchaRequiredDetails.md)
* [EnginexErrorInit](interfaces/EnginexErrorInit.md)
* [EnginexErrorJSON](interfaces/EnginexErrorJSON.md)
* [ErrorDetailsMap](interfaces/ErrorDetailsMap.md)
* [EnginexErrorCode](type-aliases/EnginexErrorCode.md)
* [KnownErrorCode](type-aliases/KnownErrorCode.md)
* [GATEWAY_ERROR_CODES](variables/GATEWAY_ERROR_CODES.md)
* [SDK_ERROR_CODES](variables/SDK_ERROR_CODES.md)
* [isEnginexError](functions/isEnginexError.md)
