# 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-v4/classes/entity.md)‹UniqueIdentifiers›

  ↳ **TickerReservation**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

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

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

### createToken

• **createToken**: *ProcedureMethod‹*[*CreateSecurityTokenParams*](/polymesh-sdk-api-reference/docs-v4/interfaces/createsecuritytokenparams.md)*,* [*SecurityToken*](/polymesh-sdk-api-reference/docs-v4/classes/securitytoken.md)*›*

*Defined in* [*src/api/entities/TickerReservation/index.ts:174*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/TickerReservation/index.ts#L174)

Create a Security Token using the reserved ticker

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

**`param`** amount of tokens that will be minted on creation

**`param`** whether a single token can be divided into decimal parts

**`param`** type of security that the token represents (i.e. Equity, Debt, Commodity, etc)

**`param`** domestic or international alphanumeric security identifiers for the token (ISIN, CUSIP, etc)

**`param`** (optional) funding round in which the token currently is (Series A, Series B, etc)

**`note`** required role:

* Ticker Owner

### extend

• **extend**: *ProcedureMethod‹void,* [*TickerReservation*](/polymesh-sdk-api-reference/docs-v4/classes/tickerreservation.md)*›*

*Defined in* [*src/api/entities/TickerReservation/index.ts:158*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/TickerReservation/index.ts#L158)

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

**`note`** required role:

* Ticker Owner

### ticker

• **ticker**: *string*

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

reserved ticker

### uuid

• **uuid**: *string*

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

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

## Methods

### details

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

*Defined in* [*src/api/entities/TickerReservation/index.ts:74*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/TickerReservation/index.ts#L74)

Retrieve the Reservation's owner, expiry date and status

**`note`** can be subscribed to

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

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

*Defined in* [*src/api/entities/TickerReservation/index.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/TickerReservation/index.ts#L75)

**Parameters:**

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

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

### `Static` generateUuid

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

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

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/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-v4/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v4/classes/entity.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/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*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/tickerreservation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.