ordinalsbot

OrdinalsBot Node.js Library

The OrdinalsBot Node library provides convenient access to the OrdinalsBot API from applications written in JavaScript.

Documentation

You can find examples here. For more information refer to our API docs.

Installation

Install the package with:

npm install ordinalsbot --save
or
yarn add ordinalsbot

Usage

The package needs to be configured with your account's API key which you can get by opening a ticket in our Discord for now. Our developer dashboard is coming soon...

const ordinalsbot = require('ordinalsbot');

// if no parameter given, default environment is 'live'
// API_KEY only required for creating collection orders
ordinalsbot.setCredentials('MY_API_KEY', 'dev'); 

try {
  const order = await ordinalsbot.createOrder({
    files: [
        {
          size: 10,
          type: "plain/text",
          name: "my-text-inscription-file.txt",
          dataURL: "data:plain/text;base64,dGVzdCBvcmRlcg==",
        }
    ],
    lowPostage: true,
    receiveAddress: "",
    fee: 11
  });
} catch (error) {
  console.error(`${error.status} | ${error.message}`);
}

Using Promises

Every method returns a chainable promise which can be used instead of a regular callback:

// You can also use import
import ordinalsbot from 'ordinalsbot'
ordinalsbot.setCredentials('', 'dev');

// Create a new order
ordinalsbot.createOrder({
    files: [
        {
          size: 10,
          type: "plain/text",
          name: "my-text-inscription-file.txt",
          dataURL: "data:plain/text;base64,dGVzdCBvcmRlcg==",
        }
    ],
    lowPostage: true,
    receiveAddress: "",
    fee: 11
}).then(order => {
  console.log(order);
}).catch(error => {
  console.error(`${error.status} | ${error.message}`);
});