# Offerings

Handles all Security Token Offering related functionality

## Hierarchy

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

  ↳ **Offerings**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*Inherited from void*

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

### launch

• **launch**: *ProcedureMethod‹LaunchStoParams,* [*Sto*](/polymesh-sdk-api-reference/docs-v4/classes/sto.md)*›*

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

Launch a Security Token Offering

**`param`** portfolio in which the Tokens to be sold are stored (optional, defaults to the default portfolio of the Security Token's Primary Issuance Agent)

**`param`** portfolio in which the raised funds will be stored

**`param`** ticker symbol of the currency in which the funds are being raised (i.e. 'USD' or 'CAD'). Other Security Tokens can be used as currency as well

**`param`** venue through which all offering related trades will be settled (optional, defaults to the first `Sto` type Venue owned by the owner of the Offering Portfolio. If passed, it must be of type `Sto`)

**`param`** start date of the Offering (optional, defaults to right now)

**`param`** end date of the Offering (optional, defaults to never)

**`param`** array of sale tiers. Each tier consists of an amount of Tokens to be sold at a certain price. Tokens in a tier can only be bought when all Tokens in previous tiers have been bought

**`param`** minimum amount that can be spent on this offering

**`note`** required roles:

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

### `Protected` parent

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

*Inherited from void*

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

## Methods

### get

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

*Defined in* [*src/api/entities/SecurityToken/Offerings.ts:51*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Offerings.ts#L51)

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

**Parameters:**

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

| Name      | Type                                                                | Description                      |
| --------- | ------------------------------------------------------------------- | -------------------------------- |
| `status?` | [StoStatus](/polymesh-sdk-api-reference/docs-v4/enums/stostatus.md) | status of the offerings to fetch |

**Returns:** *Promise‹*[*StoWithDetails*](/polymesh-sdk-api-reference/docs-v4/interfaces/stowithdetails.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-v4/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.