> 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/v12.0.2/classes/offerings.md).

# Offerings

Handles all Security Token Offering related functionality

## Hierarchy

* Namespace‹[SecurityToken](/polymesh-sdk-api-reference/v12.0.2/classes/securitytoken.md)›

  ↳ **Offerings**

## Index

### Properties

* [context](#protected-context)
* [parent](#protected-parent)

### Methods

* [get](#get)
* [getOne](#getone)
* [launch](#launch)

## Properties

### `Protected` context

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

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:11*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/Namespace.ts#L11)

***

### `Protected` parent

• **parent**: [*SecurityToken*](/polymesh-sdk-api-reference/v12.0.2/classes/securitytoken.md)

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/Namespace.ts#L9)

## Methods

### get

▸ **get**(`opts`: object): *Promise‹*[*StoWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/stowithdetails.md)*\[]›*

*Defined in* [*src/api/entities/SecurityToken/Offerings.ts:81*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/SecurityToken/Offerings.ts#L81)

Retrieve all of the Token's Offerings and their details. Can be filtered using parameters

**Parameters:**

▪`Default value` **opts**: *object*= {}

| Name      | Type                                                                                                             | Description                                                                                            |
| --------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `status?` | Partial‹[StoStatus](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/stostatus.md)› | status of the offerings to fetch. If defined, only STOs that have all passed statuses will be returned |

**Returns:** *Promise‹*[*StoWithDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/stowithdetails.md)*\[]›*

***

### getOne

▸ **getOne**(`args`: object): *Promise‹*[*Sto*](/polymesh-sdk-api-reference/v12.0.2/classes/sto.md)*›*

*Defined in* [*src/api/entities/SecurityToken/Offerings.ts:56*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/SecurityToken/Offerings.ts#L56)

Retrieve a single Offering associated to this Security Token by its ID

**`throws`** if there is no Offering with the passed ID

**Parameters:**

▪ **args**: *object*

| Name | Type      |
| ---- | --------- |
| `id` | BigNumber |

**Returns:** *Promise‹*[*Sto*](/polymesh-sdk-api-reference/v12.0.2/classes/sto.md)*›*

***

### launch

▸ **launch**(`args`: LaunchStoParams, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/v12.0.2/classes/transactionqueue.md)*‹*[*Sto*](/polymesh-sdk-api-reference/v12.0.2/classes/sto.md)*››*

*Defined in* [*src/api/entities/SecurityToken/Offerings.ts:47*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/SecurityToken/Offerings.ts#L47)

Launch a Security Token Offering

**`note`** required roles:

* Offering Portfolio Custodian
* Raising Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/proceduremethod.md), which means you can call `launch.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                            |
| ------- | --------------------------------------------------------------------------------------------------------------- |
| `args`  | LaunchStoParams                                                                                                 |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/v12.0.2/classes/transactionqueue.md)*‹*[*Sto*](/polymesh-sdk-api-reference/v12.0.2/classes/sto.md)*››*


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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/v12.0.2/classes/offerings.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.