[PERS SDK - v2.3.26](/sdk-reference/readme) / [Exports](/sdk-reference/modules) / TokenSDK

# Class: TokenSDK

Token SDK - Class-based Promise SDK for Token Operations

Modern, performant SDK with direct method access and excellent TypeScript support.
Optimized for bundle size, performance, and developer experience.

Usage:
const tokenSDK = new TokenSDK(apiClient);
const tokens = await tokenSDK.getTokens();
const creditToken = await tokenSDK.getActiveCreditToken();

## Table of contents

### Constructors

- [constructor](/sdk-reference/classes/tokensdk#constructor)


### Methods

- [getTokens](/sdk-reference/classes/tokensdk#gettokens)
- [getTokenTypes](/sdk-reference/classes/tokensdk#gettokentypes)
- [getActiveCreditToken](/sdk-reference/classes/tokensdk#getactivecredittoken)
- [getRewardTokens](/sdk-reference/classes/tokensdk#getrewardtokens)
- [getStatusTokens](/sdk-reference/classes/tokensdk#getstatustokens)
- [getTokenByContract](/sdk-reference/classes/tokensdk#gettokenbycontract)
- [createTokenMetadata](/sdk-reference/classes/tokensdk#createtokenmetadata)
- [updateTokenMetadata](/sdk-reference/classes/tokensdk#updatetokenmetadata)
- [toggleTokenActive](/sdk-reference/classes/tokensdk#toggletokenactive)
- [createToken](/sdk-reference/classes/tokensdk#createtoken)
- [updateToken](/sdk-reference/classes/tokensdk#updatetoken)
- [setMainnetContract](/sdk-reference/classes/tokensdk#setmainnetcontract)
- [toggleTokenMetadataStatus](/sdk-reference/classes/tokensdk#toggletokenmetadatastatus)
- [createTokenType](/sdk-reference/classes/tokensdk#createtokentype)
- [getTokenService](/sdk-reference/classes/tokensdk#gettokenservice)
- [getTokenApi](/sdk-reference/classes/tokensdk#gettokenapi)


## Constructors

### constructor

• **new TokenSDK**(`apiClient`): [`TokenSDK`](/sdk-reference/classes/tokensdk)

#### Parameters

| Name | Type |
|  --- | --- |
| `apiClient` | [`PersApiClient`](/sdk-reference/classes/persapiclient) |


#### Returns

[`TokenSDK`](/sdk-reference/classes/tokensdk)

#### Defined in

[token/token-sdk.ts:29](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L29)

## Methods

### getTokens

▸ **getTokens**(): `Promise`<`PaginatedResponseDTO`<`TokenDTO`>>

Get all tokens

#### Returns

`Promise`<`PaginatedResponseDTO`<`TokenDTO`>>

Promise with all available tokens

#### Defined in

[token/token-sdk.ts:43](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L43)

### getTokenTypes

▸ **getTokenTypes**(): `Promise`<`PaginatedResponseDTO`<`TokenTypeDTO`>>

Get all token types

#### Returns

`Promise`<`PaginatedResponseDTO`<`TokenTypeDTO`>>

Promise with all available token types

#### Defined in

[token/token-sdk.ts:51](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L51)

### getActiveCreditToken

▸ **getActiveCreditToken**(): `Promise`<`TokenDTO`>

Get the active credit token

#### Returns

`Promise`<`TokenDTO`>

Promise with the current active credit token

#### Defined in

[token/token-sdk.ts:59](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L59)

### getRewardTokens

▸ **getRewardTokens**(): `Promise`<`PaginatedResponseDTO`<`TokenDTO`>>

Get all reward tokens

#### Returns

`Promise`<`PaginatedResponseDTO`<`TokenDTO`>>

Promise with all reward tokens

#### Defined in

[token/token-sdk.ts:67](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L67)

### getStatusTokens

▸ **getStatusTokens**(): `Promise`<`PaginatedResponseDTO`<`TokenDTO`>>

Get all status tokens

#### Returns

`Promise`<`PaginatedResponseDTO`<`TokenDTO`>>

Promise with all status tokens

#### Defined in

[token/token-sdk.ts:75](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L75)

### getTokenByContract

▸ **getTokenByContract**(`contractAddress`, `contractTokenId?`): `Promise`<`TokenDTO`>

Get token by contract address

#### Parameters

| Name | Type | Default value | Description |
|  --- | --- | --- | --- |
| `contractAddress` | `string` | `undefined` | The contract address to search for |
| `contractTokenId` | `null` | `string` | `null` | Optional contract token ID |


#### Returns

`Promise`<`TokenDTO`>

Promise with the matching token

#### Defined in

[token/token-sdk.ts:85](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L85)

### createTokenMetadata

▸ **createTokenMetadata**(`tokenId`, `tokenData`): `Promise`<`TokenDTO`>

Create token metadata

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `tokenId` | `string` | The token ID |
| `tokenData` | `TokenMetadataCreateRequestDTO` | The token metadata request data |


#### Returns

`Promise`<`TokenDTO`>

Promise with the updated token

#### Defined in

[token/token-sdk.ts:99](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L99)

### updateTokenMetadata

▸ **updateTokenMetadata**(`metadataId`, `tokenData`): `Promise`<`TokenMetadataDTO`>

Update token metadata (ERC721 only)
Note: Existing minted NFTs retain their original metadata - this only affects future mints

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `metadataId` | `string` | The metadata ID to update |
| `tokenData` | `TokenMetadataCreateRequestDTO` | The token metadata request data |


#### Returns

`Promise`<`TokenMetadataDTO`>

Promise with the updated metadata

#### Defined in

[token/token-sdk.ts:110](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L110)

### toggleTokenActive

▸ **toggleTokenActive**(`tokenId`): `Promise`<`TokenDTO`>

Toggle token active status

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `tokenId` | `string` | The token ID to toggle |


#### Returns

`Promise`<`TokenDTO`>

Promise with the updated token

#### Defined in

[token/token-sdk.ts:119](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L119)

### createToken

▸ **createToken**(`tokenData`): `Promise`<`TokenDTO`>

Create a new token

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `tokenData` | `TokenCreateRequestDTO` | The token creation data |


#### Returns

`Promise`<`TokenDTO`>

Promise with the created token

#### Defined in

[token/token-sdk.ts:128](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L128)

### updateToken

▸ **updateToken**(`tokenId`, `tokenData`): `Promise`<`TokenDTO`>

Update an existing token

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `tokenId` | `string` | The token ID to update |
| `tokenData` | `TokenUpdateRequestDTO` | The token update data |


#### Returns

`Promise`<`TokenDTO`>

Promise with the updated token

#### Defined in

[token/token-sdk.ts:138](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L138)

### setMainnetContract

▸ **setMainnetContract**(`tokenId`, `contractAddress`, `chainId`): `Promise`<`TokenDTO`>

Set mainnet contract address for a token

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `tokenId` | `string` | The token ID |
| `contractAddress` | `string` | The contract address |
| `chainId` | `number` | The blockchain chain ID |


#### Returns

`Promise`<`TokenDTO`>

Promise with the updated token

#### Defined in

[token/token-sdk.ts:149](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L149)

### toggleTokenMetadataStatus

▸ **toggleTokenMetadataStatus**(`metadataId`): `Promise`<`TokenMetadataDTO`>

Toggle token metadata status

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `metadataId` | `string` | The metadata ID to toggle |


#### Returns

`Promise`<`TokenMetadataDTO`>

Promise with the updated metadata

#### Defined in

[token/token-sdk.ts:158](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L158)

### createTokenType

▸ **createTokenType**(`tokenType`): `Promise`<`TokenTypeDTO`>

Create a new token type

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `tokenType` | `TokenTypeDTO` | The token type data |


#### Returns

`Promise`<`TokenTypeDTO`>

Promise with the created token type

#### Defined in

[token/token-sdk.ts:167](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L167)

### getTokenService

▸ **getTokenService**(): [`TokenService`](/sdk-reference/classes/tokenservice)

Get direct access to the token service for advanced operations

#### Returns

[`TokenService`](/sdk-reference/classes/tokenservice)

The underlying TokenService instance

#### Defined in

[token/token-sdk.ts:179](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L179)

### getTokenApi

▸ **getTokenApi**(): [`TokenApi`](/sdk-reference/classes/tokenapi)

Get direct access to the token API for low-level operations

#### Returns

[`TokenApi`](/sdk-reference/classes/tokenapi)

The underlying TokenApi instance

#### Defined in

[token/token-sdk.ts:187](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/token/token-sdk.ts#L187)