vezgo-sdk-js

Official Vezgo JS SDK for the Browser & NodeJS

What is Vezgo? A Unified Cryptocurrency API.

“We tried a few crypto data APIs to retrieve our users digital assets, Vezgo is the only one that actually works!” — Wealth Tracking Dashboard Dev

Vezgo is an API for connecting with cryptocurrency exchanges, wallets and protocols like Bitcoin. Instead of manually integrating with Crypto Exchange APIs like Coinbase API, Binance API, Bitcoin APIs, Crypto APIs or the hundreds of other cryptocurrency APIs - you can simply use Vezgo for them all.

Vezgo is the #1 alternative to the discontinued Zabo API.

We believe teams and developers should focus on building great products, not worry about the fragmented landscape of exchange APIs and blockchain protocols.

For our updated list of integrations, check out our list of Vezgo Integrations.

Vezgo API Javascript (JS) SDK

This is the Official Vezgo JS SDK for the Browser & NodeJS.

The Vezgo SDK provides convenient access to the Vezgo API from applications written in browser and server-side JavaScript. Please note that you must register and request your API keys to use in your application.

Documentation

Refer to the Vezgo API Documentation for more details.

Bugs, requests or suggestions

Get in touch at [e-mail] for bug reports, requests or suggestions.

Getting started

import Vezgo from 'vezgo-sdk-js';
// React Native or some other build systems
// import Vezgo from 'vezgo-sdk-js/dist/vezgo.es5';

(async () => {
  // Create a Vezgo SDK instance
  const vezgo = Vezgo.init({
    clientId: 'YOUR_CLIENT_ID',
    secret: 'YOUR_CLIENT_SECRET',
  });

  // Call the API helper methods
  const providers = await vezgo.providers.getList();
  const team = await vezgo.getTeam();

  // Alternately, pass a loginName to return a Vezgo SDK User instance in order to call
  // user-specific endpoints
  const user = Vezgo.init({
    clientId: 'YOUR_CLIENT_ID',
    secret: 'YOUR_CLIENT_SECRET',
    // Optional, only if you need to work with user data API, such as `vezgo.accounts.getOne(id)`,
    // or `vezgo.transactions.getList()` etc.
    loginName: 'YOUR_USERNAME_OR_ID',
  });

  // Call the user-specific API methods
  const account = await user.accounts.getOne('ACCOUNT_ID');
})();

APIs

General APIs

These methods are SDK-specific and do not have a corresponding Vezgo API endpoint.

vezgo.login(loginName)

This method logs a user in and returns a Vezgo SDK User instance so you can call user-specific APIs.

From server

loginName is required

// Create a Vezgo SDK instance
const vezgo = Vezgo.init({
  clientId: 'YOUR_CLIENT_ID',
  secret: 'YOUR_CLIENT_SECRET',
});

// Log user(s) in
const user1 = vezgo.login('USER_ID_1');
const user2 = vezgo.login('USER_ID_2');

// Call user APIs
const user1Account = await user1.accounts.getOne('ACCOUNT_ID_1');
const user2Account = await user2.accounts.getOne('ACCOUNT_ID_2');

From client (browser/ReactNative)

loginName is optional. Authentication is done either via an authEndpoint or a custom authorizer callback passed to Vezgo.init()

// Create a Vezgo SDK instance
const vezgo = Vezgo.init({
  clientId: 'YOUR_CLIENT_ID',
  // POST to `authEndpoint` on your server, expecting a JSON { token: 'USER_TOKEN' }
  authEndpoint: '/vezgo/auth', // default value
  // Optional parameters for `authEndpoint` to authenticate your user
  auth: {
    params: {}, // custom `authEndpoint` body
    headers: { Authorization: `Bearer ${yourAppsUserToken}` }, // custom `authEndpoint` headers
  },
  // Optional authorization method to use instead of `authEndpoint`
  authorizer: async (callback) => {
    try {
      const token = await getUserTokenFromYourServer();
      callback(null, { token });
    } catch (error) {
      callback(error);
    }
  }
});

// Log in to create a Vezgo User instance
const user = vezgo.login();

// Call user APIs
const account = await user.accounts.getOne('ACCOUNT_ID_1');

Example server implementation for authEndpoint:

const vezgo = Vezgo.init({
  clientId: 'YOUR_CLIENT_ID',
  secret: 'YOUR_CLIENT_SECRET',
});

router.post('/vezgo/auth', async function(req, res) {
  const user = vezgo.login(req.user.id);

  res.json({ token: await user.getToken() });
});

user.fetchToken()

This method fetches and returns a new user token.

NOTE

