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

# Portfolios

Handles all Portfolio related functionality on the Identity side

## Hierarchy

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

  ↳ **Portfolios**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*Inherited from void*

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

### `Protected` parent

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

*Inherited from void*

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

## Methods

### create

▸ **create**(`args`: object, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹*[*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v9/classes/numberedportfolio.md)*››*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:166*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/Portfolios.ts#L166)

Create a new Portfolio for the Identity

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

▪`Optional` **opts**: [*ProcedureOpts*](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)

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

### delete

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:179*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/Portfolios.ts#L179)

Delete a Portfolio by ID

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v9/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-v9/classes/numberedportfolio.md) |

▪`Optional` **opts**: [*ProcedureOpts*](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)

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

### getCustodiedPortfolios

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:82*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/Portfolios.ts#L82)

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-v9/classes/portfolios.md#getportfolios)

**`note`** supports pagination

**Parameters:**

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

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

### getPortfolio

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

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

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

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

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:130*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Identity/Portfolios.ts#L130)

**Parameters:**

▪ **args**: *object*

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

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

### getPortfolios

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

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

Retrieve all the Portfolios owned by this Identity

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