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

1.0.2 • Public • Published

Build Status Coverage Status Dependencies

BlockBid Australia Wrapper

Typescript / Node wrapper for the APIs offered by BlockBid Australia

Setup

Install the dependancies with npm / yarn.

npm install blockbid --save

API Key

TODO

Usage

The API wrapper exposes several classes, Accounts, Apis, Deposits, Markets, Orders and Withdraws. Each class has methods for each API Endpoint as specified in the BlockBid API Documentation.

Exposed Functions

Authentication is required for some functions within each class. When requesting public end-points API Keys aren't required.

Example

Examples for usage of each function can be found within the examples folder.

import { BlockBid } from 'blockbid';
 
// Public Method
const bb = new BlockBid();
 
bb.orders().markets()
  .then(resp => {
    console.log(resp);
  })
  .catch(err => {
    console.error(err.message);
  });
 
// Private Method
const bbPrivate = new BlockBid('MyApiKey', 'MyApiSecret');
 
bbPrivate.orders().order(112233)
  .then(resp => {
    console.log(resp);
  })
  .catch(err => {
    console.error(err.message);
  });

Dependencies (4)

Dev Dependencies (12)

Package Sidebar

Install

npm i blockbid

Weekly Downloads

1

Version

1.0.2

License

WTFPL

Unpacked Size

47.2 kB

Total Files

60

Last publish

Collaborators

  • sketchthat