# api\_entities\_Identity\_Portfolios.Portfolios

[@polymeshassociation/polymesh-sdk](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes) / [Modules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules) / [api/entities/Identity/Portfolios](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity_portfolios) / Portfolios

## Class: Portfolios

[api/entities/Identity/Portfolios](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity_portfolios).Portfolios

Handles all Portfolio related functionality on the Identity side

### Hierarchy

* `Namespace`<[`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity)>

  ↳ **`Portfolios`**

### Table of contents

#### Methods

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

### Methods

#### delete

▸ **delete**(`args`, `opts?`): `Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

Delete a Portfolio by ID

**`note`** required role:

* Portfolio Custodian

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod), which means you can call [delete.checkAuthorization](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.proceduremethod#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters**

| Name             | Type                                                                                                                                                                     |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `args`           | `Object`                                                                                                                                                                 |
| `args.portfolio` | `BigNumber` \| [`NumberedPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio) |
| `opts?`          | [`ProcedureOpts`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.procedureopts)                                              |

**Returns**

`Promise`<`TransactionQueue`<`void`, `void`, `unknown`\[]\[]>>

**Defined in**

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

***

#### getCustodiedPortfolios

▸ **getCustodiedPortfolios**(`paginationOpts?`): `Promise`<[`ResultSet`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`NumberedPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio) | [`DefaultPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_defaultportfolio.defaultportfolio)>>

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-alpha/interfaces/types.paginationoptions) |

**Returns**

`Promise`<[`ResultSet`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/interfaces/types.resultset)<[`NumberedPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio) | [`DefaultPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_defaultportfolio.defaultportfolio)>>

**Defined in**

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

***

#### getPortfolio

▸ **getPortfolio**(): `Promise`<[`DefaultPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_defaultportfolio.defaultportfolio)>

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-alpha/classes/api_entities_defaultportfolio.defaultportfolio)>

**Defined in**

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

▸ **getPortfolio**(`args`): `Promise`<[`NumberedPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio)>

**Parameters**

| Name               | Type        |
| ------------------ | ----------- |
| `args`             | `Object`    |
| `args.portfolioId` | `BigNumber` |

**Returns**

`Promise`<[`NumberedPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_numberedportfolio.numberedportfolio)>

**Defined in**

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

***

#### getPortfolios

▸ **getPortfolios**(): `Promise`<\[[`DefaultPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_defaultportfolio.defaultportfolio), ...NumberedPortfolio\[]]>

Retrieve all the Portfolios owned by this Identity

**Returns**

`Promise`<\[[`DefaultPortfolio`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_defaultportfolio.defaultportfolio), ...NumberedPortfolio\[]]>

**Defined in**

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