Mesh

API Reference

Workshop

Get API keys

Dashboard

Get cached aggregated fiat balances from all connected integrations.

Get aggregated portfolio fiat balances

BuyingPower from all brokers, it indicates total amount of money the user can spend on buying stock.
Always includes cash and can also include margin

Amount of money in a specific currency from all brokers

Client Secret & Client Id

Getting Started

API Key Permissions

Handling Auth Tokens

Transfer Webhooks

Launch Checklist

Status Page

This page will help you get started with Mesh APIs to authenticate an account and configure, preview, and execute a transfer.

Managed Transfers with APIs

Supported Transfer Integrations

Link Utilization and Use cases

Link UI Events

This page will help you get started using Mesh SDKs to authenticate and make server side calls.

SDK Overview

Link Transfers Guide

Web SDK

iOS SDK

Android SDK

React Native SDK

Get catalog link

Get a short lived, one-time use token for initializing a Link session using the client-side SDKs

Get Link token with parameters

Refresh auth token of the connected institution.
Some institutions do not require tokens to be refreshed.
            
The following institutions require custom flows:
            
WeBull: AuthToken should be provided along with the RefreshToken
            
Vanguard: security settings may activate MFA, requiring user action.
If MFA is triggered, a second refresh request should be sent.
Second request should contain MFA code and access token obtained from initial response

Refresh auth token

Remove connection to the financial institution and erase all related data completely.

Remove connection

Get the list of supported institutions and their health statuses.

Get health status

Returns a list of integrations with details including the integration ID, name, type,
DeFi wallet provider ID, and categories.

Retrieve the list of all available integrations.

**Get supported networks list.**
 
---
Get the list of all networks supported by Mesh to perform transfers, including which tokens and integrations are supported.

Get networks

**Get supported integrations list.**
 
---
Get the list of all integrations supported by Mesh to perform transfers, including which tokens and networks are supported.

Get integrations

Get the list of all tokens supported by Mesh to perform transfers, including which networks and integrations are supported.

Get supported tokens list

**Get the list of networks and tokens eligible for a transfer, based on the provided request data.**
 
---
Transfers can be configured either from one connected account to another connected account, or
from a connected account to any arbitrary address or addresses.
 
* **From one connected account to another connected account:**
 
The API client provides `FromAuthToken` that is representing the source account and `ToAuthToken` that is representing the target account. Front API maps networks and tokens supported by both accounts and returns all tokens and networks eligible for a transfer as the result.
 
* **From a connected account to any arbitrary address:**
 
The API client provides `FromAuthToken` that is representing the source account and the list of target addresses using the `ToAddresses` field. Front API verifies the addresses and returns the list of tokens, eligible to be transferred as the result of the operation.
 
Returns the list of holdings on the account that can be used to perform the transfer. Each holdings item
contains the list of supported networks that can be used to transfer the corresponding asset.
Each network contains details such as gas fees and the amount eligible to be transferred.

Configure transfer

**Validate and preview the transfer.**
 
---
Validates the transfer, calculates the relevant amount in crypto if requested amount was in fiat and updates
the current network fee values.
 
This endpoint uses the `NetworkId` field to specify which network will be used to perform the transfer. The target `NetworkId`
should be selected after configuring the transfer using `/configure` endpoint.
 
Returns the `PreviewId` value that can be used to commit the transfer.

Preview transfer

**Commit the previously previewed transfer.**
 
---
Previews the transfer, using the `PreviewId` value.
 
Handles multi-factor authentication codes if the account is configured to use them for additional security.
 
Returns the status of the transfer and the details of the transfer if it was initiated successfully.

Execute transfer

Get or generate a cryptocurrency deposit address that can be used to transfer assets to the financial institution

Get deposit address

Get a quote for transferring a fiat amount from a brokerage account in a given cryptocurrency over a specified network.
Returns min and max fees and amounts to account for different funding sources (existing crypto balance, cash balance or
ACH/debit deposit). Currently only supported for Coinbase.

Quote transfer

Get cryptocurrency transfers initiated by Mesh on exchanges or self-custody wallets.

Get transfers initiated by Mesh

Obtain assets from the connected investment account. Performs realtime API call to the underlying integration.

Get holdings.

Obtain assets from the connected investment account and return total value and performance.
Performs realtime API call to the underlying integration.

Get holdings values.

Get the aggregated portfolio of the user containing market values.

Get aggregated portfolio

Get account balance

Verify account identity.

Get transactions on the account - the paginated history of the executed orders along with the pending orders.

Get transactions

Get details of an executed order. Typically used to poll the status of the previously executed order.

Get transaction details

Get supported features for trading for a particular financial institution. Different institutions support different
features (e.g. different `OrderType` or different sets of `TimeInForce` values), so this endpoint is used to
describe such features for provided financial institution.

Get supported order features for institution

Validates the order information (such as necessary balance availability), and returns additional information,
such as expected order fee.
Does not execute the order.

Preview order execution

Validates the order information and then calls institution's API to execute an order.
It's recommended to call this endpoint after calling the `preview` endpoint to make sure that the
order execution request is correct.

Execute order

Cancels a pending order (an order with `InProgress` status).
`SymbolPair` is required to be provided for `Binance`, `BinanceInternational`, `Okx` and `BitFlyer` institutions.
This value

Cancel order execution

Returns information on trading allowance for a provided symbol.
For example - some institutions allow fractional trading for some symbols, but do not allow it
for others. So before placing an order the API client can check if the required symbol can be traded fractionally
with the provided institution.

Get symbol information

Get authentication schemes of available integrations to perform authentication programmatically (not using
the Web Catalog UI).

Get authentication schemes

Authenticate user's brokerage/exchange account programmatically (not using the Web Catalog UI)

Authenticate user's account

Get OAuth link for the integrations with `OAuth` AuthenticationSchemeType

Get OAuth authentication link

Get entire history of cryptocurrency transfers (withdrawals or deposits) executed from an exchange.
Only supports Exchange integrations.

Get transfer history

Get details of a specific transfer (withdrawals or deposits) executed from an exchange.
Only supports Exchange integrations.

Get transfer details

Initiate a new cryptocurrency transfer on a blockchain, cryptocurrency broker or cryptocurrency exchange.
Obsolete endpoint, please use POST /transfers/managed/execute endpoint instead.

Initiate a transfer

Get details of the asset for deposit or withdrawal. For example, several exchanges support same tokens over multiple
blockchains, and thus require the name of chain to be supplied for transfers. This endpoint allows getting such details.

Managed Account Authentication

Managed Transfers

Portfolio

Balance

Verify

Transactions

Self Managed Account Authentication

Transfers

Get aggregated portfolio fiat balances

Authorizations

Query Parameters

Response