v1 REST API

v1 REST API

Here is some documentation that will help you along your way. If you would like to read more, visit the Bitfinex Docs

• v1 REST API
  • Install
  • new BitfinexWS(APIKey, APISecret)
  • BFX.ticker(pair, cb)
  • instance
    • .ticker([pair])

Install

Install bitfinex-api-node via npm:

npm install bitfinex-api-node

new BFX(APIKey, APISecret, opts).rest

Param	Type	Description
APIKey	string	Your BFX API Key
APISecret	string	Your BFX Secret Key
Opts	object	opts = {version: 1}

where Opts consists of:

const opts = {
  version: 1 // for v1
}

BFX.ticker(pair, cb)

Param	Type	Description
pair	string	BTCUSD, LTCUSD, ETHUSD...
cb	function	callback of error, result

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
bfxRest.ticker('BTCUSD', (err, data) => {
  if (err) console.log(err)
  console.log('Ticker:', data)
})

BFX.stats(pair, cb)

Param	Type	Description
pair	string	BTCUSD, LTCUSD, ETHUSD...
cb	function	callback of error, result

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
bfxRest.stats('BTCUSD', (err, data) => {
  if (err) console.log(err)
  console.log('Stats:', data)
})

BFX.fundingbook(currency, {options}, cb)

Param	Type	Description
currency	string	USD, GBP, JPY
options	sting	i.e. options = {'limit_asks': 2, 'limit_bids': 2}.
cb	function	callback with error, result as params

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
const options = {'limit_asks': 30, 'limit_bids': 30}
bfxRest.fundingbook('USD', options, (err, data) => {
  if (err) console.log(err)
  console.log('Funding Book:', data)
})

BFX.orderbook(pair, cb)

Param	Type	Description
pair	string	BTCUSD, ETHUSD, LTCUSD
cb	function	callback with error, result as params

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
bfxRest.orderbook('BTCUSD', (err, data) => {
  if (err) console.log(err)
  console.log('Orderbook:', data)
})

BFX.trades(currency, cb)

Param	Type	Description
currency	string	USD, GBP, JPY
cb	function	callback with error, result as params

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
bfxRest.trades('USD', (err, data) => {
  if (err) console.log(err)
  console.log('Trades:', data)
})

BFX.lends(pair, cb)

Param	Type	Description
pair	string	BTCUSD, ETHUSD, LTCUSD
cb	function	callback with error, result as params

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
bfxRest.lends('BTCUSD', (err, data) => {
  if (err) console.log(err)
  console.log('Lends:', data)
})

BFX.get_symbols(cb)

Param	Type	Description
cb	function	callback with error, result as params

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
bfxRest.get_symbols((err, data) => {
  if (err) console.log(err)
  console.log('Symbols:', data)
})

BFX.symbols_details(cb)

Param	Type	Description
cb	function	callback with error, result as params

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
bfxRest.symbols_details((err, data) => {
  if (err) console.log(err)
  console.log('Symbols Details:', data)
})

BFX.account_infos(cb)

Param	Type	Description
cb	function	callback with error, result as params

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
bfxRest.account_infos((err, data) => {
  if (err) console.log(err)
  console.log('Symbols Details:', data)
})

BFX.account_fees

NOT IMPLEMENTED

BFX.summary

NOT IMPLEMENTED

BFX.new_deposit(currency, method, wallet, cb)

** DOC DISCREPENCY ** will look into this! currency should not be there

Param	Type	Description
currency	string	BTC
method	string	bitcoin, litecoin, ethereum, ...
wallet	string	trading, exchange, deposit, ...
cb	function	callback with error, result as params

Example:

const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
bfxRest.new_deposit('BTC', 'deposit', 'exchange', (err, data) => {
  if (err) console.log(err)
  console.log('Symbols Details:', data)
})

BFX.key_permissions

NOT IMPLEMENTED

BFX.margin_infos(cb)

Param	Type	Description
cb	function	callback with error, result as params

// or use bitfinex-api-node
const BFX = require('bitfinex-api-node')
const bfxRest = new BFX(apiKey, apiSecretKey, {version: 1}).rest
bfxRest.margin_infos((err, res) => {
  if (err) console.log(err)
  console.log(result)
})

BFX.wallet_infos(cb)

NEED TO TEST ON PRODUCTION

Actively working...