# Portfolios

Handles all Portfolio related functionality on the Identity side

## Hierarchy

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

  ↳ **Portfolios**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*Inherited from void*

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

### `Protected` parent

• **parent**: [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/identity)

*Inherited from void*

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

## Methods

### create

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:119*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/Portfolios.ts#L119)

Create a new Portfolio for the Identity

**Parameters:**

▪ **args**: *object*

| Name   | Type   |
| ------ | ------ |
| `name` | string |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue)*‹*[*NumberedPortfolio*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/numberedportfolio)*››*

### delete

▸ **delete**(`args`: object): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue)*‹void››*

*Defined in* [*src/api/entities/Identity/Portfolios.ts:126*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/Portfolios.ts#L126)

Delete a Portfolio by ID

**Parameters:**

▪ **args**: *object*

| Name        | Type                                                                                                                               |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `portfolio` | BigNumber \| [NumberedPortfolio](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/numberedportfolio) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue)*‹void››*

### getCustodiedPortfolios

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:55*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/Portfolios.ts#L55)

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)

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

### getPortfolio

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:89*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/Portfolios.ts#L89)

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

**Parameters:**

| Name    | Type                |
| ------- | ------------------- |
| `args?` | undefined \| object |

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

### getPortfolios

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

*Defined in* [*src/api/entities/Identity/Portfolios.ts:24*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Identity/Portfolios.ts#L24)

Retrieve all the Portfolios owned by this Identity

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