0.2.0 • Published 4 years ago

bitflyer-api v0.2.0

Weekly downloads
3
License
Apache-2.0
Repository
github
Last release
4 years ago

TypeScript Bindings for BitFlyer Lightning API

Get started quickly with scripting BitFlyer's API.

Step 1: Install package

yarn add bitflyer-api
npm i bitflyer-api

Step 2: Connect to the BitFlyer API 🎉

// index.ts
import { Bitflyer } from 'bitflyer-api';

const credentials = { // get your credentials here https://lightning.bitflyer.com/developer
    key: "my key",
    secret: "my secret"
}

const bitflyer = new Bitflyer(credentials)

const allPublic = async () => {
    const health = await bitflyer.getHealth()
    console.log(health)
}

Functions & Types

FunctionBitFlyer Lightning API
bitflyer.getHealth()GET /v1/gethealth
bitflyer.markets()GET /v1/markets
bitflyer.getMarkets()GET /v1/getmarkets
bitflyer.board()GET /v1/board
bitflyer.getBoard()GET /v1/getboard
bitflyer.ticker()GET /v1/ticker
bitflyer.getTicker()GET /v1/getticker
bitflyer.executions()GET /v1/executions
bitflyer.getExecutions()GET /v1/getexecutions
bitflyer.getChats()GET /v1/getchats
bitflyer.getHealth()GET /v1/gethealth
bitflyer.getPermissions()GET /v1/me/getpermissions
bitflyer.getBalance()GET /v1/me/getbalance
bitflyer.getCollateral()GET /v1/me/getcollateral
bitflyer.getAddresses()GET /v1/me/getaddresses
bitflyer.getCoinIns()GET /v1/me/getcoinins
bitflyer.getCoinOuts()GET /v1/me/getcoinouts
bitflyer.getDeposits()GET /v1/me/getdeposits
bitflyer.getBankAccounts()GET /v1/me/getbankaccounts
bitflyer.withdraw()POST /v1/me/withdraw
bitflyer.getWithdrawals()GET /v1/me/getwithdrawals
bitflyer.sendChildOrder()POST /v1/me/sendchildorder
bitflyer.cancelChildOrder()POST /v1/me/cancelchildorder
bitflyer.sendParentOrder()POST /v1/me/sendparentorder
bitflyer.cancelParentOrder()POST /v1/me/cancelparentorder
bitflyer.cancelAllChildOrders()POST /v1/me/cancelallchildorders
bitflyer.getChildOrders()GET /v1/me/getchildorders
bitflyer.getParentOrder()GET /v1/me/getparentorder
bitflyer.getParentOrders()GET /v1/me/getparentorders
bitflyer.getMyExecutions()GET /v1/me/getexecutions
0.2.0

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago