# icpmcp Developer-friendly & type-safe Typescript SDK specifically catered to leverage *icpmcp* API.


> [!IMPORTANT] > This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/rarible/protocol). Delete this section before > publishing to a package manager. ## Summary ## Table of Contents * [icpmcp](#icpmcp) * [SDK Installation](#sdk-installation) * [Requirements](#requirements) * [SDK Example Usage](#sdk-example-usage) * [Available Resources and Operations](#available-resources-and-operations) * [Standalone functions](#standalone-functions) * [Retries](#retries) * [Error Handling](#error-handling) * [Custom HTTP Client](#custom-http-client) * [Debugging](#debugging) * [Development](#development) * [Maturity](#maturity) * [Contributions](#contributions) ## SDK Installation > [!TIP] > To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide). The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers. ### NPM ```bash npm add ``` ### PNPM ```bash pnpm add ``` ### Bun ```bash bun add ``` ### Yarn ```bash yarn add zod # Note that Yarn does not install peer dependencies automatically. You will need # to install zod as shown above. ``` > [!NOTE] > This package is published with CommonJS and ES Modules (ESM) support. ### Model Context Protocol (MCP) Server This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications. > Node.js v20 or greater is required to run the MCP server from npm.
Claude installation steps Add the following server definition to your `claude_desktop_config.json` file: ```json { "mcpServers": { "Icpmcp": { "command": "npx", "args": [ "-y", "--package", "icpmcp", "--", "mcp", "start", "--server-url", "..." ] } } } ```
Cursor installation steps Create a `.cursor/mcp.json` file in your project root with the following content: ```json { "mcpServers": { "Icpmcp": { "command": "npx", "args": [ "-y", "--package", "icpmcp", "--", "mcp", "start", "--server-url", "..." ] } } } ```
You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases: ```bash curl -L -o mcp-server \ https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \ chmod +x mcp-server ``` If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`. ```json { "mcpServers": { "Todos": { "command": "./DOWNLOAD/PATH/mcp-server", "args": [ "start" ] } } } ``` For a full list of server arguments, run: ```sh npx -y --package icpmcp -- mcp start --help ``` ## Requirements For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md). ## SDK Example Usage ### Example ```typescript import { Icpmcp } from "icpmcp"; const icpmcp = new Icpmcp({ serverURL: "https://api.example.com", }); async function run() { const result = await icpmcp.avgIcpXdrConversionRates .getApiV3AvgIcpXdrConversionRates({}); console.log(result); } run(); ``` ## Available Resources and Operations
Available methods ### [avgIcpXdrConversionRates](docs/sdks/avgicpxdrconversionrates/README.md) * [getApiV3AvgIcpXdrConversionRates](docs/sdks/avgicpxdrconversionrates/README.md#getapiv3avgicpxdrconversionrates) ### [bitcoin](docs/sdks/bitcoin/README.md) * [getApiV3BitcoinMainChainHeight](docs/sdks/bitcoin/README.md#getapiv3bitcoinmainchainheight) * [getApiV3BitcoinNumberOfUtxos](docs/sdks/bitcoin/README.md#getapiv3bitcoinnumberofutxos) * [getApiV3BitcoinStableMemorySizeInBytes](docs/sdks/bitcoin/README.md#getapiv3bitcoinstablememorysizeinbytes) ### [blockHeights](docs/sdks/blockheights/README.md) * [getApiV3BlockHeights](docs/sdks/blockheights/README.md#getapiv3blockheights) ### [blockHeightsOverTime](docs/sdks/blockheightsovertime/README.md) * [getApiV3BlockHeightsOverTime](docs/sdks/blockheightsovertime/README.md#getapiv3blockheightsovertime) ### [boundaryNodeLocations](docs/sdks/boundarynodelocations/README.md) * [getApiV3BoundaryNodeLocations](docs/sdks/boundarynodelocations/README.md#getapiv3boundarynodelocations) ### [canisters](docs/sdks/canisters/README.md) * [getApiV3Canisters](docs/sdks/canisters/README.md#getapiv3canisters) * [getApiV3CanistersCanisterId](docs/sdks/canisters/README.md#getapiv3canisterscanisterid) * [getApiV3CanistersCanisterIdName](docs/sdks/canisters/README.md#getapiv3canisterscanisteridname) * [getApiV3CanistersNames](docs/sdks/canisters/README.md#getapiv3canistersnames) ### [dailyStats](docs/sdks/dailystats/README.md) * [getApiV3DailyStats](docs/sdks/dailystats/README.md#getapiv3dailystats) * [getApiV3DailyStatsMaxTotalTransactionsPerSecTillDate](docs/sdks/dailystats/README.md#getapiv3dailystatsmaxtotaltransactionspersectilldate) * [getApiV3DailyStatsMaxUpdateTransactionsPerSecTillDate](docs/sdks/dailystats/README.md#getapiv3dailystatsmaxupdatetransactionspersectilldate) * [getApiV3DailyStatsMaxQueryTransactionsPerSecTillDate](docs/sdks/dailystats/README.md#getapiv3dailystatsmaxquerytransactionspersectilldate) ### [dataCenters](docs/sdks/datacenters/README.md) * [getApiV3DataCenters](docs/sdks/datacenters/README.md#getapiv3datacenters) * [getApiV3DataCentersDcId](docs/sdks/datacenters/README.md#getapiv3datacentersdcid) ### [governanceMetrics](docs/sdks/governancemetrics/README.md) * [getApiV3GovernanceMetrics](docs/sdks/governancemetrics/README.md#getapiv3governancemetrics) * [~~getApiV3StakingMetrics~~](docs/sdks/governancemetrics/README.md#getapiv3stakingmetrics) - :warning: **Deprecated** * [getApiV3GovernanceMetricsName](docs/sdks/governancemetrics/README.md#getapiv3governancemetricsname) * [~~getApiV3StakingMetricsName~~](docs/sdks/governancemetrics/README.md#getapiv3stakingmetricsname) - :warning: **Deprecated** ### [healthCheck](docs/sdks/healthcheck/README.md) * [getApiV3HealthCheck](docs/sdks/healthcheck/README.md#getapiv3healthcheck) ### [icpUsdRate](docs/sdks/icpusdrate/README.md) * [getApiV3IcpUsdRate](docs/sdks/icpusdrate/README.md#getapiv3icpusdrate) * [getApiV3IcpUsdPercentChange24h](docs/sdks/icpusdrate/README.md#getapiv3icpusdpercentchange24h) ### [icpXdrConversionRates](docs/sdks/icpxdrconversionrates/README.md) * [getApiV3IcpXdrConversionRates](docs/sdks/icpxdrconversionrates/README.md#getapiv3icpxdrconversionrates) ### [images](docs/sdks/images/README.md) * [getApiV3ImagesProposalsProposalIdPng](docs/sdks/images/README.md#getapiv3imagesproposalsproposalidpng) * [getApiV3ImagesCanistersCanisterIdPng](docs/sdks/images/README.md#getapiv3imagescanisterscanisteridpng) * [getApiV3ImagesDataCentersDcIdPng](docs/sdks/images/README.md#getapiv3imagesdatacentersdcidpng) * [getApiV3ImagesNeuronsNeuronIdPng](docs/sdks/images/README.md#getapiv3imagesneuronsneuronidpng) * [getApiV3ImagesNodesNodeIdPng](docs/sdks/images/README.md#getapiv3imagesnodesnodeidpng) * [getApiV3ImagesNodeProvidersNodeProviderIdPng](docs/sdks/images/README.md#getapiv3imagesnodeprovidersnodeprovideridpng) * [getApiV3ImagesSubnetReplicaVersionsReplicaVersionIdPng](docs/sdks/images/README.md#getapiv3imagessubnetreplicaversionsreplicaversionidpng) * [getApiV3ImagesSubnetsSubnetIdPng](docs/sdks/images/README.md#getapiv3imagessubnetssubnetidpng) * [getApiV3ImagesAccountsAccountAddressPng](docs/sdks/images/README.md#getapiv3imagesaccountsaccountaddresspng) * [getApiV3ImagesAccountsAccountAddressTransactionFlowPng](docs/sdks/images/README.md#getapiv3imagesaccountsaccountaddresstransactionflowpng) * [getApiV3ImagesTransactionsTransactionHashPng](docs/sdks/images/README.md#getapiv3imagestransactionstransactionhashpng) ### [messagesCounts](docs/sdks/messagescounts/README.md) * [getApiV3MessagesCounts](docs/sdks/messagescounts/README.md#getapiv3messagescounts) ### [messagesCountsOverTime](docs/sdks/messagescountsovertime/README.md) * [getApiV3MessagesCountsOverTime](docs/sdks/messagescountsovertime/README.md#getapiv3messagescountsovertime) ### [metrics](docs/sdks/metrics/README.md) * [getApiV3MetricsMessageExecutionRate](docs/sdks/metrics/README.md#getapiv3metricsmessageexecutionrate) * [getApiV3MetricsIcNodesCount](docs/sdks/metrics/README.md#getapiv3metricsicnodescount) * [getApiV3MetricsIcMemoryTotal](docs/sdks/metrics/README.md#getapiv3metricsicmemorytotal) * [getApiV3MetricsIcCpuCores](docs/sdks/metrics/README.md#getapiv3metricsiccpucores) * [getApiV3MetricsIcMemoryUsage](docs/sdks/metrics/README.md#getapiv3metricsicmemoryusage) * [~~getApiV3MetricsMemory~~](docs/sdks/metrics/README.md#getapiv3metricsmemory) - :warning: **Deprecated** * [getApiV3MetricsBlockRate](docs/sdks/metrics/README.md#getapiv3metricsblockrate) * [~~getApiV3MetricsBlockCount~~](docs/sdks/metrics/README.md#getapiv3metricsblockcount) - :warning: **Deprecated** * [~~getApiV3MetricsEgressBandwidth~~](docs/sdks/metrics/README.md#getapiv3metricsegressbandwidth) - :warning: **Deprecated** * [~~getApiV3MetricsIngressBandwidth~~](docs/sdks/metrics/README.md#getapiv3metricsingressbandwidth) - :warning: **Deprecated** * [getApiV3MetricsBoundaryNodesCount](docs/sdks/metrics/README.md#getapiv3metricsboundarynodescount) * [getApiV3MetricsGovernanceNeuronsTotal](docs/sdks/metrics/README.md#getapiv3metricsgovernanceneuronstotal) * [getApiV3MetricsInternetIdentityUserCount](docs/sdks/metrics/README.md#getapiv3metricsinternetidentityusercount) * [getApiV3MetricsGovernanceVotingPowerTotal](docs/sdks/metrics/README.md#getapiv3metricsgovernancevotingpowertotal) * [getApiV3MetricsAverageGovernanceVotingPowerTotal](docs/sdks/metrics/README.md#getapiv3metricsaveragegovernancevotingpowertotal) * [getApiV3MetricsCycleBurnRate](docs/sdks/metrics/README.md#getapiv3metricscycleburnrate) * [getApiV3MetricsIcSubnetTotal](docs/sdks/metrics/README.md#getapiv3metricsicsubnettotal) * [getApiV3MetricsLastRewardEvent](docs/sdks/metrics/README.md#getapiv3metricslastrewardevent) * [getApiV3MetricsLatestRewardEventTotalAvailable](docs/sdks/metrics/README.md#getapiv3metricslatestrewardeventtotalavailable) * [getApiV3MetricsAverageLastRewardEvent](docs/sdks/metrics/README.md#getapiv3metricsaveragelastrewardevent) * [getApiV3MetricsCommunityFundTotalStaked](docs/sdks/metrics/README.md#getapiv3metricscommunityfundtotalstaked) * [getApiV3MetricsCommunityFundTotalMaturity](docs/sdks/metrics/README.md#getapiv3metricscommunityfundtotalmaturity) * [getApiV3MetricsTotalRewardableNodesCount](docs/sdks/metrics/README.md#getapiv3metricstotalrewardablenodescount) * [getApiV3MetricsRegisteredCanistersCount](docs/sdks/metrics/README.md#getapiv3metricsregisteredcanisterscount) * [getApiV3MetricsBlockHeight](docs/sdks/metrics/README.md#getapiv3metricsblockheight) * [~~getApiV3MetricsTotalActiveNodesCount~~](docs/sdks/metrics/README.md#getapiv3metricstotalactivenodescount) - :warning: **Deprecated** * [~~getApiV3MetricsTotalAwaitingNodesCount~~](docs/sdks/metrics/README.md#getapiv3metricstotalawaitingnodescount) - :warning: **Deprecated** * [~~getApiV3MetricsTotalOfflineNodesCount~~](docs/sdks/metrics/README.md#getapiv3metricstotalofflinenodescount) - :warning: **Deprecated** * [~~getApiV3MetricsEnergyConsumptionRate~~](docs/sdks/metrics/README.md#getapiv3metricsenergyconsumptionrate) - Deprecated: Use `/api/v3/metrics/node-energy-consumption-rate-kwh` and `/api/v3/metrics/total-ic-energy-consumption-rate-kwh` instead :warning: **Deprecated** * [getApiV3MetricsTotalIcEnergyConsumptionRateKwh](docs/sdks/metrics/README.md#getapiv3metricstotalicenergyconsumptionratekwh) * [getApiV3MetricsNodeEnergyConsumptionRateKwh](docs/sdks/metrics/README.md#getapiv3metricsnodeenergyconsumptionratekwh) * [~~getApiV3MetricsTransactionRate~~](docs/sdks/metrics/README.md#getapiv3metricstransactionrate) - :warning: **Deprecated** * [getApiV3MetricsMaxTransactionsPerSecOver90Days](docs/sdks/metrics/README.md#getapiv3metricsmaxtransactionspersecover90days) * [getApiV3MetricsInstructionRate](docs/sdks/metrics/README.md#getapiv3metricsinstructionrate) * [getApiV3MetricsAverageCycleBurnRate](docs/sdks/metrics/README.md#getapiv3metricsaveragecycleburnrate) * [getApiV3MetricsIcpTxnVsEthTxn](docs/sdks/metrics/README.md#getapiv3metricsicptxnvsethtxn) * [getApiV3MetricsEthEquivalentTxns](docs/sdks/metrics/README.md#getapiv3metricsethequivalenttxns) * [getApiV3MetricsGovernanceNotDissolvingNeuronsE8s1year](docs/sdks/metrics/README.md#getapiv3metricsgovernancenotdissolvingneuronse8s1year) * [getApiV3MetricsGovernanceDissolvingNeuronsE8s1year](docs/sdks/metrics/README.md#getapiv3metricsgovernancedissolvingneuronse8s1year) * [getApiV3MetricsGovernanceNotDissolvingNeuronsStakedMaturityE8sEquivalent1year](docs/sdks/metrics/README.md#getapiv3metricsgovernancenotdissolvingneuronsstakedmaturitye8sequivalent1year) * [getApiV3MetricsGovernanceDissolvingNeuronsStakedMaturityE8sEquivalent1year](docs/sdks/metrics/README.md#getapiv3metricsgovernancedissolvingneuronsstakedmaturitye8sequivalent1year) ### [networkEconomicsParameters](docs/sdks/networkeconomicsparameters/README.md) * [getApiV3NetworkEconomicsParametersParameter](docs/sdks/networkeconomicsparameters/README.md#getapiv3networkeconomicsparametersparameter) - Get network economics parameter by name. ### [neuronMaturityModulations](docs/sdks/neuronmaturitymodulations/README.md) * [getApiV3NeuronMaturityModulations](docs/sdks/neuronmaturitymodulations/README.md#getapiv3neuronmaturitymodulations) ### [neurons](docs/sdks/neurons/README.md) * [getApiV3Neurons](docs/sdks/neurons/README.md#getapiv3neurons) * [getApiV3NeuronsNeuronId](docs/sdks/neurons/README.md#getapiv3neuronsneuronid) * [getApiV3NeuronsNeuronIdRecentBallots](docs/sdks/neurons/README.md#getapiv3neuronsneuronidrecentballots) * [getApiV3KnownNeuronsNeuronIdBallots](docs/sdks/neurons/README.md#getapiv3knownneuronsneuronidballots) * [getApiV3NeuronsNeuronIdBallots](docs/sdks/neurons/README.md#getapiv3neuronsneuronidballots) ### [~~neuronVotingPowers~~](docs/sdks/neuronvotingpowers/README.md) * [~~getApiV3NeuronVotingPowers~~](docs/sdks/neuronvotingpowers/README.md#getapiv3neuronvotingpowers) - :warning: **Deprecated** ### [nodeProviders](docs/sdks/nodeproviders/README.md) * [getApiV3NodeProviders](docs/sdks/nodeproviders/README.md#getapiv3nodeproviders) * [getApiV3NodeProvidersNodeProviderId](docs/sdks/nodeproviders/README.md#getapiv3nodeprovidersnodeproviderid) * [getApiV3NodeProvidersNodeProviderIdNodes](docs/sdks/nodeproviders/README.md#getapiv3nodeprovidersnodeprovideridnodes) * [getApiV3NodeProvidersCount](docs/sdks/nodeproviders/README.md#getapiv3nodeproviderscount) ### [nodes](docs/sdks/nodes/README.md) * [getApiV3Nodes](docs/sdks/nodes/README.md#getapiv3nodes) * [getApiV3NodesNodeId](docs/sdks/nodes/README.md#getapiv3nodesnodeid) ### [participationRates](docs/sdks/participationrates/README.md) * [getApiV3ParticipationRates](docs/sdks/participationrates/README.md#getapiv3participationrates) ### [proposalDeadlineExtensions](docs/sdks/proposaldeadlineextensions/README.md) * [getApiV3ProposalsProposalIdDeadlineExtensions](docs/sdks/proposaldeadlineextensions/README.md#getapiv3proposalsproposaliddeadlineextensions) ### [proposals](docs/sdks/proposals/README.md) * [getApiV3Proposals](docs/sdks/proposals/README.md#getapiv3proposals) * [getApiV3NnsParticipationRate](docs/sdks/proposals/README.md#getapiv3nnsparticipationrate) * [getApiV3ProposalsProposalId](docs/sdks/proposals/README.md#getapiv3proposalsproposalid) * [getApiV3ProposalsCount](docs/sdks/proposals/README.md#getapiv3proposalscount) * [getApiV3LatestProposalId](docs/sdks/proposals/README.md#getapiv3latestproposalid) * [~~getApiV3MetricsLatestProposalId~~](docs/sdks/proposals/README.md#getapiv3metricslatestproposalid) - :warning: **Deprecated** * [getApiV3ProposalsOverPast7d](docs/sdks/proposals/README.md#getapiv3proposalsoverpast7d) ### [proposalsOverTime](docs/sdks/proposalsovertime/README.md) * [getApiV3ProposalsOverTime](docs/sdks/proposalsovertime/README.md#getapiv3proposalsovertime) ### [proposalTallies](docs/sdks/proposaltallies/README.md) * [getApiV3ProposalsProposalIdTallies](docs/sdks/proposaltallies/README.md#getapiv3proposalsproposalidtallies) ### [rewardNodeProviders](docs/sdks/rewardnodeproviders/README.md) * [getApiV3TimeseriesRewardNodeProviders](docs/sdks/rewardnodeproviders/README.md#getapiv3timeseriesrewardnodeproviders) * [getApiV3RewardNodeProviders](docs/sdks/rewardnodeproviders/README.md#getapiv3rewardnodeproviders) * [getApiV3RewardNodeProvidersId](docs/sdks/rewardnodeproviders/README.md#getapiv3rewardnodeprovidersid) ### [root](docs/sdks/root/README.md) * [getApiV3](docs/sdks/root/README.md#getapiv3) * [getApiV3Changelog](docs/sdks/root/README.md#getapiv3changelog) ### [subnetReplicaVersions](docs/sdks/subnetreplicaversions/README.md) * [getApiV3SubnetReplicaVersions](docs/sdks/subnetreplicaversions/README.md#getapiv3subnetreplicaversions) * [getApiV3SubnetReplicaVersionsReplicaVersionId](docs/sdks/subnetreplicaversions/README.md#getapiv3subnetreplicaversionsreplicaversionid) ### [subnets](docs/sdks/subnets/README.md) * [getApiV3Subnets](docs/sdks/subnets/README.md#getapiv3subnets) * [getApiV3SubnetsSubnetId](docs/sdks/subnets/README.md#getapiv3subnetssubnetid) ### [v4BoundaryNodeDataCenters](docs/sdks/v4boundarynodedatacenters/README.md) * [getApiV4BoundaryNodeDataCenters](docs/sdks/v4boundarynodedatacenters/README.md#getapiv4boundarynodedatacenters) ### [v4NeuronVotingPowers](docs/sdks/v4neuronvotingpowers/README.md) * [getApiV4NeuronVotingPowers](docs/sdks/v4neuronvotingpowers/README.md#getapiv4neuronvotingpowers) ### [v4Subnets](docs/sdks/v4subnets/README.md) * [getApiV4Subnets](docs/sdks/v4subnets/README.md#getapiv4subnets) * [getApiV4SubnetsSubnetId](docs/sdks/v4subnets/README.md#getapiv4subnetssubnetid) * [getApiV4SubnetsCount](docs/sdks/v4subnets/README.md#getapiv4subnetscount)
## Standalone functions All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away. To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
Available standalone functions - [`avgIcpXdrConversionRatesGetApiV3AvgIcpXdrConversionRates`](docs/sdks/avgicpxdrconversionrates/README.md#getapiv3avgicpxdrconversionrates) - [`bitcoinGetApiV3BitcoinMainChainHeight`](docs/sdks/bitcoin/README.md#getapiv3bitcoinmainchainheight) - [`bitcoinGetApiV3BitcoinNumberOfUtxos`](docs/sdks/bitcoin/README.md#getapiv3bitcoinnumberofutxos) - [`bitcoinGetApiV3BitcoinStableMemorySizeInBytes`](docs/sdks/bitcoin/README.md#getapiv3bitcoinstablememorysizeinbytes) - [`blockHeightsGetApiV3BlockHeights`](docs/sdks/blockheights/README.md#getapiv3blockheights) - [`blockHeightsOverTimeGetApiV3BlockHeightsOverTime`](docs/sdks/blockheightsovertime/README.md#getapiv3blockheightsovertime) - [`boundaryNodeLocationsGetApiV3BoundaryNodeLocations`](docs/sdks/boundarynodelocations/README.md#getapiv3boundarynodelocations) - [`canistersGetApiV3Canisters`](docs/sdks/canisters/README.md#getapiv3canisters) - [`canistersGetApiV3CanistersCanisterId`](docs/sdks/canisters/README.md#getapiv3canisterscanisterid) - [`canistersGetApiV3CanistersCanisterIdName`](docs/sdks/canisters/README.md#getapiv3canisterscanisteridname) - [`canistersGetApiV3CanistersNames`](docs/sdks/canisters/README.md#getapiv3canistersnames) - [`dailyStatsGetApiV3DailyStats`](docs/sdks/dailystats/README.md#getapiv3dailystats) - [`dailyStatsGetApiV3DailyStatsMaxQueryTransactionsPerSecTillDate`](docs/sdks/dailystats/README.md#getapiv3dailystatsmaxquerytransactionspersectilldate) - [`dailyStatsGetApiV3DailyStatsMaxTotalTransactionsPerSecTillDate`](docs/sdks/dailystats/README.md#getapiv3dailystatsmaxtotaltransactionspersectilldate) - [`dailyStatsGetApiV3DailyStatsMaxUpdateTransactionsPerSecTillDate`](docs/sdks/dailystats/README.md#getapiv3dailystatsmaxupdatetransactionspersectilldate) - [`dataCentersGetApiV3DataCenters`](docs/sdks/datacenters/README.md#getapiv3datacenters) - [`dataCentersGetApiV3DataCentersDcId`](docs/sdks/datacenters/README.md#getapiv3datacentersdcid) - [`governanceMetricsGetApiV3GovernanceMetrics`](docs/sdks/governancemetrics/README.md#getapiv3governancemetrics) - [`governanceMetricsGetApiV3GovernanceMetricsName`](docs/sdks/governancemetrics/README.md#getapiv3governancemetricsname) - [`healthCheckGetApiV3HealthCheck`](docs/sdks/healthcheck/README.md#getapiv3healthcheck) - [`icpUsdRateGetApiV3IcpUsdPercentChange24h`](docs/sdks/icpusdrate/README.md#getapiv3icpusdpercentchange24h) - [`icpUsdRateGetApiV3IcpUsdRate`](docs/sdks/icpusdrate/README.md#getapiv3icpusdrate) - [`icpXdrConversionRatesGetApiV3IcpXdrConversionRates`](docs/sdks/icpxdrconversionrates/README.md#getapiv3icpxdrconversionrates) - [`imagesGetApiV3ImagesAccountsAccountAddressPng`](docs/sdks/images/README.md#getapiv3imagesaccountsaccountaddresspng) - [`imagesGetApiV3ImagesAccountsAccountAddressTransactionFlowPng`](docs/sdks/images/README.md#getapiv3imagesaccountsaccountaddresstransactionflowpng) - [`imagesGetApiV3ImagesCanistersCanisterIdPng`](docs/sdks/images/README.md#getapiv3imagescanisterscanisteridpng) - [`imagesGetApiV3ImagesDataCentersDcIdPng`](docs/sdks/images/README.md#getapiv3imagesdatacentersdcidpng) - [`imagesGetApiV3ImagesNeuronsNeuronIdPng`](docs/sdks/images/README.md#getapiv3imagesneuronsneuronidpng) - [`imagesGetApiV3ImagesNodeProvidersNodeProviderIdPng`](docs/sdks/images/README.md#getapiv3imagesnodeprovidersnodeprovideridpng) - [`imagesGetApiV3ImagesNodesNodeIdPng`](docs/sdks/images/README.md#getapiv3imagesnodesnodeidpng) - [`imagesGetApiV3ImagesProposalsProposalIdPng`](docs/sdks/images/README.md#getapiv3imagesproposalsproposalidpng) - [`imagesGetApiV3ImagesSubnetReplicaVersionsReplicaVersionIdPng`](docs/sdks/images/README.md#getapiv3imagessubnetreplicaversionsreplicaversionidpng) - [`imagesGetApiV3ImagesSubnetsSubnetIdPng`](docs/sdks/images/README.md#getapiv3imagessubnetssubnetidpng) - [`imagesGetApiV3ImagesTransactionsTransactionHashPng`](docs/sdks/images/README.md#getapiv3imagestransactionstransactionhashpng) - [`messagesCountsGetApiV3MessagesCounts`](docs/sdks/messagescounts/README.md#getapiv3messagescounts) - [`messagesCountsOverTimeGetApiV3MessagesCountsOverTime`](docs/sdks/messagescountsovertime/README.md#getapiv3messagescountsovertime) - [`metricsGetApiV3MetricsAverageCycleBurnRate`](docs/sdks/metrics/README.md#getapiv3metricsaveragecycleburnrate) - [`metricsGetApiV3MetricsAverageGovernanceVotingPowerTotal`](docs/sdks/metrics/README.md#getapiv3metricsaveragegovernancevotingpowertotal) - [`metricsGetApiV3MetricsAverageLastRewardEvent`](docs/sdks/metrics/README.md#getapiv3metricsaveragelastrewardevent) - [`metricsGetApiV3MetricsBlockHeight`](docs/sdks/metrics/README.md#getapiv3metricsblockheight) - [`metricsGetApiV3MetricsBlockRate`](docs/sdks/metrics/README.md#getapiv3metricsblockrate) - [`metricsGetApiV3MetricsBoundaryNodesCount`](docs/sdks/metrics/README.md#getapiv3metricsboundarynodescount) - [`metricsGetApiV3MetricsCommunityFundTotalMaturity`](docs/sdks/metrics/README.md#getapiv3metricscommunityfundtotalmaturity) - [`metricsGetApiV3MetricsCommunityFundTotalStaked`](docs/sdks/metrics/README.md#getapiv3metricscommunityfundtotalstaked) - [`metricsGetApiV3MetricsCycleBurnRate`](docs/sdks/metrics/README.md#getapiv3metricscycleburnrate) - [`metricsGetApiV3MetricsEthEquivalentTxns`](docs/sdks/metrics/README.md#getapiv3metricsethequivalenttxns) - [`metricsGetApiV3MetricsGovernanceDissolvingNeuronsE8s1year`](docs/sdks/metrics/README.md#getapiv3metricsgovernancedissolvingneuronse8s1year) - [`metricsGetApiV3MetricsGovernanceDissolvingNeuronsStakedMaturityE8sEquivalent1year`](docs/sdks/metrics/README.md#getapiv3metricsgovernancedissolvingneuronsstakedmaturitye8sequivalent1year) - [`metricsGetApiV3MetricsGovernanceNeuronsTotal`](docs/sdks/metrics/README.md#getapiv3metricsgovernanceneuronstotal) - [`metricsGetApiV3MetricsGovernanceNotDissolvingNeuronsE8s1year`](docs/sdks/metrics/README.md#getapiv3metricsgovernancenotdissolvingneuronse8s1year) - [`metricsGetApiV3MetricsGovernanceNotDissolvingNeuronsStakedMaturityE8sEquivalent1year`](docs/sdks/metrics/README.md#getapiv3metricsgovernancenotdissolvingneuronsstakedmaturitye8sequivalent1year) - [`metricsGetApiV3MetricsGovernanceVotingPowerTotal`](docs/sdks/metrics/README.md#getapiv3metricsgovernancevotingpowertotal) - [`metricsGetApiV3MetricsIcCpuCores`](docs/sdks/metrics/README.md#getapiv3metricsiccpucores) - [`metricsGetApiV3MetricsIcMemoryTotal`](docs/sdks/metrics/README.md#getapiv3metricsicmemorytotal) - [`metricsGetApiV3MetricsIcMemoryUsage`](docs/sdks/metrics/README.md#getapiv3metricsicmemoryusage) - [`metricsGetApiV3MetricsIcNodesCount`](docs/sdks/metrics/README.md#getapiv3metricsicnodescount) - [`metricsGetApiV3MetricsIcpTxnVsEthTxn`](docs/sdks/metrics/README.md#getapiv3metricsicptxnvsethtxn) - [`metricsGetApiV3MetricsIcSubnetTotal`](docs/sdks/metrics/README.md#getapiv3metricsicsubnettotal) - [`metricsGetApiV3MetricsInstructionRate`](docs/sdks/metrics/README.md#getapiv3metricsinstructionrate) - [`metricsGetApiV3MetricsInternetIdentityUserCount`](docs/sdks/metrics/README.md#getapiv3metricsinternetidentityusercount) - [`metricsGetApiV3MetricsLastRewardEvent`](docs/sdks/metrics/README.md#getapiv3metricslastrewardevent) - [`metricsGetApiV3MetricsLatestRewardEventTotalAvailable`](docs/sdks/metrics/README.md#getapiv3metricslatestrewardeventtotalavailable) - [`metricsGetApiV3MetricsMaxTransactionsPerSecOver90Days`](docs/sdks/metrics/README.md#getapiv3metricsmaxtransactionspersecover90days) - [`metricsGetApiV3MetricsMessageExecutionRate`](docs/sdks/metrics/README.md#getapiv3metricsmessageexecutionrate) - [`metricsGetApiV3MetricsNodeEnergyConsumptionRateKwh`](docs/sdks/metrics/README.md#getapiv3metricsnodeenergyconsumptionratekwh) - [`metricsGetApiV3MetricsRegisteredCanistersCount`](docs/sdks/metrics/README.md#getapiv3metricsregisteredcanisterscount) - [`metricsGetApiV3MetricsTotalIcEnergyConsumptionRateKwh`](docs/sdks/metrics/README.md#getapiv3metricstotalicenergyconsumptionratekwh) - [`metricsGetApiV3MetricsTotalRewardableNodesCount`](docs/sdks/metrics/README.md#getapiv3metricstotalrewardablenodescount) - [`networkEconomicsParametersGetApiV3NetworkEconomicsParametersParameter`](docs/sdks/networkeconomicsparameters/README.md#getapiv3networkeconomicsparametersparameter) - Get network economics parameter by name. - [`neuronMaturityModulationsGetApiV3NeuronMaturityModulations`](docs/sdks/neuronmaturitymodulations/README.md#getapiv3neuronmaturitymodulations) - [`neuronsGetApiV3KnownNeuronsNeuronIdBallots`](docs/sdks/neurons/README.md#getapiv3knownneuronsneuronidballots) - [`neuronsGetApiV3Neurons`](docs/sdks/neurons/README.md#getapiv3neurons) - [`neuronsGetApiV3NeuronsNeuronId`](docs/sdks/neurons/README.md#getapiv3neuronsneuronid) - [`neuronsGetApiV3NeuronsNeuronIdBallots`](docs/sdks/neurons/README.md#getapiv3neuronsneuronidballots) - [`neuronsGetApiV3NeuronsNeuronIdRecentBallots`](docs/sdks/neurons/README.md#getapiv3neuronsneuronidrecentballots) - [`nodeProvidersGetApiV3NodeProviders`](docs/sdks/nodeproviders/README.md#getapiv3nodeproviders) - [`nodeProvidersGetApiV3NodeProvidersCount`](docs/sdks/nodeproviders/README.md#getapiv3nodeproviderscount) - [`nodeProvidersGetApiV3NodeProvidersNodeProviderId`](docs/sdks/nodeproviders/README.md#getapiv3nodeprovidersnodeproviderid) - [`nodeProvidersGetApiV3NodeProvidersNodeProviderIdNodes`](docs/sdks/nodeproviders/README.md#getapiv3nodeprovidersnodeprovideridnodes) - [`nodesGetApiV3Nodes`](docs/sdks/nodes/README.md#getapiv3nodes) - [`nodesGetApiV3NodesNodeId`](docs/sdks/nodes/README.md#getapiv3nodesnodeid) - [`participationRatesGetApiV3ParticipationRates`](docs/sdks/participationrates/README.md#getapiv3participationrates) - [`proposalDeadlineExtensionsGetApiV3ProposalsProposalIdDeadlineExtensions`](docs/sdks/proposaldeadlineextensions/README.md#getapiv3proposalsproposaliddeadlineextensions) - [`proposalsGetApiV3LatestProposalId`](docs/sdks/proposals/README.md#getapiv3latestproposalid) - [`proposalsGetApiV3NnsParticipationRate`](docs/sdks/proposals/README.md#getapiv3nnsparticipationrate) - [`proposalsGetApiV3Proposals`](docs/sdks/proposals/README.md#getapiv3proposals) - [`proposalsGetApiV3ProposalsCount`](docs/sdks/proposals/README.md#getapiv3proposalscount) - [`proposalsGetApiV3ProposalsOverPast7d`](docs/sdks/proposals/README.md#getapiv3proposalsoverpast7d) - [`proposalsGetApiV3ProposalsProposalId`](docs/sdks/proposals/README.md#getapiv3proposalsproposalid) - [`proposalsOverTimeGetApiV3ProposalsOverTime`](docs/sdks/proposalsovertime/README.md#getapiv3proposalsovertime) - [`proposalTalliesGetApiV3ProposalsProposalIdTallies`](docs/sdks/proposaltallies/README.md#getapiv3proposalsproposalidtallies) - [`rewardNodeProvidersGetApiV3RewardNodeProviders`](docs/sdks/rewardnodeproviders/README.md#getapiv3rewardnodeproviders) - [`rewardNodeProvidersGetApiV3RewardNodeProvidersId`](docs/sdks/rewardnodeproviders/README.md#getapiv3rewardnodeprovidersid) - [`rewardNodeProvidersGetApiV3TimeseriesRewardNodeProviders`](docs/sdks/rewardnodeproviders/README.md#getapiv3timeseriesrewardnodeproviders) - [`rootGetApiV3`](docs/sdks/root/README.md#getapiv3) - [`rootGetApiV3Changelog`](docs/sdks/root/README.md#getapiv3changelog) - [`subnetReplicaVersionsGetApiV3SubnetReplicaVersions`](docs/sdks/subnetreplicaversions/README.md#getapiv3subnetreplicaversions) - [`subnetReplicaVersionsGetApiV3SubnetReplicaVersionsReplicaVersionId`](docs/sdks/subnetreplicaversions/README.md#getapiv3subnetreplicaversionsreplicaversionid) - [`subnetsGetApiV3Subnets`](docs/sdks/subnets/README.md#getapiv3subnets) - [`subnetsGetApiV3SubnetsSubnetId`](docs/sdks/subnets/README.md#getapiv3subnetssubnetid) - [`v4BoundaryNodeDataCentersGetApiV4BoundaryNodeDataCenters`](docs/sdks/v4boundarynodedatacenters/README.md#getapiv4boundarynodedatacenters) - [`v4NeuronVotingPowersGetApiV4NeuronVotingPowers`](docs/sdks/v4neuronvotingpowers/README.md#getapiv4neuronvotingpowers) - [`v4SubnetsGetApiV4Subnets`](docs/sdks/v4subnets/README.md#getapiv4subnets) - [`v4SubnetsGetApiV4SubnetsCount`](docs/sdks/v4subnets/README.md#getapiv4subnetscount) - [`v4SubnetsGetApiV4SubnetsSubnetId`](docs/sdks/v4subnets/README.md#getapiv4subnetssubnetid) - ~~[`governanceMetricsGetApiV3StakingMetrics`](docs/sdks/governancemetrics/README.md#getapiv3stakingmetrics)~~ - :warning: **Deprecated** - ~~[`governanceMetricsGetApiV3StakingMetricsName`](docs/sdks/governancemetrics/README.md#getapiv3stakingmetricsname)~~ - :warning: **Deprecated** - ~~[`metricsGetApiV3MetricsBlockCount`](docs/sdks/metrics/README.md#getapiv3metricsblockcount)~~ - :warning: **Deprecated** - ~~[`metricsGetApiV3MetricsEgressBandwidth`](docs/sdks/metrics/README.md#getapiv3metricsegressbandwidth)~~ - :warning: **Deprecated** - ~~[`metricsGetApiV3MetricsEnergyConsumptionRate`](docs/sdks/metrics/README.md#getapiv3metricsenergyconsumptionrate)~~ - Deprecated: Use `/api/v3/metrics/node-energy-consumption-rate-kwh` and `/api/v3/metrics/total-ic-energy-consumption-rate-kwh` instead :warning: **Deprecated** - ~~[`metricsGetApiV3MetricsIngressBandwidth`](docs/sdks/metrics/README.md#getapiv3metricsingressbandwidth)~~ - :warning: **Deprecated** - ~~[`metricsGetApiV3MetricsMemory`](docs/sdks/metrics/README.md#getapiv3metricsmemory)~~ - :warning: **Deprecated** - ~~[`metricsGetApiV3MetricsTotalActiveNodesCount`](docs/sdks/metrics/README.md#getapiv3metricstotalactivenodescount)~~ - :warning: **Deprecated** - ~~[`metricsGetApiV3MetricsTotalAwaitingNodesCount`](docs/sdks/metrics/README.md#getapiv3metricstotalawaitingnodescount)~~ - :warning: **Deprecated** - ~~[`metricsGetApiV3MetricsTotalOfflineNodesCount`](docs/sdks/metrics/README.md#getapiv3metricstotalofflinenodescount)~~ - :warning: **Deprecated** - ~~[`metricsGetApiV3MetricsTransactionRate`](docs/sdks/metrics/README.md#getapiv3metricstransactionrate)~~ - :warning: **Deprecated** - ~~[`neuronVotingPowersGetApiV3NeuronVotingPowers`](docs/sdks/neuronvotingpowers/README.md#getapiv3neuronvotingpowers)~~ - :warning: **Deprecated** - ~~[`proposalsGetApiV3MetricsLatestProposalId`](docs/sdks/proposals/README.md#getapiv3metricslatestproposalid)~~ - :warning: **Deprecated**
## Retries Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: ```typescript import { Icpmcp } from "icpmcp"; const icpmcp = new Icpmcp({ serverURL: "https://api.example.com", }); async function run() { const result = await icpmcp.avgIcpXdrConversionRates .getApiV3AvgIcpXdrConversionRates({}, { retries: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, }); console.log(result); } run(); ``` If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: ```typescript import { Icpmcp } from "icpmcp"; const icpmcp = new Icpmcp({ serverURL: "https://api.example.com", retryConfig: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, }); async function run() { const result = await icpmcp.avgIcpXdrConversionRates .getApiV3AvgIcpXdrConversionRates({}); console.log(result); } run(); ``` ## Error Handling [`IcpmcpError`](./src/models/errors/icpmcperror.ts) is the base class for all HTTP error responses. It has the following properties: | Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | `error.message` | `string` | Error message | | `error.statusCode` | `number` | HTTP response status code eg `404` | | `error.headers` | `Headers` | HTTP response headers | | `error.body` | `string` | HTTP body. Can be empty string if no body is returned. | | `error.rawResponse` | `Response` | Raw HTTP response | | `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). | ### Example ```typescript import { Icpmcp } from "icpmcp"; import * as errors from "icpmcp/models/errors"; const icpmcp = new Icpmcp({ serverURL: "https://api.example.com", }); async function run() { try { const result = await icpmcp.avgIcpXdrConversionRates .getApiV3AvgIcpXdrConversionRates({}); console.log(result); } catch (error) { // The base class for HTTP error responses if (error instanceof errors.IcpmcpError) { console.log(error.message); console.log(error.statusCode); console.log(error.body); console.log(error.headers); // Depending on the method different errors may be thrown if (error instanceof errors.ErrorT) { console.log(error.data$.message); // string console.log(error.data$.code); // number console.log(error.data$.status); // string console.log(error.data$.errors); // models.Errors } } } } run(); ``` ### Error Classes **Primary error:** * [`IcpmcpError`](./src/models/errors/icpmcperror.ts): The base class for HTTP error responses.
Less common errors (7)
**Network errors:** * [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server. * [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal. * [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client. * [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid. * [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error. **Inherit from [`IcpmcpError`](./src/models/errors/icpmcperror.ts)**: * [`ErrorT`](docs/models/errors/errort.md): Unprocessable Entity. Status code `422`. Applicable to 90 of 118 methods.* * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable. ## Custom HTTP Client The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This client is a thin wrapper around `fetch` and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response. The `HTTPClient` constructor takes an optional `fetcher` argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures. The following example shows how to use the `"beforeRequest"` hook to to add a custom header and a timeout to requests and how to use the `"requestError"` hook to log errors: ```typescript import { Icpmcp } from "icpmcp"; import { HTTPClient } from "icpmcp/lib/http"; const httpClient = new HTTPClient({ // fetcher takes a function that has the same signature as native `fetch`. fetcher: (request) => { return fetch(request); } }); httpClient.addHook("beforeRequest", (request) => { const nextRequest = new Request(request, { signal: request.signal || AbortSignal.timeout(5000) }); nextRequest.headers.set("x-custom-header", "custom value"); return nextRequest; }); httpClient.addHook("requestError", (error, request) => { console.group("Request Error"); console.log("Reason:", `${error}`); console.log("Endpoint:", `${request.method} ${request.url}`); console.groupEnd(); }); const sdk = new Icpmcp({ httpClient }); ``` ## Debugging You can setup your SDK to emit debug logs for SDK requests and responses. You can pass a logger that matches `console`'s interface as an SDK option. > [!WARNING] > Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production. ```typescript import { Icpmcp } from "icpmcp"; const sdk = new Icpmcp({ debugLogger: console }); ``` You can also enable a default debug logger by setting an environment variable `ICPMCP_DEBUG` to true. # Development ## Maturity This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version. ## Contributions While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. ### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=icpmcp&utm_campaign=typescript)