# Portfolios

Handles all Portfolio related functionality on the Identity side

## Hierarchy

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

  ↳ **Portfolios**

## Index

### Properties

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

### Methods

* [create](/polymesh-sdk-api-reference/docs-v6/classes/portfolios.md#create)
* [delete](/polymesh-sdk-api-reference/docs-v6/classes/portfolios.md#delete)
* [getCustodiedPortfolios](/polymesh-sdk-api-reference/docs-v6/classes/portfolios.md#getcustodiedportfolios)
* [getPortfolio](/polymesh-sdk-api-reference/docs-v6/classes/portfolios.md#getportfolio)
* [getPortfolios](/polymesh-sdk-api-reference/docs-v6/classes/portfolios.md#getportfolios)

## 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**: [*Identity*](/polymesh-sdk-api-reference/docs-v6/classes/identity.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

### create

▸ **create**(`args`: object): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue.md)*‹*[*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v6/classes/numberedportfolio.md)*››*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:165*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Identity/Portfolios.ts#L165)

Create a new Portfolio for the Identity

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod.md), which means you can call `create.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

▪ **args**: *object*

| Name   | Type   |
| ------ | ------ |
| `name` | string |

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

### delete

▸ **delete**(`args`: object): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:178*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Identity/Portfolios.ts#L178)

Delete a Portfolio by ID

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod.md), which means you can call `delete.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

▪ **args**: *object*

| Name        | Type                                                                                               |
| ----------- | -------------------------------------------------------------------------------------------------- |
| `portfolio` | BigNumber \| [NumberedPortfolio](/polymesh-sdk-api-reference/docs-v6/classes/numberedportfolio.md) |

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

### getCustodiedPortfolios

▸ **getCustodiedPortfolios**(`paginationOpts?`: [PaginationOptions](/polymesh-sdk-api-reference/docs-v6/interfaces/paginationoptions.md)): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v6/interfaces/resultset.md)*‹*[*DefaultPortfolio*](/polymesh-sdk-api-reference/docs-v6/classes/defaultportfolio.md) *|* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v6/classes/numberedportfolio.md)*››*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:81*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Identity/Portfolios.ts#L81)

Retrieve all Portfolios custodied by this Identity. This only includes portfolios owned by a different Identity but custodied by this one. To fetch Portfolios owned by this Identity, use [getPortfolios](/polymesh-sdk-api-reference/docs-v6/classes/portfolios.md#getportfolios)

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                     |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `paginationOpts?` | [PaginationOptions](/polymesh-sdk-api-reference/docs-v6/interfaces/paginationoptions.md) |

**Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v6/interfaces/resultset.md)*‹*[*DefaultPortfolio*](/polymesh-sdk-api-reference/docs-v6/classes/defaultportfolio.md) *|* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v6/classes/numberedportfolio.md)*››*

### getPortfolio

▸ **getPortfolio**(): *Promise‹*[*DefaultPortfolio*](/polymesh-sdk-api-reference/docs-v6/classes/defaultportfolio.md)*›*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:128*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Identity/Portfolios.ts#L128)

Retrieve a numbered Portfolio or the default Portfolio if Portfolio ID is not passed

**Returns:** *Promise‹*[*DefaultPortfolio*](/polymesh-sdk-api-reference/docs-v6/classes/defaultportfolio.md)*›*

▸ **getPortfolio**(`args`: object): *Promise‹*[*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v6/classes/numberedportfolio.md)*›*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:129*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Identity/Portfolios.ts#L129)

**Parameters:**

▪ **args**: *object*

| Name          | Type      |
| ------------- | --------- |
| `portfolioId` | BigNumber |

**Returns:** *Promise‹*[*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v6/classes/numberedportfolio.md)*›*

### getPortfolios

▸ **getPortfolios**(): *Promise‹\[]›*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:50*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Identity/Portfolios.ts#L50)

Retrieve all the Portfolios owned by this Identity

**Returns:** *Promise‹\[]›*


---

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