Providers

A provider is an exchange, blockchain or wallet your users can connect through Vezgo. Each account belongs to one, and carries it in account.provider.

The provider endpoints are public: they need no user token.

Endpoints

Endpoint	Returns
GET /providers vezgo.providers.getList()	Every provider Vezgo offers.
GET /providers/{name} vezgo.providers.getOne(name)	One provider.
GET /wallet-connect/providers	The wallets that connect through WalletConnect. See WalletConnect wallets.

GET /providers leaves out providers Vezgo no longer offers. Add ?unpublished=true to include them, flagged unpublished: true. Every field is in the API reference.

List providers

Node.js

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

cURL

curl https://api.vezgo.com/v1/providers

The provider object

Coinbase, shortened:

{
  "resource_type": "provider",
  "name": "coinbase",
  "display_name": "Coinbase",
  "logo": "https://app.wealthica.com/images/institutions/coinbase.png",
  "logo_svg": "https://app.wealthica.com/images/institutions/svg/coinbase.svg",
  "categories": ["exchange"],
  "auth_type": "oauth",
  "credentials": ["code"],
  "available_scopes": [{ "name": "wallet:accounts:read" }, { "name": "wallet:transactions:read" }],
  "features": { "accounts": 1, "positions": 1, "transactions": 1 },
  "is_beta": false,
  "outage": false,
  "connect_notice": "<p>Support for Positions &amp; Balances: …</p>",
  "authorize_url": "https://www.coinbase.com/oauth/authorize?account=all",
  "client_id": "COINBASE_OAUTH_CLIENT_ID"
}

Field	What it is
name	The provider's ID, for example coinbase. Pass it to user.connect({ provider }) to open Connect on that provider.
display_name	The name to show your users.
logo, logo_svg	The provider's logo as a PNG, and as an SVG when there is one.
categories	exchange, blockchain or wallet.
auth_type	How users connect: oauth, token (an API key), wallet (an address) or password.
credentials	What the user provides when connecting, for example code for OAuth or wallet for an address.
features	What Vezgo reads from this provider: accounts, positions, transactions.
is_beta	Whether support for the provider is still in beta.
outage, outage_incident_link	Whether the provider is having an outage, and the incident on status.vezgo.com. See Outages.
unpublished	true for a provider Vezgo no longer offers, returned only with ?unpublished=true. See Discontinued providers.
connect_notice	Notes about connecting this provider, as HTML.
authorize_url, client_id	For OAuth providers, what you need to build the authorization URL yourself. See Direct API Integration.

Offer providers to your users

Let the Connect widget list providers for you, or build your own list from GET /providers. Both options, WalletConnect wallets, outages and discontinued providers are covered in Maintain your provider list.

Each provider's status page describes what Vezgo reads from it, with its data mapping: https://vezgo.com/status/<name>-api/, for example vezgo.com/status/coinbase-api.