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 = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
BFX.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 = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
BFX.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 = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
const options = {'limit_asks': 30, 'limit_bids': 30}
BFX.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 = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
BFX.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 = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
BFX.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 = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
BFX.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 = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
BFX.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 = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
BFX.symbols_details((err, data) => {
  if (err) console.log(err)
  console.log('Symbols Details:', data)
})

Actively working...