# Offerings

Handles all Security Token Offering related functionality

## Hierarchy

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

  ↳ **Offerings**

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v6/classes/offerings.md#protected-context)
* [parent](/polymesh-sdk-api-reference/docs-v6/classes/offerings.md#protected-parent)

### Methods

* [get](/polymesh-sdk-api-reference/docs-v6/classes/offerings.md#get)
* [launch](/polymesh-sdk-api-reference/docs-v6/classes/offerings.md#launch)

## Properties

### `Protected` context

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

*Inherited from void*

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

### `Protected` parent

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

*Inherited from void*

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

## Methods

### get

▸ **get**(`opts`: object): *Promise‹*[*StoWithDetails*](/polymesh-sdk-api-reference/docs-v6/interfaces/stowithdetails.md)*\[]›*

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

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

**Parameters:**

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

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

**Returns:** *Promise‹*[*StoWithDetails*](/polymesh-sdk-api-reference/docs-v6/interfaces/stowithdetails.md)*\[]›*

### launch

▸ **launch**(`args`: LaunchStoParams): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue.md)*‹*[*Sto*](/polymesh-sdk-api-reference/docs-v6/classes/sto.md)*››*

*Defined in* [*src/api/entities/SecurityToken/Offerings.ts:38*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/SecurityToken/Offerings.ts#L38)

Launch a Security Token Offering

**`note`** required roles:

* Security Token Primary Issuance Agent
* Offering Portfolio Custodian
* Raising Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v6/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 |

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


---

# 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-v6/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.