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

# Portfolios

Handles all Portfolio related functionality on the Identity side

## Hierarchy

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

  ↳ **Portfolios**

## Index

### Properties

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

### Methods

* [delete](#delete)
* [getCustodiedPortfolios](#getcustodiedportfolios)
* [getPortfolio](#getportfolio)
* [getPortfolios](#getportfolios)

## Properties

### `Protected` context

• **context**: *Context*

*Inherited from void*

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

***

### `Protected` parent

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

*Inherited from void*

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

## Methods

### delete

▸ **delete**(`args`: object, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-beta/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:164*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/Portfolios.ts#L164)

Delete a Portfolio by ID

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md), which means you can call [delete.checkAuthorization](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/proceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

▪ **args**: *object*

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

▪`Optional` **opts**: [*ProcedureOpts*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/procedureopts.md)

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

***

### getCustodiedPortfolios

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:77*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/Portfolios.ts#L77)

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](#getportfolios)

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                                                     |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `paginationOpts?` | [PaginationOptions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/beta/docs/interfaces/paginationoptions.md) |

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

***

### getPortfolio

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:124*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/Portfolios.ts#L124)

Retrieve a Numbered Portfolio or the Default Portfolio if Portfolio ID is not passed

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

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:125*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/Portfolios.ts#L125)

**Parameters:**

▪ **args**: *object*

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

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

***

### getPortfolios

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/31a16a34/src/api/entities/Identity/Portfolios.ts#L46)

Retrieve all the Portfolios owned by this Identity

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