blockbid
v1.0.2
Published
Typescript wrapper for BlockBid Australia Exchange
Downloads
8
Maintainers
Readme
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 withinaccounts.ts
Apis
methods are withinapis.ts
Deposits
methods are withindeposits.ts
Markets
methods are withinmarkets.ts
Orders
methods are withinorders.ts
Withdraws
methods are withinwithdraws.ts
Example
Examples for usage of each function can be found within the [examples folder] (https://github.com/sketchthat/blockbid/tree/master/examples).
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);
});