• User token has a maximum lifetime duration. Current default is 20 minutes.
• All User API methods automatically fetch a new token if the old one expires so this is rarely needed.

const token = await user.fetchToken();

user.getToken()

This method returns an existing user token or fetch a new one if the existing token has less than a specified amount of duration (default 10 seconds).

const vezgo = Vezgo.init({
  clientId: 'YOUR_CLIENT_ID',
  secret: 'YOUR_CLIENT_SECRET',
});

const user = vezgo.login('YOUR_USERNAME_OR_ID');
let token = await user.getToken(); // returns the user token, 20 minutes lifetime
// After 10 minutes
token = await user.getToken(); // returns the same token
// After 19 minutes 51 seconds
token = await user.getToken(); // fetches and returns a new token

// After > another 10 minutes
token = await user.getToken({ minimumLifeTime: 600 }); // fetches and returns another new token

user.getConnectData({ provider, redirectURI, state, lang, theme, providersPerLine })

This method returns a Vezgo Connect URL and authentication token for user to connect an account.

Vezgo Connect URL must be called via POST method and pass token in the form data.

User token has a 10 minutes session timeout.

const { url, token } = await user.getConnectData({
  provider: 'coinbase', // optional
  // required for server-side, optional for client (browser, ReactNative) or if already passed to `Vezgo.init()`.
  // Must be a registered URI.
  redirectURI: 'YOUR_REDIRECT_URI',
  // required for Vezgo Connect drop-in widget, but already handled by the SDK when calling
  // `user.connect()` (defaults to `window.location.origin`).
  // https://vezgo.com/docs/#connect-url-parameters
  accountId: 'ACCOUNT_ID',
  // Pass accountId to re-connect an existing account that has expired/revoked credentials
  origin: 'YOUR_SITE_ORIGIN',
  state: 'YOUR_APP_STATE', // optional
  lang: 'en', // optional (en | es | fr | it), 'en' by default
  providerCategories: ['exchanges', 'blockchains', 'wallets'], // optional, by default all categories are shown
  providers: ['binance', 'coinbase', 'ethereum'], // optional, ignored if `provider` is also passed in.
  theme: 'light', // optional (light | dark), 'light' by default
  providersPerLine: 1, // optional (1 | 2), 2 by default
  syncNfts: false, // optional, whether to show "Sync NFTs" checkbox. true by default (enabling sync_nfts feature on your account is done separately)
  features: 'feature1,feature2', // optional, a comma-separated list of features. undefined by default
  multiWallet: true // optional, allows to connect multiple wallets in one take and return list of connected account and list of errors, also this mode allows to select multiple networks for wallets
});
// {
//   url: "https://connect.vezgo.com/connect/coinbase?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&origin=YOUR_SITE_ORIGIN&state=YOUR_APP_STATE&lang=en&theme=light&providersPerLine=2",
//   token: "USER_TOKEN"
// }

// POST Vezgo Connect URL from client (browser/ReactNative) example:
const form = document.createElement("form");
form.method = "POST";
form.action = url;

const input = document.createElement("input");
input.type = "hidden";
input.name = "token";
input.value = token;
form.appendChild(input);

document.body.appendChild(form);

form.submit();

// Alternatively, pass redirectURI once to `Vezgo.init()`
const vezgo = Vezgo.init({
  clientId: 'YOUR_CLIENT_ID',
  secret: 'YOUR_CLIENT_SECRET',
  redirectURI: 'YOUR_REDIRECT_URI',
  origin: 'YOUR_SITE_ORIGIN',
});

const user1 = vezgo.login('USER_ID_1');
const { url: url1, token } = await user1.getConnectData();

const user2 = vezgo.login('USER_ID_2');
const { url: url2, token } = await user2.getConnectData();

user.connect({ provider, providers, providerCategories, accountId, lang, theme, providersPerLine, syncNfts, features, multiWallet })

This method starts the Vezgo Connect process inside your webpage/app for user to connect their account.

Connection response are provided via callbacks.

This method accepts the same parameters as user.getConnectData() except for redirectURI, origin and state

user.connect({
  // additional options
}).onConnection((account) => {
  // Send the account to your server
  sendToServer('/some-route', account);
}).onError(error => {
  console.error('account connection error:', error)
}).onEvent((name, data) => {
  console.log('account connection event:', name, data);
});

In multiWallet mode

user.connect({
  // additional options
}).onConnection((result) => {
  console.log(result.message);

  // Send the account to your server
  result.accounts.map(async (account, key) => {
    // Send the account to your server
    if(account) {
      await sendToServer('/some-route', account);
    } else {
      console.error(messages[key]);
    }
  });
}).onError(error => {
  console.error('account connection error:', error)
}).onEvent((name, data) => {
  console.log('account connection event:', name, data);
});

