npm package: @rarible/protocol-mcp
Description: Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@rarible/protocol-mcp* API.
Author: Speakeasy
Latest version: 0.0.4

# @rarible/protocol-mcp

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@rarible/protocol-mcp* API.

<div align="left">
    <a href="https://www.speakeasy.com/?utm_source=@rarible/protocol-mcp&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
    <a href="https://opensource.org/licenses/MIT">
        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
    </a>
</div>


<br /><br />
> [!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.

<!-- Start Summary [summary] -->
## Summary

OpenAPI definition: # Exciting News

Hey there, amazing developers! 👋

We've got some fantastic news to share that will make your experience with our product even better. We're thrilled to announce the implementation of API-Keys, which brings a new level of control and convenience to your development process. So, let's dive right into the details! ✨

## API-Keys for Enhanced Functionality 🔑

Starting now, we have introduced API-Keys to streamline your interactions with our methods. You might have noticed a slight change while making requests – now, all you need to do is include the parameter `X-API-KEY` in the Header of your request. Simple as that!

## Get Your API-Key in a Snap! ⚡️

Securing your API-Key is a breeze. We've made the process super user-friendly to ensure you can get started quickly. Just head over to our website and fill out a simple form. Once you've done that, your shiny new API-Key will be delivered straight to your email inbox. Easy peasy! 📧

[Get Your API-Key Here](https://rarible.org/pricing)
[Configure SDK with API-key](https://github.com/rarible/sdk#api-querying)

## Unlock the Power of the Rarible Protocol 🔓

As passionate developers, we know you're always hungry for knowledge and eager to explore new frontiers. That's why we invite you to discover the incredible world of the Rarible Protocol. By visiting our dedicated protocol page, you'll gain access to a treasure trove of useful information, tips, and insights that will elevate your development skills to new heights. 🚀

[Explore the Rarible Protocol](https://rarible.org)

So, buckle up and get ready for an enhanced development journey with our API-Keys. We're excited to see what you'll create using our revamped system! 💪🚀

Stay curious, keep innovating, and happy coding! ✨

[P.S. Join our Discord Server to stay up to date and ask questions](https://discord.gg/rarifoundation)
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [@rarible/protocol-mcp](#@rarible/protocol-mcp)
  * [API-Keys for Enhanced Functionality 🔑](#api-keys-for-enhanced-functionality)
  * [Get Your API-Key in a Snap! ⚡️](#get-your-api-key-in-a-snap)
  * [Unlock the Power of the Rarible Protocol 🔓](#unlock-the-power-of-the-rarible-protocol)
  * [SDK Installation](#sdk-installation)
  * [Requirements](#requirements)
  * [SDK Example Usage](#sdk-example-usage)
  * [Authentication](#authentication)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Standalone functions](#standalone-functions)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Server Selection](#server-selection)
  * [Custom HTTP Client](#custom-http-client)
  * [Debugging](#debugging)
* [Development](#development)
  * [Maturity](#maturity)
  * [Contributions](#contributions)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## 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 <UNSET>
```

### PNPM

```bash
pnpm add <UNSET>
```

### Bun

```bash
bun add <UNSET>
```

### Yarn

```bash
yarn add <UNSET> 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.

<details>
<summary>Claude installation steps</summary>

Add the following server definition to your `claude_desktop_config.json` file:

```json
{
  "mcpServers": {
    "RaribleProtocolMcp": {
      "command": "npx",
      "args": [
        "-y", "--package", "@rarible/protocol-mcp",
        "--",
        "mcp", "start",
        "--api-key-auth", "..."
      ]
    }
  }
}
```

</details>

<details>
<summary>Cursor installation steps</summary>

Create a `.cursor/mcp.json` file in your project root with the following content:

```json
{
  "mcpServers": {
    "RaribleProtocolMcp": {
      "command": "npx",
      "args": [
        "-y", "--package", "@rarible/protocol-mcp",
        "--",
        "mcp", "start",
        "--api-key-auth", "..."
      ]
    }
  }
}
```

</details>

For a full list of server arguments, run:

```sh
npx -y --package @rarible/protocol-mcp -- mcp start --help
```
<!-- End SDK Installation [installation] -->

<!-- Start Requirements [requirements] -->
## Requirements

For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
<!-- End Requirements [requirements] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```typescript
import { RaribleProtocolMcp } from "@rarible/protocol-mcp";

const raribleProtocolMcp = new RaribleProtocolMcp({
  apiKeyAuth: process.env["RARIBLE_API_KEY"] ?? "",
});

async function run() {
  const result = await raribleProtocolMcp.nftItems.getItemById({
    itemId:
      "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  });

  // Handle the result
  console.log(result);
}

run();

```
<!-- End SDK Example Usage [usage] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name         | Type   | Scheme  | Environment Variable              |
| ------------ | ------ | ------- | --------------------------------- |
| `apiKeyAuth` | apiKey | API key | `RARIBLE_API_KEY` |

To authenticate with the API the `apiKeyAuth` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { RaribleProtocolMcp } from "@rarible/protocol-mcp";

const raribleProtocolMcp = new RaribleProtocolMcp({
  apiKeyAuth: process.env["RARIBLE_API_KEY"] ?? "",
});

async function run() {
  const result = await raribleProtocolMcp.nftItems.getItemById({
    itemId:
      "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  });

  // Handle the result
  console.log(result);
}

run();

```
<!-- End Authentication [security] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [charts](docs/sdks/charts/README.md)

* [getFloorPriceChart](docs/sdks/charts/README.md#getfloorpricechart) - Get historical data of floor price for collection for charting purposes
* [getVolumeChart](docs/sdks/charts/README.md#getvolumechart) - Get historical data of collection volume (total sales worth) for charting purposes

### [collectionLeaderBoard](docs/sdks/collectionleaderboard/README.md)

* [getCollectionLeaderboard](docs/sdks/collectionleaderboard/README.md#getcollectionleaderboard) - Get NFT Collections leaderboard
* [getCollectionLeaderboardByOwner](docs/sdks/collectionleaderboard/README.md#getcollectionleaderboardbyowner) - Get NFT Collections leaderboard for a specific owner adresses

### [collectionStatistics](docs/sdks/collectionstatistics/README.md)

* [getGlobalCollectionStatistics](docs/sdks/collectionstatistics/README.md#getglobalcollectionstatistics) - Get global (period-independent) statistics by collection ID
* [getGlobalCollectionStatisticsByIds](docs/sdks/collectionstatistics/README.md#getglobalcollectionstatisticsbyids) - Get global (period-independent) statistics by collection IDs
* [getPeriodCollectionStatistics](docs/sdks/collectionstatistics/README.md#getperiodcollectionstatistics) - Get period-based statistics by collection ID
* [getPeriodCollectionStatisticsByIds](docs/sdks/collectionstatistics/README.md#getperiodcollectionstatisticsbyids) - Get period-based statistics by collection IDs
* [getOwners](docs/sdks/collectionstatistics/README.md#getowners) - Get distribution of the number of owned items by owner
* [getBidsByPrice](docs/sdks/collectionstatistics/README.md#getbidsbyprice) - Get distribution of the number of bids by price

### [currenciesAndRates](docs/sdks/currenciesandrates/README.md)

* [getUsdRate](docs/sdks/currenciesandrates/README.md#getusdrate) - Get USD rate
* [getAllCurrencies](docs/sdks/currenciesandrates/README.md#getallcurrencies) - Get supported currencies

### [domainLookup](docs/sdks/domainlookup/README.md)

* [resolve](docs/sdks/domainlookup/README.md#resolve) - Resolve domain

### [encodeOperations](docs/sdks/encodeoperations/README.md)

* [encode](docs/sdks/encodeoperations/README.md#encode) - Generate order encode data for sign operations

### [indexerBlocks](docs/sdks/indexerblocks/README.md)

* [getLatestIndexedBlock](docs/sdks/indexerblocks/README.md#getlatestindexedblock) - Get latest indexed block

### [nftActivities](docs/sdks/nftactivities/README.md)

* [~~getActivitiesByUser~~](docs/sdks/nftactivities/README.md#getactivitiesbyuser) - Get user Activities :warning: **Deprecated**
* [~~getActivitiesByUsers~~](docs/sdks/nftactivities/README.md#getactivitiesbyusers) - Get users Activities :warning: **Deprecated**
* [~~getActivitiesByItem~~](docs/sdks/nftactivities/README.md#getactivitiesbyitem) - Get NFT Activities :warning: **Deprecated**
* [~~getActivitiesByCollection~~](docs/sdks/nftactivities/README.md#getactivitiesbycollection) - Get NFT Collection Activities :warning: **Deprecated**
* [getAllActivitiesSync](docs/sdks/nftactivities/README.md#getallactivitiessync) - Get all Activities (for sync)
* [~~getAllActivities~~](docs/sdks/nftactivities/README.md#getallactivities) - Get all Activities :warning: **Deprecated**
* [getSalesChart](docs/sdks/nftactivities/README.md#getsaleschart) - Get sales chart

### [nftCollections](docs/sdks/nftcollections/README.md)

* [getCollectionById](docs/sdks/nftcollections/README.md#getcollectionbyid) - Get NFT Collection by Id
* [generateTokenId](docs/sdks/nftcollections/README.md#generatetokenid) - Generate TokenId
* [refreshCollectionItemsMeta](docs/sdks/nftcollections/README.md#refreshcollectionitemsmeta) - Reset NFT metadata
* [resetCollectionMeta](docs/sdks/nftcollections/README.md#resetcollectionmeta) - Reset Collection metadata
* [getCollectionsByOwner](docs/sdks/nftcollections/README.md#getcollectionsbyowner) - Get NFT Collections owned by user
* [getAllCollections](docs/sdks/nftcollections/README.md#getallcollections) - Get all NFT Collections

### [nftDataAndHistoricalStatistics](docs/sdks/nftdataandhistoricalstatistics/README.md)

* [getUserRankingByVolume](docs/sdks/nftdataandhistoricalstatistics/README.md#getuserrankingbyvolume) - Get user volume
* [getCollectionRankingByVolume](docs/sdks/nftdataandhistoricalstatistics/README.md#getcollectionrankingbyvolume) - Get NFT Collections volume
* [getTransactions](docs/sdks/nftdataandhistoricalstatistics/README.md#gettransactions) - Get NFT Collection tx stats
* [~~getCollectionStats~~](docs/sdks/nftdataandhistoricalstatistics/README.md#getcollectionstats) - Get NFT Collection stats :warning: **Deprecated**
* [getCollectionStatistics](docs/sdks/nftdataandhistoricalstatistics/README.md#getcollectionstatistics) - Get NFT Collection statistics
* [getSellers](docs/sdks/nftdataandhistoricalstatistics/README.md#getsellers) - Get NFT Collection seller stats
* [getGmv](docs/sdks/nftdataandhistoricalstatistics/README.md#getgmv) - Get NFT Collections GVM
* [getFloorPrice](docs/sdks/nftdataandhistoricalstatistics/README.md#getfloorprice) - Get NFT Collection floor price
* [getBuyers](docs/sdks/nftdataandhistoricalstatistics/README.md#getbuyers) - Get NFT Collection buyer stats
* [getListed](docs/sdks/nftdataandhistoricalstatistics/README.md#getlisted) - Get NFT Collection listing stats

### [nftItems](docs/sdks/nftitems/README.md)

* [getItemById](docs/sdks/nftitems/README.md#getitembyid) - Get NFT by Id
* [getItemByIds](docs/sdks/nftitems/README.md#getitembyids) - Get NFT by Ids
* [getItemRoyaltiesById](docs/sdks/nftitems/README.md#getitemroyaltiesbyid) - Get NFT royalties by Id
* [resetItemMeta](docs/sdks/nftitems/README.md#resetitemmeta) - Reset NFT metadata
* [getItemsByOwner](docs/sdks/nftitems/README.md#getitemsbyowner) - Get NFT owned by user
* [getItemsByCreator](docs/sdks/nftitems/README.md#getitemsbycreator) - Get NFT created by user
* [getItemsByCollection](docs/sdks/nftitems/README.md#getitemsbycollection) - Get NFT from collection
* [getItemsByOwnerWithOwnership](docs/sdks/nftitems/README.md#getitemsbyownerwithownership) - Get NFT owned by user - detailed
* [~~getAllItems~~](docs/sdks/nftitems/README.md#getallitems) - Get all NFTs :warning: **Deprecated**
* [queryTraits](docs/sdks/nftitems/README.md#querytraits) - Get NFT collection traits
* [queryTraitsWithRarity](docs/sdks/nftitems/README.md#querytraitswithrarity) - Get NFT traits rarity
* [~~getLazyItemById~~](docs/sdks/nftitems/README.md#getlazyitembyid) - Get Lazy NFT :warning: **Deprecated**
* [~~mintLazyItem~~](docs/sdks/nftitems/README.md#mintlazyitem) - Mint Lazy NFT :warning: **Deprecated**
* [~~burnLazyItem~~](docs/sdks/nftitems/README.md#burnlazyitem) - Burn Lazy NFT :warning: **Deprecated**

### [nftOwnerships](docs/sdks/nftownerships/README.md)

* [getOwnershipById](docs/sdks/nftownerships/README.md#getownershipbyid) - Get NFT Ownership by Id
* [getOwnershipsByIds](docs/sdks/nftownerships/README.md#getownershipsbyids) - Get NFT Ownerships by Ids
* [getOwnershipsByCollection](docs/sdks/nftownerships/README.md#getownershipsbycollection) - Get NFT Collection's Ownerships
* [getOwnershipsByItem](docs/sdks/nftownerships/README.md#getownershipsbyitem) - Get NFTs Ownerships
* [getCollectionsWithOwnedItems](docs/sdks/nftownerships/README.md#getcollectionswithowneditems) - Get collections owned items by owner

### [nftSales](docs/sdks/nftsales/README.md)

* [getOrderById](docs/sdks/nftsales/README.md#getorderbyid) - Get Order
* [prepareOrderTransaction](docs/sdks/nftsales/README.md#prepareordertransaction) - Prepare order transaction
* [prepareOrderCancelTransaction](docs/sdks/nftsales/README.md#prepareordercanceltransaction) - Prepare order cancel transaction
* [reportOrderById](docs/sdks/nftsales/README.md#reportorderbyid) - Report Order
* [upsertOrder](docs/sdks/nftsales/README.md#upsertorder) - Create or update Order
* [getValidatedOrderById](docs/sdks/nftsales/README.md#getvalidatedorderbyid) - Get validated Order by Id
* [getOrdersByIds](docs/sdks/nftsales/README.md#getordersbyids) - Get Orders by Ids
* [getOrdersAll](docs/sdks/nftsales/README.md#getordersall) - Get all Orders
* [getAllSync](docs/sdks/nftsales/README.md#getallsync) - Get all Orders (for sync)
* [getSellOrdersByMaker](docs/sdks/nftsales/README.md#getsellordersbymaker) - Get user's sell Orders
* [getSellOrdersByItem](docs/sdks/nftsales/README.md#getsellordersbyitem) - Get sell Orders for NFT
* [getSellOrders](docs/sdks/nftsales/README.md#getsellorders) - Get sell Orders
* [getOrderBidsByMaker](docs/sdks/nftsales/README.md#getorderbidsbymaker) - Get user's bid Orders
* [getOrderBidsByItem](docs/sdks/nftsales/README.md#getorderbidsbyitem) - Get bid Orders for NFT
* [getOrderFloorBidsByCollection](docs/sdks/nftsales/README.md#getorderfloorbidsbycollection) - Get floor bids for Collection
* [getOrderFees](docs/sdks/nftsales/README.md#getorderfees) - Get fee settings


### [reconciliation](docs/sdks/reconciliation/README.md)

* [getReconciliationItems](docs/sdks/reconciliation/README.md#getreconciliationitems) - Get IDs of items updated after a specific datetime.

### [searchAPI](docs/sdks/searchapi/README.md)

* [searchTraits](docs/sdks/searchapi/README.md#searchtraits) - Search NFT collection traits
* [searchItems](docs/sdks/searchapi/README.md#searchitems) - Search NFTs
* [searchDuplicatedItems](docs/sdks/searchapi/README.md#searchduplicateditems) - Search Duplicated NFTs
* [searchOwnerships](docs/sdks/searchapi/README.md#searchownerships) - Search NFT Ownerships
* [searchActivities](docs/sdks/searchapi/README.md#searchactivities) - Search Activities
* [searchCollection](docs/sdks/searchapi/README.md#searchcollection) - Search NFT Collections

### [signatureOperations](docs/sdks/signatureoperations/README.md)

* [validate](docs/sdks/signatureoperations/README.md#validate) - Check Order's signature
* [getInput](docs/sdks/signatureoperations/README.md#getinput) - Generate signed input

### [userBalances](docs/sdks/userbalances/README.md)

* [getBalance](docs/sdks/userbalances/README.md#getbalance) - Get balance

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start Standalone functions [standalone-funcs] -->
## 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).

<details>

<summary>Available standalone functions</summary>

- [`chartsGetFloorPriceChart`](docs/sdks/charts/README.md#getfloorpricechart) - Get historical data of floor price for collection for charting purposes
- [`chartsGetVolumeChart`](docs/sdks/charts/README.md#getvolumechart) - Get historical data of collection volume (total sales worth) for charting purposes
- [`collectionLeaderBoardGetCollectionLeaderboard`](docs/sdks/collectionleaderboard/README.md#getcollectionleaderboard) - Get NFT Collections leaderboard
- [`collectionLeaderBoardGetCollectionLeaderboardByOwner`](docs/sdks/collectionleaderboard/README.md#getcollectionleaderboardbyowner) - Get NFT Collections leaderboard for a specific owner adresses
- [`collectionStatisticsGetBidsByPrice`](docs/sdks/collectionstatistics/README.md#getbidsbyprice) - Get distribution of the number of bids by price
- [`collectionStatisticsGetGlobalCollectionStatistics`](docs/sdks/collectionstatistics/README.md#getglobalcollectionstatistics) - Get global (period-independent) statistics by collection ID
- [`collectionStatisticsGetGlobalCollectionStatisticsByIds`](docs/sdks/collectionstatistics/README.md#getglobalcollectionstatisticsbyids) - Get global (period-independent) statistics by collection IDs
- [`collectionStatisticsGetOwners`](docs/sdks/collectionstatistics/README.md#getowners) - Get distribution of the number of owned items by owner
- [`collectionStatisticsGetPeriodCollectionStatistics`](docs/sdks/collectionstatistics/README.md#getperiodcollectionstatistics) - Get period-based statistics by collection ID
- [`collectionStatisticsGetPeriodCollectionStatisticsByIds`](docs/sdks/collectionstatistics/README.md#getperiodcollectionstatisticsbyids) - Get period-based statistics by collection IDs
- [`currenciesAndRatesGetAllCurrencies`](docs/sdks/currenciesandrates/README.md#getallcurrencies) - Get supported currencies
- [`currenciesAndRatesGetUsdRate`](docs/sdks/currenciesandrates/README.md#getusdrate) - Get USD rate
- [`domainLookupResolve`](docs/sdks/domainlookup/README.md#resolve) - Resolve domain
- [`encodeOperationsEncode`](docs/sdks/encodeoperations/README.md#encode) - Generate order encode data for sign operations
- [`indexerBlocksGetLatestIndexedBlock`](docs/sdks/indexerblocks/README.md#getlatestindexedblock) - Get latest indexed block
- [`nftActivitiesGetAllActivitiesSync`](docs/sdks/nftactivities/README.md#getallactivitiessync) - Get all Activities (for sync)
- [`nftActivitiesGetSalesChart`](docs/sdks/nftactivities/README.md#getsaleschart) - Get sales chart
- [`nftCollectionsGenerateTokenId`](docs/sdks/nftcollections/README.md#generatetokenid) - Generate TokenId
- [`nftCollectionsGetAllCollections`](docs/sdks/nftcollections/README.md#getallcollections) - Get all NFT Collections
- [`nftCollectionsGetCollectionById`](docs/sdks/nftcollections/README.md#getcollectionbyid) - Get NFT Collection by Id
- [`nftCollectionsGetCollectionsByOwner`](docs/sdks/nftcollections/README.md#getcollectionsbyowner) - Get NFT Collections owned by user
- [`nftCollectionsRefreshCollectionItemsMeta`](docs/sdks/nftcollections/README.md#refreshcollectionitemsmeta) - Reset NFT metadata
- [`nftCollectionsResetCollectionMeta`](docs/sdks/nftcollections/README.md#resetcollectionmeta) - Reset Collection metadata
- [`nftDataAndHistoricalStatisticsGetBuyers`](docs/sdks/nftdataandhistoricalstatistics/README.md#getbuyers) - Get NFT Collection buyer stats
- [`nftDataAndHistoricalStatisticsGetCollectionRankingByVolume`](docs/sdks/nftdataandhistoricalstatistics/README.md#getcollectionrankingbyvolume) - Get NFT Collections volume
- [`nftDataAndHistoricalStatisticsGetCollectionStatistics`](docs/sdks/nftdataandhistoricalstatistics/README.md#getcollectionstatistics) - Get NFT Collection statistics
- [`nftDataAndHistoricalStatisticsGetFloorPrice`](docs/sdks/nftdataandhistoricalstatistics/README.md#getfloorprice) - Get NFT Collection floor price
- [`nftDataAndHistoricalStatisticsGetGmv`](docs/sdks/nftdataandhistoricalstatistics/README.md#getgmv) - Get NFT Collections GVM
- [`nftDataAndHistoricalStatisticsGetListed`](docs/sdks/nftdataandhistoricalstatistics/README.md#getlisted) - Get NFT Collection listing stats
- [`nftDataAndHistoricalStatisticsGetSellers`](docs/sdks/nftdataandhistoricalstatistics/README.md#getsellers) - Get NFT Collection seller stats
- [`nftDataAndHistoricalStatisticsGetTransactions`](docs/sdks/nftdataandhistoricalstatistics/README.md#gettransactions) - Get NFT Collection tx stats
- [`nftDataAndHistoricalStatisticsGetUserRankingByVolume`](docs/sdks/nftdataandhistoricalstatistics/README.md#getuserrankingbyvolume) - Get user volume
- [`nftItemsGetItemById`](docs/sdks/nftitems/README.md#getitembyid) - Get NFT by Id
- [`nftItemsGetItemByIds`](docs/sdks/nftitems/README.md#getitembyids) - Get NFT by Ids
- [`nftItemsGetItemRoyaltiesById`](docs/sdks/nftitems/README.md#getitemroyaltiesbyid) - Get NFT royalties by Id
- [`nftItemsGetItemsByCollection`](docs/sdks/nftitems/README.md#getitemsbycollection) - Get NFT from collection
- [`nftItemsGetItemsByCreator`](docs/sdks/nftitems/README.md#getitemsbycreator) - Get NFT created by user
- [`nftItemsGetItemsByOwner`](docs/sdks/nftitems/README.md#getitemsbyowner) - Get NFT owned by user
- [`nftItemsGetItemsByOwnerWithOwnership`](docs/sdks/nftitems/README.md#getitemsbyownerwithownership) - Get NFT owned by user - detailed
- [`nftItemsQueryTraits`](docs/sdks/nftitems/README.md#querytraits) - Get NFT collection traits
- [`nftItemsQueryTraitsWithRarity`](docs/sdks/nftitems/README.md#querytraitswithrarity) - Get NFT traits rarity
- [`nftItemsResetItemMeta`](docs/sdks/nftitems/README.md#resetitemmeta) - Reset NFT metadata
- [`nftOwnershipsGetCollectionsWithOwnedItems`](docs/sdks/nftownerships/README.md#getcollectionswithowneditems) - Get collections owned items by owner
- [`nftOwnershipsGetOwnershipById`](docs/sdks/nftownerships/README.md#getownershipbyid) - Get NFT Ownership by Id
- [`nftOwnershipsGetOwnershipsByCollection`](docs/sdks/nftownerships/README.md#getownershipsbycollection) - Get NFT Collection's Ownerships
- [`nftOwnershipsGetOwnershipsByIds`](docs/sdks/nftownerships/README.md#getownershipsbyids) - Get NFT Ownerships by Ids
- [`nftOwnershipsGetOwnershipsByItem`](docs/sdks/nftownerships/README.md#getownershipsbyitem) - Get NFTs Ownerships
- [`nftSalesGetAllSync`](docs/sdks/nftsales/README.md#getallsync) - Get all Orders (for sync)
- [`nftSalesGetOrderBidsByItem`](docs/sdks/nftsales/README.md#getorderbidsbyitem) - Get bid Orders for NFT
- [`nftSalesGetOrderBidsByMaker`](docs/sdks/nftsales/README.md#getorderbidsbymaker) - Get user's bid Orders
- [`nftSalesGetOrderById`](docs/sdks/nftsales/README.md#getorderbyid) - Get Order
- [`nftSalesGetOrderFees`](docs/sdks/nftsales/README.md#getorderfees) - Get fee settings
- [`nftSalesGetOrderFloorBidsByCollection`](docs/sdks/nftsales/README.md#getorderfloorbidsbycollection) - Get floor bids for Collection
- [`nftSalesGetOrdersAll`](docs/sdks/nftsales/README.md#getordersall) - Get all Orders
- [`nftSalesGetOrdersByIds`](docs/sdks/nftsales/README.md#getordersbyids) - Get Orders by Ids
- [`nftSalesGetSellOrders`](docs/sdks/nftsales/README.md#getsellorders) - Get sell Orders
- [`nftSalesGetSellOrdersByItem`](docs/sdks/nftsales/README.md#getsellordersbyitem) - Get sell Orders for NFT
- [`nftSalesGetSellOrdersByMaker`](docs/sdks/nftsales/README.md#getsellordersbymaker) - Get user's sell Orders
- [`nftSalesGetValidatedOrderById`](docs/sdks/nftsales/README.md#getvalidatedorderbyid) - Get validated Order by Id
- [`nftSalesPrepareOrderCancelTransaction`](docs/sdks/nftsales/README.md#prepareordercanceltransaction) - Prepare order cancel transaction
- [`nftSalesPrepareOrderTransaction`](docs/sdks/nftsales/README.md#prepareordertransaction) - Prepare order transaction
- [`nftSalesReportOrderById`](docs/sdks/nftsales/README.md#reportorderbyid) - Report Order
- [`nftSalesUpsertOrder`](docs/sdks/nftsales/README.md#upsertorder) - Create or update Order
- [`reconciliationGetReconciliationItems`](docs/sdks/reconciliation/README.md#getreconciliationitems) - Get IDs of items updated after a specific datetime.
- [`searchAPISearchActivities`](docs/sdks/searchapi/README.md#searchactivities) - Search Activities
- [`searchAPISearchCollection`](docs/sdks/searchapi/README.md#searchcollection) - Search NFT Collections
- [`searchAPISearchDuplicatedItems`](docs/sdks/searchapi/README.md#searchduplicateditems) - Search Duplicated NFTs
- [`searchAPISearchItems`](docs/sdks/searchapi/README.md#searchitems) - Search NFTs
- [`searchAPISearchOwnerships`](docs/sdks/searchapi/README.md#searchownerships) - Search NFT Ownerships
- [`searchAPISearchTraits`](docs/sdks/searchapi/README.md#searchtraits) - Search NFT collection traits
- [`signatureOperationsGetInput`](docs/sdks/signatureoperations/README.md#getinput) - Generate signed input
- [`signatureOperationsValidate`](docs/sdks/signatureoperations/README.md#validate) - Check Order's signature
- [`userBalancesGetBalance`](docs/sdks/userbalances/README.md#getbalance) - Get balance
- ~~[`nftActivitiesGetActivitiesByCollection`](docs/sdks/nftactivities/README.md#getactivitiesbycollection)~~ - Get NFT Collection Activities :warning: **Deprecated**
- ~~[`nftActivitiesGetActivitiesByItem`](docs/sdks/nftactivities/README.md#getactivitiesbyitem)~~ - Get NFT Activities :warning: **Deprecated**
- ~~[`nftActivitiesGetActivitiesByUser`](docs/sdks/nftactivities/README.md#getactivitiesbyuser)~~ - Get user Activities :warning: **Deprecated**
- ~~[`nftActivitiesGetActivitiesByUsers`](docs/sdks/nftactivities/README.md#getactivitiesbyusers)~~ - Get users Activities :warning: **Deprecated**
- ~~[`nftActivitiesGetAllActivities`](docs/sdks/nftactivities/README.md#getallactivities)~~ - Get all Activities :warning: **Deprecated**
- ~~[`nftDataAndHistoricalStatisticsGetCollectionStats`](docs/sdks/nftdataandhistoricalstatistics/README.md#getcollectionstats)~~ - Get NFT Collection stats :warning: **Deprecated**
- ~~[`nftItemsBurnLazyItem`](docs/sdks/nftitems/README.md#burnlazyitem)~~ - Burn Lazy NFT :warning: **Deprecated**
- ~~[`nftItemsGetAllItems`](docs/sdks/nftitems/README.md#getallitems)~~ - Get all NFTs :warning: **Deprecated**
- ~~[`nftItemsGetLazyItemById`](docs/sdks/nftitems/README.md#getlazyitembyid)~~ - Get Lazy NFT :warning: **Deprecated**
- ~~[`nftItemsMintLazyItem`](docs/sdks/nftitems/README.md#mintlazyitem)~~ - Mint Lazy NFT :warning: **Deprecated**

</details>
<!-- End Standalone functions [standalone-funcs] -->

<!-- Start Retries [retries] -->
## 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 { RaribleProtocolMcp } from "@rarible/protocol-mcp";

const raribleProtocolMcp = new RaribleProtocolMcp({
  apiKeyAuth: process.env["RARIBLE_API_KEY"] ?? "",
});

async function run() {
  const result = await raribleProtocolMcp.nftItems.getItemById({
    itemId:
      "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  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 { RaribleProtocolMcp } from "@rarible/protocol-mcp";

const raribleProtocolMcp = new RaribleProtocolMcp({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyAuth: process.env["RARIBLE_API_KEY"] ?? "",
});

async function run() {
  const result = await raribleProtocolMcp.nftItems.getItemById({
    itemId:
      "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  });

  // Handle the result
  console.log(result);
}

run();

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `getItemById` method may throw the following errors:

| Error Type                         | Status Code | Content Type     |
| ---------------------------------- | ----------- | ---------------- |
| errors.UnionApiErrorBadRequest     | 400         | application/json |
| errors.UnionApiErrorEntityNotFound | 404         | application/json |
| errors.UnionApiErrorServerError    | 500         | application/json |
| errors.APIError                    | 4XX, 5XX    | \*/\*            |

If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.

```typescript
import { RaribleProtocolMcp } from "@rarible/protocol-mcp";
import {
  SDKValidationError,
  UnionApiErrorBadRequest,
  UnionApiErrorEntityNotFound,
  UnionApiErrorServerError,
} from "@rarible/protocol-mcp/models/errors";

const raribleProtocolMcp = new RaribleProtocolMcp({
  apiKeyAuth: process.env["RARIBLE_API_KEY"] ?? "",
});

async function run() {
  let result;
  try {
    result = await raribleProtocolMcp.nftItems.getItemById({
      itemId:
        "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
    });

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof UnionApiErrorBadRequest): {
        // Handle err.data$: UnionApiErrorBadRequestData
        console.error(err);
        return;
      }
      case (err instanceof UnionApiErrorEntityNotFound): {
        // Handle err.data$: UnionApiErrorEntityNotFoundData
        console.error(err);
        return;
      }
      case (err instanceof UnionApiErrorServerError): {
        // Handle err.data$: UnionApiErrorServerErrorData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

```

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:

| HTTP Client Error                                    | Description                                          |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError                                  | HTTP request was aborted by the client               |
| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
| ConnectionError                                      | HTTP client was unable to make a request to a server |
| InvalidRequestError                                  | Any input used to create a request is invalid        |
| UnexpectedClientError                                | Unrecognised or unexpected error                     |
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## Server Selection

### Server Variables

The default server `https://{environment}.rarible.org` contains variables and is set to `https://api.rarible.org` by default. To override default values, the following parameters are available when initializing the SDK client instance:

| Variable      | Parameter                               | Supported Values                | Default | Description |
| ------------- | --------------------------------------- | ------------------------------- | ------- | ----------- |
| `environment` | `environment: models.ServerEnvironment` | - `"api"`<br/>- `"testnet-api"` | `"api"` |             |

#### Example

```typescript
import { RaribleProtocolMcp } from "@rarible/protocol-mcp";

const raribleProtocolMcp = new RaribleProtocolMcp({
  environment: "testnet-api",
  apiKeyAuth: process.env["RARIBLE_API_KEY"] ?? "",
});

async function run() {
  const result = await raribleProtocolMcp.nftItems.getItemById({
    itemId:
      "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  });

  // Handle the result
  console.log(result);
}

run();

```

### Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
```typescript
import { RaribleProtocolMcp } from "@rarible/protocol-mcp";

const raribleProtocolMcp = new RaribleProtocolMcp({
  serverURL: "https://api.rarible.org",
  apiKeyAuth: process.env["RARIBLE_API_KEY"] ?? "",
});

async function run() {
  const result = await raribleProtocolMcp.nftItems.getItemById({
    itemId:
      "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
  });

  // Handle the result
  console.log(result);
}

run();

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## 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 { RaribleProtocolMcp } from "@rarible/protocol-mcp";
import { HTTPClient } from "@rarible/protocol-mcp/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 RaribleProtocolMcp({ httpClient });
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Debugging [debug] -->
## 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 { RaribleProtocolMcp } from "@rarible/protocol-mcp";

const sdk = new RaribleProtocolMcp({ debugLogger: console });
```

You can also enable a default debug logger by setting an environment variable `RARIBLEPROTOCOLMCP_DEBUG` to true.
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

# 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=@rarible/protocol-mcp&utm_campaign=typescript)