blockbid

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.

• Accounts methods are within accounts.ts
• Apis methods are within apis.ts
• Deposits methods are within deposits.ts
• Markets methods are within markets.ts
• Orders methods are within orders.ts
• Withdraws methods are within withdraws.ts

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);
  });