user.reconnect(accountId, options)

This method starts the Vezgo Connect process to re-connect an existing account that has expired/revoked credentials.

Connection response are provided via callbacks.

user.reconnect('ACCOUNT_ID', {
  // additional options
}).onConnection((account) => {
  // Send the account to your server
  sendToServer('/some-route', account);
}).onError(error => {
  console.error('account connection error:', error)
}).onEvent((name, data) => {
  console.log('event:', name, data);
});

User APIs

These methods return user data and thus require a Vezgo SDK User instance. They automatically fetch a new token if necessary so you would not be bothered with tokens logic.

user.accounts.getList()

This method retrieves the list of accounts for a user.

const accounts = await user.accounts.getList();

[
  {
    "id": "603522490d2b02001233a5d6",
    "provider": {
      "name": "coinbase",
      "display_name": "Coinbase",
      "logo": "https://app.wealthica.com/images/institutions/coinbase.png",
      "type": "oauth",
      "scopes": [],
      "resource_type": "provider"
    },
    "balances": [
      {
        "ticker": "BTC",
        "provider_ticker": "BTC",
        "name": "Bitcoin",
        "asset_is_verified": null,
        "asset_type": "",
        "amount": "0.20210831",
        "decimals": 8,
        "fiat_ticker": "USD",
        "fiat_value": "2021.08",
        "fiat_asset_is_verified": null,
        "logo": "https://data.wealthica.com/api/securities/CRYPTO:BTC/logo",
        "updated_at": 1630412605283,
        "misc": null,
        "resource_type": "balance"
      }
    ],
    "blockchain": null,
    "created_at": 1630412605283,
    "updated_at": 1630412605283,
    "resource_type": "account",
  },
  {
    "id": "603522490d2b02001233a5d7",
    "provider": {
      "name": "bitcoin",
      "display_name": "Bitcoin Address",
      "logo": "https://app.wealthica.com/images/institutions/bitcoin.png",
      "type": "wallet",
      "scopes": [],
      "resource_type": "provider"
    },
    "balances": [],
    "blockchain": null,
    "created_at": 1630412605283,
    "updated_at": 1630412605283,
    "resource_type": "account",
  }
]

user.accounts.getOne(id)

This method retrieves a single account.

const account = await user.accounts.getOne('603522490d2b02001233a5d6');

{
  "id": "603522490d2b02001233a5d6",
  "provider": {
    "name": "coinbase",
    "display_name": "Coinbase",
    "logo": "https://app.wealthica.com/images/institutions/coinbase.png",
    "type": "oauth",
    "scopes": [],
    "resource_type": "provider"
  },
  "balances": [
    {
      "ticker": "BTC",
      "provider_ticker": "BTC",
      "name": "Bitcoin",
      "asset_is_verified": null,
      "asset_type": "",
      "amount": "0.20210831",
      "decimals": 8,
      "fiat_ticker": "USD",
      "fiat_value": "2021.08",
      "fiat_asset_is_verified": null,
      "logo": "https://data.wealthica.com/api/securities/CRYPTO:BTC/logo",
      "updated_at": 1630412605283,
      "misc": null,
      "resource_type": "balance"
    }
  ],
  "blockchain": null,
  "created_at": 1630412605283,
  "updated_at": 1630412605283,
  "resource_type": "account",
}

user.accounts.sync(id)

This method triggers an account sync.

const account = await user.accounts.sync('603522490d2b02001233a5d6');

user.accounts.remove(id)

This method removes a single account from the user.

await user.accounts.remove('603522490d2b02001233a5d6');

user.history.getList({ accountId, from, to, wallet })

This method retrieves the balance history for an account.

Returns data within the last 1 year by default.

const history = await user.history.getList({
  accountId: '603522490d2b02001233a5d6',
  from: '2021-01-01',
  to: '2021-09-09',
  wallet: 'bitcoin:cash:usd',
});

[
  {
    "id": "6144755af8a77cae7174afa3",
    "date": 1630412605283,
    "wallet": "demo:cash:usd",
    "fiat_ticker": "USD",
    "fiat_value": "125.30"
  },
  {
    "id": "6144755af8a77cae7174afa4",
    "date": 1630412605283,
    "wallet": "demo:cash:cad",
    "fiat_ticker": "USD",
    "fiat_value": "125.30"
  },
]

user.transactions.getList({ accountId, ticker, from, to, wallet, last, limit, sort, types, exclude_fields })

This method retrieves the list of transactions for an account.

