Table

• API docs
• Collection
• Activities
• Tokens
• Block

Start

npm i magikedenordinals

const { Client } = require("magikedenordinals")

const client = new Client({
key: <your magikeden api key>,
debug: true, // debug
})

client.on("debug", console.log)

Collection

• get

let collection = client.collection()
let data = await collection.get("<symbol>") // collection symbol
console.log(data)

• popular

let collection = client.collection()
let data = await collection.popular("<window>", "<limit>")
// windows option: ["1h", "6h", "1d", "7d", "30d"];
// limit: less than 100 and multiple of 12;

console.log(data)

• all

let collection = client.collection()
let data = await collection.all() // all collections
console.log(data)

• stat

let collection = client.collection()
let data = await collection.stat("<symbol>") // collection symbol
console.log(data)

• events

let collections = client.collection();
await collections.watch({
  new: true // new collection
});

collections.on("start", () => {
  console.log("collections alert started");
});

collections.on("end", () => {
  console.log("collections alert ended");
});

collections.on("new", newcol => {
  console.log(newcol);
});

await collections.startEvents() // start events
await collections.stopEvents() // stop events.

Activities

• all

let activities = client.activities()
let data = await activities.all()
// options: limit

console.log(data)

• get

let activities = client.activities()
let data = activities.get(options)
/*
let = options = {
  collectionSymbol = "dream",
  kind = "buying_broadcasted",
  limit,
  ownerAddress,
  satRarity,
  inscriptionMin,
  inscriptionMax
}

let kinds = [
  "transfer",
  "list",
  "delist",
  "buying_broadcasted",
  "mint_broadcasted",
  "create"
];

let rarity = [
  "common",
  "uncommon",
  "legendary",
  "mythic",
  "rare",
  "epic"
];
*/

console.log(data)

• getOfAllKind

let activities = client.activities()
let data = await activities.getOfAllKinds(<collection symbol>, options) // same options as get
console.log(data)

• events

let acts = client.activities();
await acts.watch({
  new: true,
  collectionsToWatchForNew: ["bbc"]
});

acts.on("start", () => {
  console.log("Activities alert started");
});

acts.on("end", () => {
  console.log("Activities alert ended");
});

acts.on("new", a => {
  console.log(a);
});

await acts.startEvents();

Tokens

• get

let tokens = client.tokens()
let data = await tokens.get(option)

/*
options = {
  sortBy,
  satRarity,
  limit,
  collectionSymbol,
  ownerAddress,
  tokenIds // separated by ","
}

this.rarity = [
  "common",
  "uncommon",
  "legendary",
  "mythic",
  "rare",
  "epic"
];

this.sortBy = [
  "priceAsc",
  "priceDesc",
  "listedAtAsc",
  "listedAtDesc",
  "inscriptionNumberAsc",
  "inscriptionNumberDesc",
  "brc20UnitPriceAsc",
  "brc20UnitPriceDesc"
];
*/

console.log(data)

• events

let token = client.tokens();
await token.watch({
    new: true,
    collectionsToWatchForNew: ["bbc"],
    AddressesToWatchForNew: [] // wallets
});

token.on("start", () => {
    console.log("Tokens alert started");
});

token.on("end", () => {
    console.log("Tokens alert ended");
});

token.on("new", a => {
    console.log(a);
});

await token.startEvents();

Block

• activities

const block = client.block()
let data = block.activities(options)

/* 
let options = {
  kind,
  blockHeight
}

this.kinds = ["create", "transfer"];
*/

console.log(data)