> 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/docs-v5/classes/portfolios.md).

# Portfolios

Handles all Portfolio related functionality on the Identity side

## Hierarchy

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

  ↳ **Portfolios**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*Inherited from void*

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

### create

• **create**: *ProcedureMethod‹object,* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v5/classes/numberedportfolio.md)*›*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:162*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/Portfolios.ts#L162)

Create a new Portfolio for the Identity

### delete

• **delete**: *ProcedureMethod‹object, void›*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:170*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Identity/Portfolios.ts#L170)

Delete a Portfolio by ID

**`note`** required role:

* Portfolio Custodian

### `Protected` parent

• **parent**: [*Identity*](/polymesh-sdk-api-reference/docs-v5/classes/identity.md)

*Inherited from void*

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

## Methods

### getCustodiedPortfolios

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:81*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/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-v5/classes/portfolios.md#getportfolios)

**`note`** supports pagination

**Parameters:**

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

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

### getPortfolio

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:128*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/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-v5/classes/defaultportfolio.md)*›*

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

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

**Parameters:**

▪ **args**: *object*

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

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

### getPortfolios

▸ **getPortfolios**(): *Promise‹\[*[*DefaultPortfolio*](/polymesh-sdk-api-reference/docs-v5/classes/defaultportfolio.md)*,* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v5/classes/numberedportfolio.md)*]›*

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

Retrieve all the Portfolios owned by this Identity

**Returns:** *Promise‹\[*[*DefaultPortfolio*](/polymesh-sdk-api-reference/docs-v5/classes/defaultportfolio.md)*,* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v5/classes/numberedportfolio.md)*]›*