> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_client_assets.assets.md).

# api\_client\_Assets.Assets

[@polymeshassociation/polymesh-sdk](/polymesh-sdk-api-reference/docs-alpha/classes.md) / [Modules](/polymesh-sdk-api-reference/docs-alpha/modules.md) / [api/client/Assets](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_assets.md) / Assets

## Class: Assets

[api/client/Assets](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_assets.md).Assets

Handles all Asset related functionality

### Table of contents

#### Methods

* [claimClassicTicker](#claimclassicticker)
* [createAsset](#createasset)
* [getAsset](#getasset)
* [getAssets](#getassets)
* [getTickerReservation](#gettickerreservation)
* [getTickerReservations](#gettickerreservations)
* [isTickerAvailable](#istickeravailable)
* [reserveTicker](#reserveticker)

### Methods

#### claimClassicTicker

▸ **claimClassicTicker**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), [`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), `unknown`\[]\[]>>

Claim a ticker symbol that was reserved in Polymath Classic (Ethereum). The Ethereum Account that owns the ticker must sign a special message that contains the DID of the Identity that will own the ticker in Polymesh, and provide the signed data to this call

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md), which means you can call [claimClassicTicker.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

| Name    | Type                                                                                                                                          |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [`ClaimClassicTickerParams`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_claimclassicticker.claimclassictickerparams.md) |
| `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md)                                                   |

**Returns**

`Promise`<`TransactionQueue`<[`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), [`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), `unknown`\[]\[]>>

**Defined in**

[api/client/Assets.ts:79](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Assets.ts#L79)

***

#### createAsset

▸ **createAsset**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md), [`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md), `unknown`\[]\[]>>

Create an Asset

**`note`** if ticker is already reserved, then required role:

* Ticker Owner

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md), which means you can call [createAsset.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

| Name    | Type                                                                                                                                         |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [`CreateAssetWithTickerParams`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_createasset.createassetwithtickerparams.md) |
| `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md)                                                  |

**Returns**

`Promise`<`TransactionQueue`<[`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md), [`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md), `unknown`\[]\[]>>

**Defined in**

[api/client/Assets.ts:92](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Assets.ts#L92)

***

#### getAsset

▸ **getAsset**(`args`): `Promise`<[`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md)>

Retrieve an Asset

**Parameters**

| Name          | Type     | Description  |
| ------------- | -------- | ------------ |
| `args`        | `Object` | -            |
| `args.ticker` | `string` | Asset ticker |

**Returns**

`Promise`<[`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md)>

**Defined in**

[api/client/Assets.ts:213](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Assets.ts#L213)

***

#### getAssets

▸ **getAssets**(`args?`): `Promise`<[`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md)\[]>

Retrieve all of the Assets owned by an Identity

**`note`** Assets with unreadable characters in their tickers will be left out

**Parameters**

| Name         | Type                                                                                                       | Description                                                        |
| ------------ | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| `args?`      | `Object`                                                                                                   | -                                                                  |
| `args.owner` | `string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | Identity representation or Identity ID as stored in the blockchain |

**Returns**

`Promise`<[`Asset`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_asset.asset.md)\[]>

**Defined in**

[api/client/Assets.ts:181](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Assets.ts#L181)

***

#### getTickerReservation

▸ **getTickerReservation**(`args`): [`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md)

Retrieve a Ticker Reservation

**Parameters**

| Name          | Type     | Description  |
| ------------- | -------- | ------------ |
| `args`        | `Object` | -            |
| `args.ticker` | `string` | Asset ticker |

**Returns**

[`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md)

**Defined in**

[api/client/Assets.ts:167](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Assets.ts#L167)

***

#### getTickerReservations

▸ **getTickerReservations**(`args?`): `Promise`<[`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md)\[]>

Retrieve all the ticker reservations currently owned by an Identity. This doesn't include Assets that have already been launched

**`note`** reservations with unreadable characters in their tickers will be left out

**Parameters**

| Name         | Type                                                                                                       | Description                      |
| ------------ | ---------------------------------------------------------------------------------------------------------- | -------------------------------- |
| `args?`      | `Object`                                                                                                   | -                                |
| `args.owner` | `string` \| [`Identity`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity.md) | defaults to the signing Identity |

**Returns**

`Promise`<[`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md)\[]>

**Defined in**

[api/client/Assets.ts:133](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Assets.ts#L133)

***

#### isTickerAvailable

▸ **isTickerAvailable**(`args`): `Promise`<`boolean`>

Check if a ticker hasn't been reserved

**`note`** can be subscribed to

**Parameters**

| Name          | Type     |
| ------------- | -------- |
| `args`        | `Object` |
| `args.ticker` | `string` |

**Returns**

`Promise`<`boolean`>

**Defined in**

[api/client/Assets.ts:101](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Assets.ts#L101)

▸ **isTickerAvailable**(`args`, `callback`): `Promise`<[`UnsubCallback`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md#unsubcallback)>

**Parameters**

| Name          | Type                                                                                              |
| ------------- | ------------------------------------------------------------------------------------------------- |
| `args`        | `Object`                                                                                          |
| `args.ticker` | `string`                                                                                          |
| `callback`    | [`SubCallback`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md#subcallback)<`boolean`> |

**Returns**

`Promise`<[`UnsubCallback`](/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md#unsubcallback)>

**Defined in**

[api/client/Assets.ts:102](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Assets.ts#L102)

***

#### reserveTicker

▸ **reserveTicker**(`args`, `opts?`): `Promise`<`TransactionQueue`<[`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), [`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), `unknown`\[]\[]>>

Reserve a ticker symbol under the ownership of the signing Identity to later use in the creation of an Asset. The ticker will expire after a set amount of time, after which other users can reserve it

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md), which means you can call [reserveTicker.checkAuthorization](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

| Name    | Type                                                                                                                           |
| ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `args`  | [`ReserveTickerParams`](/polymesh-sdk-api-reference/docs-alpha/interfaces/api_procedures_reserveticker.reservetickerparams.md) |
| `opts?` | [`ProcedureOpts`](/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts.md)                                    |

**Returns**

`Promise`<`TransactionQueue`<[`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), [`TickerReservation`](/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_tickerreservation.tickerreservation.md), `unknown`\[]\[]>>

**Defined in**

[api/client/Assets.ts:67](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Assets.ts#L67)