Sean Outram

About

Experience

Portfolio

Blog

hcb.js Documentation

Documentation from branch-main-7dcd2360bdbb52f613af93acec282be65513cccf


ClassesEnumsFunctionsInterfaces

hcb.js

A npm package for the HCB transparency API

Getting Started!

CJS

const { HCB } = require('hcb.js');
const hcb = new HCB();

// Get 100 transactions from hq's account
const transactions = hcb.transaction.allOrgTransactions({
	id: 'hq',
	per_page: 100
});

ESM / TS

import { HCB } from 'hcb.js';
const hcb = new HCB();

// Get 100 transactions from hq's account
const transactions = hcb.transaction.allOrgTransactions({
	id: 'hq',
	per_page: 100
});

Documentation

This is still a beta package and there is no documentation currently However intelisense should work and you can always read the source code There is also autogenerated typedoc information here

© Sean Outram 2023