Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

bitfex

1.0.0 • Public • Published

BitFex API for node.js

Simple implementation of BitFex.Trade API for node.js

Documentation

Init

Add bitfex to package.json:

yarn add bitfex
# or 
# npm install --save bitfex 

After that you could use it in JS:

import Bitfex from 'bitfex'
 
Bitfex.auth({ email: 'user@example.com', password: 'password' })
  .then({ jwt } => {
    // you have now jwt token
  })

Methods

auth

params:

  • email
  • password

Example:

Bitfex.auth({ email: 'user@example.com', password: 'password' }).then({ jwt, mfa } => ...)

In case of MFA enabled no JWT token returned, only mfa returned - it's personal one time auth token for authMfa

authMfa

params:

  • authToken - received from auth method
  • otp - one time password
Bitfex.authMfa({ authToken: 'TOKEN', otp: '123456' }).then({ jwt } => ...)

signUp

Create new user

params:

  • email
  • password
  • username
Bitfex.signUp({ email: 'user@example.com', password: 'password', username: 'username' }).then({ success, errors } => ...)

resetPassword

params:

  • email

loadHistory

params:

  • token

loadCompletedOrders

params:

  • token
  • page
  • pair

depositCode

params:

  • token
  • currency

withdraw

params:

  • token
  • currency
  • amount
  • to

orders

params:

  • pair

ordersMy

params:

  • token

chart

params:

  • pair

charts

volume

updateUserData

params:

  • token

getMfaProvisionUrl

checkMfaCode

params:

  • token
  • code

disableMfa

params:

  • token

deposit

params:

  • token
  • currency
  • amount

chatLoad

chatSend

params:

  • token
  • text

placeOrder

params:

  • token
  • pair
  • operation
  • amount
  • price

cancelOrder

params:

  • token
  • id

checkUsersCount

params:

  • token
  • scope

sendMail

params:

  • token
  • scope
  • subject
  • content

reset

params:

  • password
  • passwordConfirmation
  • token

createTradeApiKey

params:

  • token

leaders

roadmap

params:

  • token (optional)

createRoadmapItem

params:

  • token
  • title
  • description

roadmapComments

params:

  • id

createRoadmapComment

params:

  • token
  • id
  • comment

roadmapVote

params:

  • token
  • id

Legal

Released under the MIT License: https://opensource.org/licenses/MIT

Keywords

none

Install

npm i bitfex

DownloadsWeekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

72.1 kB

Total Files

5

Last publish

Collaborators

  • avatar