atomicmarket
TypeScript icon, indicating that this package has built-in type declarations

1.1.6 • Public • Published

AtomicMarket JavaScript

JS Library to read data from the atomicmarket contract which is based on the atomicassets NFT standard.

Contract / General Documentation can be found on https://github.com/pinknetworkx/atomicmarket-contract/wiki

Usage

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install atomicmarket

Initialize

Web library can be found in the dist folder

// standard import
const {AtomicMarketApi} = require("atomicmarket");
// ES6 import
import {AtomicMarketApi} from "atomicmarket"

Documentation

There are two methods available to fetch data from the blockchain.

  • ExplorerAPI: uses an hosted API which proves simple and fast REST API endpoints
  • RpcAPI: uses only native nodeos calls

Explorer API

The explorer API uses eosio-contract-api to query data about the NFTs. A documentation of each endpoint and its responses can be found here. It is recommended to self-host the API for the best performance.

Example

// init Explorer Api
// endpoint: server where atomicmarket api is deployed
// namespace: used namespace for the API
// options:
// - fetch: either node-fetch module or the browser equivalent
const api = new AtomicMarketApi("https://test.wax.api.atomicassets.io", "atomicmarket", {fetch});

const sale = await api.getSale("100");

Package Sidebar

Install

npm i atomicmarket

Weekly Downloads

3

Version

1.1.6

License

MIT

Unpacked Size

40 kB

Total Files

26

Last publish

Collaborators

  • ops-spielworks
  • hugoatspielworks
  • alexsotocx
  • luiza.dias
  • jona_wilmsmann
  • fabian-pink
  • davidpink
  • pinkgg
  • zimmcognito