# @cometh/marketplace-sdk

> SDK to use Cometh Marketplace API

Latest version **2.2.9** (published 2024-09-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cometh/marketplace-sdk
pnpm add @cometh/marketplace-sdk
yarn add @cometh/marketplace-sdk
bun add @cometh/marketplace-sdk
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.9 |
| Published | 2024-09-02 |
| First published | 2023-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 153.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | shoto290, kevin-cometh, raphael-cometh, yoanslvy, slakh, fred-alembic |

## Links

- npm: https://www.npmjs.com/package/@cometh/marketplace-sdk
- npm.io page: https://npm.io/package/@cometh/marketplace-sdk

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.6.2
- [form-data](https://npm.io/package/form-data.md) 4.x

## Recent versions

- 2.2.9 (latest) — 2024-09-02
- 2.1.0 (develop) — 2024-02-06
- 2.2.8 — 2024-07-30
- 2.2.7 — 2024-07-29
- 2.2.6 — 2024-04-25
- 2.1.2 — 2024-04-24
- 2.2.5 — 2024-04-23
- 2.2.4 — 2024-04-15
- 2.2.3 — 2024-04-12
- 2.2.2 — 2024-04-09
- 2.2.1 — 2024-04-09
- 2.1.1 — 2024-03-15
- 2.0.2 — 2024-02-06
- 2.0.1 — 2024-02-02
- 2.0.0 — 2024-02-02
- … 14 more at https://npm.io/package/@cometh/marketplace-sdk/versions

## README

# @cometh/marketplace-sdk

This is a TypeScript SDK for interacting with the Marketplace API. It simplifies the process of making requests to the API by providing convenient methods for various operations related to NFTs and their orders. It also provides all the necessary Typescript typing you might need. 

The possible operations include registering new collections, searching for assets, creating and searching orders, analyzing your marketplace palce statistics etc...

##  [Main documentation](https://docs.cometh.io/nft-and-marketplace-apis/quickstart/getting-started)
##  [SDK Reference documentation](https://api.marketplace.develop.core.cometh.tech/v1/doc/sdk/classes/MarketplaceSdk.html)
##  [API reference documentation](https://api.marketplace.develop.core.cometh.tech/v1/doc)


## Installation

To add the @cometh/marketplace-sdk to your project, you can use npm or yarn:

```bash
npm install @cometh/marketplace-sdk
```

```bash
yarn add @cometh/marketplace-sdk
```

## Usage

After installation, you can import `MarketplaceSdk` from the SDK in your TypeScript code:

```ts
import { MarketplaceSdk } from '@cometh/marketplace-sdk';
```

Create an instance of `MarketplaceSdk` and call its methods to interact with the Marketplace API.

```ts
const networkApiUrl = 'https://api.marketplace.prod.core.cometh.tech/v1/doc'

const marketplaceSdk = new MarketplaceSdk({
  BASE: networkApiUrl,
  HEADERS: {
    apikey: 'YOUR_API_KEY'
  }
})
```

Once initialized, the SDK is ready to be used.
```ts
const assetsSearch = await marketplaceSdk.asset.searchAssets({
  owner: userAddress,
  contractAddress: MY_COLLECTION_ADDRESS
})
```

---
_Source: https://npm.io/package/@cometh/marketplace-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._