This endpoint returns the authentication token referred as VEZGO_USER_TOKEN in this doc.

This endpoint returns the list of a user's connected accounts.

Note: This endpoint is only useful for enterprise customers using direct API integration. If you are integrating with the Connect widget, this endpoint is not applicable. To get access to the Direct API, please contact the team.
Add a new user account for the authorized user. Each provider requires a different set of credentials. See the table below for the list of providers Wealthica currently supports, and the corresponding attributes that are required for the credentials object.

Note: Adding an account will toggle an asynchronous first sync task. If the account returns a login failed on the first sync, it will be automatically removed to minimize the number of abandoned connections.

This endpoint returns a specific account.

Note: This endpoint is only useful for enterprise customers using direct API integration. If you are integrating with the Connect widget, this endpoint is not applicable. To get access to the Direct API, please contact the team.
Update an existing account/connection. If credentials or security_answer is provided, a synchronization will be triggered.

Removes a specific account and all of its data from a user

Note: This endpoint is only useful for enterprise customers using direct API integration. If you are integrating with the Connect widget, this endpoint is not applicable. To get access to the Direct API, please contact the team.
Blocks (for max 30 seconds) listening for change to the account, and returns the updated version if any.

This endpoint triggers an account sync. Vezgo automatically synchronizes all accounts with providers once daily. You can also trigger an account sync at any time to get the latest data.

This endpoint returns the balance history for an account.
By default, data for the current year is returned.
NOTE: An account's balance history starts from the date the account was first connected to Vezgo.

Returns the transaction history for an account

To fetch all transactions, we need to enable pagination and go page-by-page.

First make a request with an empty last (?last=) for the first page. Then use the last transaction's ID from the first page to query the next page ?last=LAST_TRANSACTION_ID, and so on.

See example code at https://vezgo.com/docs/examples#get-all-transactions

• The same ?from param must be provided in all requests.
• If ?from is not passed, it defaults to the start of the current year. If you want to get all transactions including previous years, pass a very old date.
• If ?limit is not passed, it defaults to 100. Maximum value of ?limit allowed is 1000.
• sort can be only used when Pagination mode is not in use.

Due to trade reconciliation, ?limit doesn't guarantee the exact number of results to be returned. E.g. ?limit=10 might return 9 or fewer transactions, depending on how many times trade reconciliation happens within the 10 transactions queried from our DB.

Trade reconciliation is a process where 2 or more transactions that are originally part of a trade are combined into a single transaction_type: 'trade' transaction. This process is neccessary due to a current limitation in the Vezgo system, and will be removed in the next version of Vezgo API.

IMPORTANT: We have a hard limit of 6MB response size for transactions. If you are already passing ?limit then it should be good. But if you are passing in a large ?from=&to= range, or querying a very large account without passing in ?limit, any request returning more than 6MB of response will be dropped.

By default, transactions are sorted by transaction.initiated_at in ascending order.

When a last or limit is passed to the query, pagination mode is enabled. In this mode, transactions are sorted by their creation date (the date on which the transaction is added to the Vezgo system).

Returns a specific transaction

Returns the order history for an account

NOTE: Currently, orders are available for Binance only. Please reach us out to get this feature enabled for you.

To fetch all orders, we need to enable pagination and go page-by-page.

First make a request with an empty last (?last=) for the first page. Then use the last orders's ID from the first page to query the next page ?last=LAST_ORDER_ID, and so on.

See example code at https://vezgo.com/docs/examples#get-all-transactions

• The same ?from param must be provided in all requests.
• If ?from is not passed, it defaults to the start of the current year. If you want to get all orders including previous years, pass a very old date.
• If ?limit is not passed, it defaults to 100. Maximum value of ?limit allowed is 1000.
• sort can be only used when Pagination mode is not in use.

By default, orders are sorted by order.order_creation_time in ascending order.

When a last or limit is passed to the query, pagination mode is enabled. In this mode, orders are sorted by their creation date.

Returns a specific transaction

Removes the Vezgo user associated with the user token, and all of the user's accounts.