# Portfolios

Handles all Portfolio related functionality on the Identity side

## Hierarchy

* Namespace‹[Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/identity)›

  ↳ **Portfolios**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/context)

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/numberedportfolio)*›*

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/identity)

*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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/paginationoptions)): *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/resultset)*‹*[*DefaultPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/defaultportfolio) *|* [*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/numberedportfolio)*››*

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

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                                                     |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `paginationOpts?` | [PaginationOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/paginationoptions) |

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

### getPortfolio

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

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/defaultportfolio)*›*

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

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/numberedportfolio)*›*

### getPortfolios

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

*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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/defaultportfolio)*,* [*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/numberedportfolio)*]›*