> 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-v3/classes/tickerreservation.md).

# TickerReservation

Represents a reserved token symbol in the Polymesh chain. Ticker reservations expire after a set length of time, after which they can be reserved by another Identity. A Ticker must be previously reserved by an Identity for that Identity to be able create a Security Token with it

## Hierarchy

* [Entity](/polymesh-sdk-api-reference/docs-v3/classes/entity.md)‹UniqueIdentifiers›

  ↳ **TickerReservation**

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md#protected-context)
* [ticker](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md#ticker)
* [uuid](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md#uuid)

### Methods

* [createToken](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md#createtoken)
* [details](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md#details)
* [extend](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md#extend)
* [generateUuid](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md#static-unserialize)

## Properties

### `Protected` context

• **context**: [*Context*](/polymesh-sdk-api-reference/docs-v3/classes/context.md)

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v3/classes/entity.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v3/classes/entity.md#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Entity.ts#L48)

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/TickerReservation/index.ts:45*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/TickerReservation/index.ts#L45)

reserved ticker

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v3/classes/entity.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v3/classes/entity.md#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Entity.ts#L46)

## Methods

### createToken

▸ **createToken**(`args`: [CreateSecurityTokenParams](/polymesh-sdk-api-reference/docs-v3/interfaces/createsecuritytokenparams.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v3/classes/securitytoken.md)*››*

*Defined in* [*src/api/entities/TickerReservation/index.ts:167*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/TickerReservation/index.ts#L167)

Create a Security Token using the reserved ticker

**`note`** the issuer DID will be set as the primary issuance agent

**Parameters:**

| Name   | Type                                                                                                     |
| ------ | -------------------------------------------------------------------------------------------------------- |
| `args` | [CreateSecurityTokenParams](/polymesh-sdk-api-reference/docs-v3/interfaces/createsecuritytokenparams.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v3/classes/securitytoken.md)*››*

### details

▸ **details**(): *Promise‹*[*TickerReservationDetails*](/polymesh-sdk-api-reference/docs-v3/interfaces/tickerreservationdetails.md)*›*

*Defined in* [*src/api/entities/TickerReservation/index.ts:63*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/TickerReservation/index.ts#L63)

Retrieve the Reservation's owner, expiry date and status

**`note`** can be subscribed to

**Returns:** *Promise‹*[*TickerReservationDetails*](/polymesh-sdk-api-reference/docs-v3/interfaces/tickerreservationdetails.md)*›*

▸ **details**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v3/globals.md#subcallback)‹[TickerReservationDetails](/polymesh-sdk-api-reference/docs-v3/interfaces/tickerreservationdetails.md)›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v3/globals.md#unsubcallback)*›*

*Defined in* [*src/api/entities/TickerReservation/index.ts:64*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/TickerReservation/index.ts#L64)

**Parameters:**

| Name       | Type                                                                                                                                                                              |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v3/globals.md#subcallback)‹[TickerReservationDetails](/polymesh-sdk-api-reference/docs-v3/interfaces/tickerreservationdetails.md)› |

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v3/globals.md#unsubcallback)*›*

### extend

▸ **extend**(): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue.md)*‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md)*››*

*Defined in* [*src/api/entities/TickerReservation/index.ts:144*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/TickerReservation/index.ts#L144)

Extend the Reservation time period of the ticker for 60 days from now to later use it in the creation of a Security Token.

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue.md)*‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v3/classes/tickerreservation.md)*››*

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v3/classes/entity.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v3/classes/entity.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v3/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v3/classes/entity.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*