Skip to main content

Vezgo documentation

One API for balances, positions and transaction history across crypto exchanges, blockchains and wallets.

Get startedAPI referenceGet your API keys →

Start here

Get started

Get your API keys and run the Connect flow against the Vezgo Demo provider in a few minutes.

Build with your AI agent

Copy-paste prompts that scaffold the backend, the Connect flow and webhooks in one go.

Connect a user

Open the drop-in Connect widget, or send users to the Connect URL and receive them back.

API reference

Every endpoint, object and field, generated from the OpenAPI spec.

Authentication

Every user-data call, and every Connect session, needs a short-lived user token that your backend requests.

  • Client ID and secret are issued per app in the Client portal. The secret stays on your backend — never ship it in a browser or mobile app.
  • The loginName header is your own stable ID for the user, such as an internal user ID rather than an email. The same loginName always returns the same user's accounts.
  • The user token lasts 10 minutes. Request a fresh one before each session and send it as Authorization: Bearer <token>.
  • Frontend apps get the token through an endpoint on your backend; the JS SDK calls it for you (authEndpoint).
Authentication guide →Manage apps and keys →
Request a user token
curl -X POST https://api.vezgo.com/v1/auth/token \
  -H 'loginName: USERNAME_FROM_YOUR_SYSTEM' \
  -H 'Content-Type: application/json' \
  -d '{"clientId": "YOUR_CLIENT_ID", "secret": "YOUR_CLIENT_SECRET"}'

# {"token": "YOUR_USER_TOKEN"}

Core API

What a connection gives you, and the endpoints that return it.

Accounts

A user's connected exchange account or wallet: its wallets, current balances, sync status and last error.

  • GET/accounts
  • GET/accounts/{id}
  • POST/accounts/{id}/sync
  • DELETE/accounts/{id}

Transactions

The history behind an account: trades, transfers, staking, rewards and fees, each with its fiat value.

  • GET/accounts/{id}/transactions
  • GET/accounts/{id}/transactions/{tx_id}

Providers

The exchanges, blockchains and wallets Vezgo connects to, and how each one authenticates.

  • GET/providers
  • GET/providers/{name}

Integration

SDKs for each part of your stack that talks to Vezgo.

SDK for your UI

Opens Vezgo Connect so your users can link their accounts.

  • WebAny web app: the drop-in Connect widget, from npm or a script tag.
  • React NativeThe JS SDK, with react-native-app-auth to open Connect.
  • iOSVezgo Connect through AppAuth-iOS.
  • AndroidVezgo Connect through AppAuth-Android.

SDK for your backend

Requests user tokens with your client secret and reads account data.

  • Node.jsvezgo-sdk-js: tokens, accounts and transactions.
  • Pythonpip install vezgo: tokens, accounts and transactions.

Build your integration

What a production integration needs, in order.

  1. Integrate webhooksKnow when an account finishes syncing, or fails to, instead of polling.
  2. Map the dataMap accounts, transactions and assets into your own data model.
  3. Customize your widgetPlace and style the Connect widget inside your own page.
  4. Maintain your provider listLet the widget list providers, or build your own list from the API, and handle outages and discontinued providers.
  5. Handle reconnectionsLet users reconnect an account when its credentials expire, without creating a duplicate.
  6. Clean up connectionsDelete the connections you no longer need, so they stop counting toward usage.

Additional features

Beyond balances and transactions.

KYC data

Retrieve the identity data a provider holds for a connected account: name, email and provider-specific details.

Balance reconciliation

Check that an account's transaction history adds up to the balances its provider reports.

Use cases

What teams build on Vezgo.

Portfolio trackers

Balances and history across every exchange and wallet your users hold.

Crypto tax and accounting

Complete transaction history, ready for tax and accounting software.

Lending

Verify assets and proof of funds for crypto-backed loans.

Compliance

Data for KYC, AML and regulatory reporting from a single API.

Digital asset auditing

Independent verification of crypto holdings for auditors.

Transfers

Let users link their accounts instead of copy-pasting destination addresses.

AI agents

Track and analyze the transactions of autonomous AI agents.

Resources

Incidents

Live status and incident history for the Vezgo API and every provider.

Follow incidents on status.vezgo.com, and subscribe there by email, RSS or Slack, for everything or only the components you use. Inside your app, a provider's outage field tells you when to warn users: see handling outages.

Subscribe to status updates