Bit2Me API Tool (BETA)

NOTE: For this quickstart you MUST use NodeJS version > 21.7.3. If you use a previous version, you MUST install dotenv & crypto@1.0.1 (this lib is deprecated and built-in. Recommend: update node version).

DISCLAIMER: This guide is for using Bit2Me Broker, NOT Bit2Me PRO. For a how to use of Bit2Me PRO, please check this documentation and this repository.

TIP: <> is for required data, [] is for optional data.

How to use this tool

1. Run cp .env.example .env in your terminal.
2. Change API_KEY and SECRET in .env file with yours.
3. Execute npm i.

Currency and market information

• To get all available currencies in Bit2Me, with available actions, its networks and withdrawal fees, execute npm run list-currencies. This script retrieves all currencies information and may take some time.
  • We strongly recommend that you store the output in a file: npm run --silent list-currencies > currencies.json.
• To get currencies quotes, execute npm run market-quotes [currency]. If currency is empty, will return market currencies quotes in EUR.
• To get market information of a currency, execute npm run market-data <currency>.

Subaccount management

• To create a subaccount:
  1. Change body values in ./createSubaccount.js file.
  2. Execute npm run create-subaccount.
     • Successful response example: { userId: subaccount-id }.
• To set an alias, execute npm run set-alias <alias> [subaccount-id]. If subaccount-id is empty, alias will be set to main account.
• To list subaccounts, execute npm run list-subaccounts.
• To read an account, execute npm run read-account [subaccount-id]. If subaccount-id is empty, will return the main account data.

KYC

KYC process is currently outside the scope of this tool. Please feel free to reach out or complete the process through the Bit2Me UI.

Pocket management

• To create pocket, execute npm run create-pocket <currency> <name> [subaccount-id]. If subaccount-id is empty, currency pocket will be created for main account.
• To list pockets, execute npm run list-pockets [currency] [subaccount-id]. If subaccount-id is empty, pockets list from main account will be returned. If currency is empty, will return the whole list of your pockets.
• To get your balance, execute npm run balance [currency] [subaccount-id]. If subaccount-id is empty, balance from main account will be returned. If currency is empty, will return the whole balance from your account.

Deposit EUR

• To deposit EUR, execute npm run deposit-eur [subaccount-id]. If subaccount-id is empty, the bank accounts of the main account will be displayed, and any EUR deposits will be credited to the main account.

Deposit crypto

• To deposit crypto, execute npm run deposit-crypto <crypto> <network> [subaccount-id]. If subaccount-id is empty, will return main account addresses.

Get transaction information

• To get a transaction, execute npm run read-tx <tx-id> [subaccount-id]. If subaccount-id is empty, tx-id will be searched in main account transaction list.
• To get your transaction list, execute npm run list-tx [subaccount-id]. If subaccount-id is empty, will be returned the transaction list of main account.

Buy crypto

• To buy crypto, execute npm run buy <amount> < - | EUR > <crypto> [subaccount-id]. If subaccount-id is empty, an attempt will be made to buy for the main account. If you want to know all the available crypto, you can execute npm run list-currencies.
  • You can buy <amount> <crypto> or <amount> EUR <crypto>. Examples:
    • I want to buy 0.01 ETH ➙ npm run buy 0.01 - ETH [subaccount-id].
    • I want to buy 5 EUR in ETH ➙ npm run buy 5 EUR ETH [subaccount-id].

Swap crypto

• To swap crypto for another crypto, execute npm run swap <amount> <crypto-origin> <crypto-destination> [subaccount-id]. If subaccount-id is empty, an attempt will be made to swap crypto-origin ➙ crypto-destination for the main account. If you want to know all the available crypto, you can execute npm run list-currencies.
  • Examples:
    • I want to swap 0.01 ETH to BTC ➙ npm run swap 0.01 ETH BTC [subaccount-id].

Sell crypto

• To sell crypto, execute npm run sell <amount> <crypto> [subaccount-id]. If subaccount-id is empty, an attempt will be made to sell crypto for the main account.
  • Examples:
    • I want to sell 0.01 ETH ➙ npm run sell 0.01 ETH [subaccount-id].

2FA

If you want to configure 2FA in main account you MUST use Bit2Me UI.

2FA is needed for ANY WITHDRAW operation

• To get TOTP code, execute npm run get-totp <subaccount-id>. After that, configure secret in your auth app to generate valid 2FA codes.

  • { secret: secret-id }

• To finish TOTP configuration, execute npm use set-2fa <subaccount-id> <TOTP>.

  • Response example: { result: true | false }

Withdraw crypto

• To withdraw crypto, execute npm run wd-crypto <amount> <crypto> <network> <address> <TOTP> [subaccount-id]. If subaccount-id is empty, withdraw operation will be executed in main account.

Withdraw fiat

• To withdraw fiat to a bank account, execute npm run wd-fiat <amount> <TOTP> [subaccount-id]. Due to console writing lack of security, you need to change body in ./withdrawFiat.js. If subaccount-id is empty, fiat withdraw operation will be executed for main account.

Social-Pay

• To make a transfer between accounts, execute npm run pay <amount> <crypto> <alice> <bob> <alice-TOTP>. alice and bob are accounts, you MUST fill this params with an uuid. In order to make a social-pay, bob MUST have an alias already set. If not, please execute npm run set-alias <alias> <bob>.
  • Example: Alice wants to transfer Bob 0.01 ETH ➙ npm run pay 0.01 ETH 9fb38ddd-3b09-4823-9a2e-668e9bc96964 4512ec8e-f269-4b62-aeea-c64041865b83 451450.

Extra section

Authentication by JWT

The authentication between Bit2Me and you can also work with the RFC-7519 standard, popularly known as JSON Web Token (JWT). This means, that if you do not want the actions of your subaccounts to depend exclusively on a backend, you can have them authenticated with a JWT. The management of this token is up to you.

• To get a valid JWT, execute npm run jwt [subaccount-id]. If subaccount-id is empty, a JWT associated with your main account will be returned.

Recommended use of the JWT

1. A backend retrieves a valid JWT for an account.
2. Store this JWT in FE (using localStorage or similar).
3. You can make requests without needing the API Key + Secret auth method, using this header directly from the client:

headers: {
    Authorization: `Bearer ${jwt}`
}

As long as the exp of the token is <= than now, it will work.

---

Happy hacking!