Skip to main content

JavaScript (Node.js)

About​

Our JavaScript SDK, blockfrost-js is a Node.js application and therefore typically requires a backend.

Installation​

npm version

To run the SDK you need Node.js version 14 and higher.

caution

We recommend setting up your own Node.js backend. Exposing your API keys in a frontend application is almost always a bad idea.

The SDK is hosted on npmjs.com, so you can directly import it using your favorite package manager.

npm i @blockfrost/blockfrost-js
yarn add @blockfrost/blockfrost-js
note

While you may find a way to run it directly in a browser, we don't actively support it or provide any type of assistance with such integrations.

Usage​

Using the SDK is pretty straight-forward!

Cardano​

const Blockfrost = require("@blockfrost/blockfrost-js");
// import { BlockFrostAPI } from '@blockfrost/blockfrost-js'; // using import syntax

const API = new Blockfrost.BlockFrostAPI({
  projectId: "YOUR API KEY HERE", // see: https://blockfrost.io
});

async function runExample() {
  try {
    const latestBlock = await API.blocksLatest();
    const networkInfo = await API.network();
    const latestEpoch = await API.epochsLatest();
    const health = await API.health();
    const address = await API.addresses(
      "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz"
    );
    const pools = await API.pools({ page: 1, count: 10, order: "asc" });

    console.log("pools", pools);
    console.log("address", address);
    console.log("networkInfo", networkInfo);
    console.log("latestEpoch", latestEpoch);
    console.log("latestBlock", latestBlock);
    console.log("health", health);
  } catch (err) {
    console.log("error", err);
  }
}

runExample();

IPFS​

const Blockfrost = require("@blockfrost/blockfrost-js");
// import { BlockFrostIPFS } from '@blockfrost/blockfrost-js'; // using import syntax

const IPFS = new Blockfrost.BlockFrostIPFS({
  projectId: "YOUR IPFS KEY HERE", // see: https://blockfrost.io
});

async function runExample() {
  try {
    const added = await IPFS.add(`${__dirname}/img.svg`);
    console.log("added", added);

    const pinned = await IPFS.pin(added.ipfs_hash);
    console.log("pinned", pinned);
  } catch (err) {
    console.log("error", err);
  }
}

runExample();