Returns data within the last 1 year by default.

const transactions = await user.transactions.getList({
  accountId: '603522490d2b02001233a5d6',
  ticker: 'BTC', // optional
  from: '2020-08-31', // optional
  to: '2021-08-31', // optional
  wallet: 'bitcoin:cash:usd', // optional
  last: '603522490d2b02001233a5d6', // optional, blank string is allowed
  limit: 10, // optional
  sort: 'asc', // optional, asc | desc
  types: 'trade,deposit', // optional
  exclude_fields: 'other_parties,transaction_hash' // optional
});

[
  {
    "id": "603522490d2b02001233a5d6",
    "status": null,
    "transaction_type": "deposit",
    "parts": [
      {
        "direction": "received",
        "ticker": "BTC",
        "provider_ticker": "BTC",
        "amount": "1.20210831",
        "asset_is_verified": null,
        "fiat_ticker": "USD",
        "fiat_value": "1234567.8",
        "fiat_asset_is_verified": null,
        "other_parties": []
      }
    ],
    "fees": [
      {
        "type": null,
        "ticker": "USD",
        "provider_ticker": "USD",
        "amount": "0.5",
        "asset_is_verified": null,
        "fiat_ticker": "",
        "fiat_value": "",
        "fiat_asset_is_verified": null,
        "resource_type": "transaction_fee"
      }
    ],
    "misc": [],
    "fiat_calculated_at": 1630412605283,
    "initiated_at": 1630412605283,
    "confirmed_at": 1630412605283,
    "resource_type": "transaction"
  },
  {
    "id": "603522490d2b02001233a5d7",
    "status": null,
    "transaction_type": "deposit",
    "parts": [],
    "fees": [],
    "misc": [],
    "fiat_calculated_at": 1630412605283,
    "initiated_at": 1630412605283,
    "confirmed_at": 1630412605283,
    "resource_type": "transaction"
  }
]

user.transactions.getOne({ accountId, txId })

This method retrieves a single transaction.

const transaction = await user.transactions.getOne({
  accountId: '603522490d2b02001233a5d6',
  txId: '603522490d2b02001233a5d6'
});

{
  "id": "603522490d2b02001233a5d6",
  "status": null,
  "transaction_type": "deposit",
  "parts": [
    {
      "direction": "received",
      "ticker": "BTC",
      "provider_ticker": "BTC",
      "amount": "1.20210831",
      "asset_is_verified": null,
      "fiat_ticker": "USD",
      "fiat_value": "1234567.8",
      "fiat_asset_is_verified": null,
      "other_parties": []
    }
  ],
  "fees": [
    {
      "type": null,
      "ticker": "USD",
      "provider_ticker": "USD",
      "amount": "0.5",
      "asset_is_verified": null,
      "fiat_ticker": "",
      "fiat_value": "",
      "fiat_asset_is_verified": null,
      "resource_type": "transaction_fee"
    }
  ],
  "misc": [],
  "fiat_calculated_at": 1630412605283,
  "initiated_at": 1630412605283,
  "confirmed_at": 1630412605283,
  "resource_type": "transaction"
}

user.orders.getList({ accountId, from, to, last, limit, sort })

This method retrieves the list of orders for an account.

Returns data within the last 1 year by default.

const orders = await user.orders.getList({
  accountId: "651538b55e8e333d9c7cdc0d",
  from: "2020-08-31", // optional
  to: "2021-08-31", // optional
  last: "603522490d2b02001233a5d6", // optional, blank string is allowed
  limit: 10, // optional
  sort: "asc", // optional, asc | desc
});

