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

# Portfolios

Handles all Portfolio related functionality on the Identity side

## Hierarchy

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

  ↳ **Portfolios**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*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*](/polymesh-sdk-api-reference/docs-v3/classes/identity.md)

*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*](/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue.md)*‹*[*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v3/classes/numberedportfolio.md)*››*

*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*](/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue.md)*‹*[*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v3/classes/numberedportfolio.md)*››*

### delete

▸ **delete**(`args`: object): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue.md)*‹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](/polymesh-sdk-api-reference/docs-v3/classes/numberedportfolio.md) |

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

### getCustodiedPortfolios

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

*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](/polymesh-sdk-api-reference/docs-v3/classes/portfolios.md#getportfolios)

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

### getPortfolio

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

*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*](/polymesh-sdk-api-reference/docs-v3/classes/defaultportfolio.md) *|* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v3/classes/numberedportfolio.md)*›*

### getPortfolios

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

*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*](/polymesh-sdk-api-reference/docs-v3/classes/defaultportfolio.md)*,* [*NumberedPortfolio*](/polymesh-sdk-api-reference/docs-v3/classes/numberedportfolio.md)*]›*
