# modules

[@polymeshassociation/polymesh-sdk](/polymesh-sdk-api-reference/docs-alpha/classes.md) / Modules

## @polymeshassociation/polymesh-sdk

### Table of contents

#### Modules

* [api/client/AccountManagement](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_accountmanagement.md)
* [api/client/Assets](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_assets.md)
* [api/client/Claims](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_claims.md)
* [api/client/Identities](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_identities.md)
* [api/client/Network](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_network.md)
* [api/client/Polymesh](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_polymesh.md)
* [api/client/Settlements](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_settlements.md)
* [api/entities/Account](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_account.md)
* [api/entities/Asset](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset.md)
* [api/entities/Asset/AssetHolders](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_assetholders.md)
* [api/entities/Asset/Checkpoints](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_checkpoints.md)
* [api/entities/Asset/Checkpoints/Schedules](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_checkpoints_schedules.md)
* [api/entities/Asset/Checkpoints/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_checkpoints_types.md)
* [api/entities/Asset/Compliance](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_compliance.md)
* [api/entities/Asset/Compliance/Requirements](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_compliance_requirements.md)
* [api/entities/Asset/Compliance/TrustedClaimIssuers](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_compliance_trustedclaimissuers.md)
* [api/entities/Asset/CorporateActions](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_corporateactions.md)
* [api/entities/Asset/CorporateActions/Distributions](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_corporateactions_distributions.md)
* [api/entities/Asset/CorporateActions/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_corporateactions_types.md)
* [api/entities/Asset/Documents](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_documents.md)
* [api/entities/Asset/Issuance](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_issuance.md)
* [api/entities/Asset/Offerings](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_offerings.md)
* [api/entities/Asset/Permissions](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_permissions.md)
* [api/entities/Asset/Settlements](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_settlements.md)
* [api/entities/Asset/TransferRestrictions](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_transferrestrictions.md)
* [api/entities/Asset/TransferRestrictions/Count](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_transferrestrictions_count.md)
* [api/entities/Asset/TransferRestrictions/Percentage](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_transferrestrictions_percentage.md)
* [api/entities/Asset/TransferRestrictions/TransferRestrictionBase](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_transferrestrictions_transferrestrictionbase.md)
* [api/entities/Asset/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_asset_types.md)
* [api/entities/AuthorizationRequest](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_authorizationrequest.md)
* [api/entities/Checkpoint](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_checkpoint.md)
* [api/entities/CheckpointSchedule](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_checkpointschedule.md)
* [api/entities/CheckpointSchedule/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_checkpointschedule_types.md)
* [api/entities/CorporateAction](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_corporateaction.md)
* [api/entities/CorporateActionBase](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_corporateactionbase.md)
* [api/entities/CorporateActionBase/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_corporateactionbase_types.md)
* [api/entities/CustomPermissionGroup](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_custompermissiongroup.md)
* [api/entities/DefaultPortfolio](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_defaultportfolio.md)
* [api/entities/DefaultTrustedClaimIssuer](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_defaulttrustedclaimissuer.md)
* [api/entities/DividendDistribution](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_dividenddistribution.md)
* [api/entities/DividendDistribution/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_dividenddistribution_types.md)
* [api/entities/Entity](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_entity.md)
* [api/entities/Identity](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity.md)
* [api/entities/Identity/AssetPermissions](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity_assetpermissions.md)
* [api/entities/Identity/IdentityAuthorizations](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity_identityauthorizations.md)
* [api/entities/Identity/Portfolios](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_identity_portfolios.md)
* [api/entities/Instruction](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_instruction.md)
* [api/entities/Instruction/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_instruction_types.md)
* [api/entities/KnownPermissionGroup](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_knownpermissiongroup.md)
* [api/entities/Namespace](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_namespace.md)
* [api/entities/NumberedPortfolio](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_numberedportfolio.md)
* [api/entities/Offering](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_offering.md)
* [api/entities/Offering/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_offering_types.md)
* [api/entities/PermissionGroup](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_permissiongroup.md)
* [api/entities/Portfolio](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_portfolio.md)
* [api/entities/Portfolio/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_portfolio_types.md)
* [api/entities/Subsidy](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_subsidy.md)
* [api/entities/Subsidy/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_subsidy_types.md)
* [api/entities/TickerReservation](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_tickerreservation.md)
* [api/entities/TickerReservation/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_tickerreservation_types.md)
* [api/entities/Venue](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_venue.md)
* [api/entities/Venue/types](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_venue_types.md)
* [api/entities/common/namespaces/Authorizations](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_entities_common_namespaces_authorizations.md)
* [api/procedures/addAssetRequirement](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_addassetrequirement.md)
* [api/procedures/addInstruction](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_addinstruction.md)
* [api/procedures/addInvestorUniquenessClaim](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_addinvestoruniquenessclaim.md)
* [api/procedures/addTransferRestriction](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_addtransferrestriction.md)
* [api/procedures/claimClassicTicker](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_claimclassicticker.md)
* [api/procedures/claimDividends](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_claimdividends.md)
* [api/procedures/closeOffering](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_closeoffering.md)
* [api/procedures/configureDividendDistribution](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_configuredividenddistribution.md)
* [api/procedures/consumeAddMultiSigSignerAuthorization](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_consumeaddmultisigsignerauthorization.md)
* [api/procedures/consumeAuthorizationRequests](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_consumeauthorizationrequests.md)
* [api/procedures/consumeJoinOrRotateAuthorization](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_consumejoinorrotateauthorization.md)
* [api/procedures/controllerTransfer](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_controllertransfer.md)
* [api/procedures/createAsset](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createasset.md)
* [api/procedures/createCheckpoint](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createcheckpoint.md)
* [api/procedures/createCheckpointSchedule](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createcheckpointschedule.md)
* [api/procedures/createGroup](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_creategroup.md)
* [api/procedures/createPortfolio](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createportfolio.md)
* [api/procedures/createVenue](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_createvenue.md)
* [api/procedures/deletePortfolio](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_deleteportfolio.md)
* [api/procedures/investInOffering](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_investinoffering.md)
* [api/procedures/inviteAccount](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_inviteaccount.md)
* [api/procedures/inviteExternalAgent](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_inviteexternalagent.md)
* [api/procedures/issueTokens](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_issuetokens.md)
* [api/procedures/launchOffering](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_launchoffering.md)
* [api/procedures/leaveIdentity](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_leaveidentity.md)
* [api/procedures/linkCaDocs](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_linkcadocs.md)
* [api/procedures/modifyAllowance](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyallowance.md)
* [api/procedures/modifyAsset](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyasset.md)
* [api/procedures/modifyAssetTrustedClaimIssuers](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyassettrustedclaimissuers.md)
* [api/procedures/modifyCaCheckpoint](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifycacheckpoint.md)
* [api/procedures/modifyCaDefaultConfig](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifycadefaultconfig.md)
* [api/procedures/modifyClaims](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyclaims.md)
* [api/procedures/modifyComplianceRequirement](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifycompliancerequirement.md)
* [api/procedures/modifyCorporateActionsAgent](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifycorporateactionsagent.md)
* [api/procedures/modifyDistributionCheckpoint](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifydistributioncheckpoint.md)
* [api/procedures/modifyInstructionAffirmation](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyinstructionaffirmation.md)
* [api/procedures/modifyOfferingTimes](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyofferingtimes.md)
* [api/procedures/modifyPrimaryIssuanceAgent](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyprimaryissuanceagent.md)
* [api/procedures/modifySignerPermissions](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifysignerpermissions.md)
* [api/procedures/modifyVenue](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_modifyvenue.md)
* [api/procedures/moveFunds](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_movefunds.md)
* [api/procedures/payDividends](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_paydividends.md)
* [api/procedures/quitCustody](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_quitcustody.md)
* [api/procedures/quitSubsidy](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_quitsubsidy.md)
* [api/procedures/reclaimDividendDistributionFunds](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_reclaimdividenddistributionfunds.md)
* [api/procedures/redeemTokens](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_redeemtokens.md)
* [api/procedures/registerIdentity](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_registeridentity.md)
* [api/procedures/removeAssetRequirement](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removeassetrequirement.md)
* [api/procedures/removeCheckpointSchedule](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removecheckpointschedule.md)
* [api/procedures/removeCorporateAction](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removecorporateaction.md)
* [api/procedures/removeCorporateActionsAgent](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removecorporateactionsagent.md)
* [api/procedures/removeExternalAgent](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removeexternalagent.md)
* [api/procedures/removePrimaryIssuanceAgent](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removeprimaryissuanceagent.md)
* [api/procedures/removeSecondaryAccounts](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_removesecondaryaccounts.md)
* [api/procedures/renamePortfolio](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_renameportfolio.md)
* [api/procedures/rescheduleInstruction](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_rescheduleinstruction.md)
* [api/procedures/reserveTicker](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_reserveticker.md)
* [api/procedures/setAssetDocuments](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setassetdocuments.md)
* [api/procedures/setAssetRequirements](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setassetrequirements.md)
* [api/procedures/setCustodian](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setcustodian.md)
* [api/procedures/setGroupPermissions](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setgrouppermissions.md)
* [api/procedures/setPermissionGroup](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_setpermissiongroup.md)
* [api/procedures/setTransferRestrictions](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_settransferrestrictions.md)
* [api/procedures/subsidizeAccount](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_subsidizeaccount.md)
* [api/procedures/toggleFreezeOffering](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_togglefreezeoffering.md)
* [api/procedures/toggleFreezeSecondaryAccounts](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_togglefreezesecondaryaccounts.md)
* [api/procedures/toggleFreezeTransfers](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_togglefreezetransfers.md)
* [api/procedures/togglePauseRequirements](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_togglepauserequirements.md)
* [api/procedures/transferAssetOwnership](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_transferassetownership.md)
* [api/procedures/transferPolyx](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_transferpolyx.md)
* [api/procedures/transferTickerOwnership](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_transfertickerownership.md)
* [api/procedures/utils](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_utils.md)
* [api/procedures/waivePermissions](/polymesh-sdk-api-reference/docs-alpha/modules-1/api_procedures_waivepermissions.md)
* [types](/polymesh-sdk-api-reference/docs-alpha/modules-1/types.md)
* [types/utils](/polymesh-sdk-api-reference/docs-alpha/modules-1/types_utils.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.