[
  {
    "wallet": "binance:cash:usd",
    "order_id": "823874",
    "order_status": "filled",
    "type": "MARKET",
    "time_in_force": "GTC",
    "side": "sell",
    "base_ticker": "TRX",
    "quote_ticker": "USDT",
    "order_quantity": 1000,
    "order_price": 0,
    "filled_price": 87.62,
    "filled_quantity": 1000,
    "average_execution_price": 0.08762,
    "misc": {
      "fee": "0.00000000",
      "fee_currency": "USDT",
      "trade_id": 45973,
      "client_order_id": "iuO5N3C6FVDk8Wah1HD61a",
      "stop_price": "0.00000000",
      "last_event_timestamp": 1696335257294,
      "last_executed_price": "0.08762000",
      "last_executed_quantity": "1000.00000000",
      "trailing_time": null
    },
    "id": "651c05bad9b09e73c20e5a05",
    "account": "651538b55e8e333d9c7cdc0d",
    "resource_type": "order",
    "order_creation_time": 1696335257294,
    "updated_at": 1696343148933
  },
  {
    "wallet": "binance:cash:usd",
    "order_id": "3944",
    "order_status": "filled",
    "type": "MARKET",
    "time_in_force": "GTC",
    "side": "sell",
    "base_ticker": "TRX",
    "quote_ticker": "USDT",
    "order_quantity": 1000,
    "filled_price": 88.33,
    "filled_quantity": 1000,
    "average_execution_price": 0.08832999999999999,
    "misc": {
      "fee": "0.00000000",
      "fee_currency": "USDT",
      "trade_id": 266,
      "client_order_id": "egqq1TAZylB5umBrNMNfTp",
      "stop_price": "0.00000000",
      "last_event_timestamp": 1696431328092,
      "last_executed_price": "0.08833000",
      "last_executed_quantity": "1000.00000000",
      "trailing_time": null
    },
    "order_price": 0,
    "id": "651c05bad9b09e73c20e5a05",
    "account": "651538b55e8e333d9c7cdc0d",
    "resource_type": "order",
    "order_creation_time": 1696431328092,
    "updated_at": 1696431339336
  }
]

user.orders.getOne({ accountId, orderId })

This method retrieves a single order.

const order = await user.orders.getOne({
  accountId: "603522490d2b02001233a5d6",
  orderId: "651538b55e8e333d9c7cdc0d",
});

{
  "wallet": "binance:cash:usd",
  "order_id": "823874",
  "order_status": "filled",
  "type": "MARKET",
  "time_in_force": "GTC",
  "side": "sell",
  "base_ticker": "TRX",
  "quote_ticker": "USDT",
  "order_quantity": 1000,
  "order_price": 0,
  "filled_price": 87.62,
  "filled_quantity": 1000,
  "average_execution_price": 0.08762,
  "misc": {
    "fee": "0.00000000",
    "fee_currency": "USDT",
    "trade_id": 45973,
    "client_order_id": "iuO5N3C6FVDk8Wah1HD61a",
    "stop_price": "0.00000000",
    "last_event_timestamp": 1696335257294,
    "last_executed_price": "0.08762000",
    "last_executed_quantity": "1000.00000000",
    "trailing_time": null
  },
  "id": "651c05bad9b09e73c20e5a05",
  "account": "651538b55e8e333d9c7cdc0d",
  "resource_type": "order",
  "order_creation_time": 1696335257294,
  "updated_at": 1696343148933
}

Data APIs

These methods provide general Vezgo information and do not require logging in a user.

const vezgo = Vezgo.init({
  clientId: 'YOUR_CLIENT_ID',
  secret: 'YOUR_CLIENT_SECRET',
});

const providers = await vezgo.providers.getList();

vezgo.providers.getList()

This method retrieves the list of Vezgo supported providers.

const providers = await vezgo.providers.getList();

[
  {
    "name": "coinbase",
    "display_name": "Coinbase",
    "logo": "https://app.wealthica.com/images/institutions/coinbase.png",
    "auth_type": "oauth",
    "available_scopes": [],
    "available_currencies": null,
    "resource_type": "provider",
    "status": null,
    "is_beta": true,
    "connect_notice": "",
    "credentials": ["code"]
  },
  {
    "name": "bitcoin",
    "display_name": "Bitcoin Address",
    "logo": "https://app.wealthica.com/images/institutions/bitcoin.png",
    "auth_type": "wallet",
    "available_scopes": [],
    "available_currencies": null,
    "resource_type": "provider",
    "status": null,
    "is_beta": true,
    "connect_notice": "",
    "credentials": ["wallet"]
  }
]

vezgo.providers.getOne(id)

This method retrieves a single provider.

const provider = await vezgo.providers.getOne('coinbase');

{
    "name": "coinbase",
    "display_name": "Coinbase",
    "logo": "https://app.wealthica.com/images/institutions/coinbase.png",
    "auth_type": "oauth",
    "available_scopes": [],
    "available_currencies": null,
    "resource_type": "provider",
    "status": null,
    "is_beta": true,
    "connect_notice": "",
    "credentials": ["code"]
  }

Development

Install

yarn install

Build

yarn build

Test

yarn build
yarn test

Use GET method in Connect URL instead of POST

Pass additional flag connectionType: 'GET' to use GET method in Connect URL instead of POST:

connect({ connectionType: 'GET' })
reconnect(accountId, { connectionType: 'GET' })

That's useful for developing Connect URL when vite local server used. Token exposed in URL when GET method used what is not secure so this feature should be used only for development goals.

Release

npm version patch # or minor/major
git push && git push --tags
# wait until merged then
npm publish