# opensea-api

> Typescript wrapper for Opensea API v1 🌊. Need to figure out how to get intellisense (autocomplete) to work for it to be super useful.

Latest version **1.0.8** (published 2022-04-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install opensea-api
pnpm add opensea-api
yarn add opensea-api
bun add opensea-api
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2022-04-06 |
| First published | 2022-04-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 39.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | mithrasio |
| Maintainers | mithrasio |

## Links

- npm: https://www.npmjs.com/package/opensea-api
- npm.io page: https://npm.io/package/opensea-api

## Recent versions

- 1.0.8 (latest) — 2022-04-06
- 1.0.7 — 2022-04-05
- 1.0.6 — 2022-04-05
- 1.0.5 — 2022-04-05
- 1.0.4 — 2022-04-05
- 1.0.3 — 2022-04-05
- 1.0.2 — 2022-04-05
- 1.0.1 — 2022-04-05
- 1.0.0 — 2022-04-05

## README

# opensea-api

Typescript wrapper for Opensea API v1 🌊.
Need to figure out how to get intellisense (autocomplete) to work for it to be super useful.

## Install

```
npm i opensea-api
```

## Usage

```
const { OpenseaAPI } = require("opensea-api");

const seaport = new OpenseaAPI("API_KEY_HERE");
seaport.getAssets().then(data => console.log(data))
```

## Todo

- [ ] add try catch block
- [ ] test ESM version on FE
- [ ] get intellisense working


## Supported functions

```
getAssets(options?: GetAssetsOptions): Promise<any>;
getEvents(options?: GetEventsOptions): Promise<any>;
getCollections(options?: GetCollectionsOptions): Promise<any>;
getBundles(options?: GetBundlesOptions): Promise<any>;
getSingleAsset(assetContractAddress: string, tokenId: string, options?: GetSingleAssetOptions): Promise<any>;
getSingleAssetListings(assetContractAddress: string, tokenId: string, options?: GetSingleAssetEventOptions): Promise<any>;
getSingleAssetOffers(assetContractAddress: string, tokenId: string, options?: GetSingleAssetEventOptions): Promise<any>;
getSingleContract(assetContractAddress: string): Promise<any>;
getSingleCollection(collectionSlug: string): Promise<any>;
getSingleCollectionStats(collectionSlug: string): Promise<any>;
    
```

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