INTRODUCTION

FLUIDEFI® is an award-winning platform that provides near real-time¹ analytics, portfolio management, and alerting for thousands of decentralized financial (DeFi) digital assets. FLUIDEFI's analytics are calculated by patent-pending algorithms using blockchain transaction logs.

The FLUIDEFI RESTful API allows developers to:

• obtain detailed, accurate analytics of digital asset to identify investment opportunities across multiple decentralized exchanges;
• save their favorite tokens and liquidity pools for easy tracking;
• create portfolios the digital assets from multiple platforms;
• model the portfolio's performance based on historical returns;
• optimize the balances of the portfolios to maximize future profitability;
• monitor and receive alerts when digital asset metrics reach specified values or change over periods of time;
• analyze the actual profit and loss of digital asset holdings including those spread across multiple portfolios (wallets);
• swap digital assets more securely than ;
• add and remove liquidity from liquidity pools;
• develop and execute algorithmic trading strategies;

¹The term "near real-time" refers to the time delay introduced by 1) automated data processing and 2) network transmission between the occurrence of an event and the request of the processed data (the API call). The API responses include as_of_timestamp that specifies the UTC date/time that the API response was generated and last_processed which includes the UTC date/time the information was last calculated. FLUIDEFI uses ISO 8601 format for datetimes.

ACCESS TO THE FLUIDEFI API

Accessing the FLUIDEFI RESTful API requires:

1. A username and password. This information is provided when enrolling for the FLUIDEFI services.
2. The API endpoint to use. The API end-point will be in the form of a URL. If you just created a FLUIDEFI account, you can get started now using https://analytics.fluidefi.com/{API call}
   
   
   NOTE: The API end-point URL for your account is based on your FLUIDEFI subscription level, described here: https://analytics.fluidefi.com/price_plans/
   
   
3. Depending on your subscription level, the IP address(es) of your computer(s) making API requests may need to be white-listed with the FLUIDEFI network firewall. Please send an email with your username and the IP address(es) to be whitelisted to FLUIDEFI Support. Static IP addresses are recommended. Note: when using dynamic IP addresses, the FLUIDEFI firewall does not automatically update when your dynamic IP address changes.

The FLUIDEFI platform has been OWASP certified. Contact us for the certificate.
All API requests must be made to your designated API URL using HTTPS protocol via TCP/IP port 443 with TLS v1.3 or later and a quantum-ready SSL Cipher Suite. All FLUIDEFI servers use SSL certificates with sha256RSA signature algorithms issued by Sectigo RSA Domain Validation Secure Server CA.

FLUIDEFI SUPPORT

Your Service Level Agreement (SLA) is based on your subscription level.

• Priority email support (SLA 1-2 business days): [email protected]
• Dedicated Slack channel (SLA: 6 hours): Created when establishing your account.
• Support Email & Slack Monitoring Hours: 10:30 AM UTC - 02:30 AM UTC

FLUIDEFI'S LIQUIDITY POOL METRICS

CRYPTOCURRENCY & DIGITAL TOKEN PRICES

FLUIDEFI calculates prices using only decentralized exchange data extracted directly from the blockchain (no centralized exchange data is used). Our pricing algorthm relies on liquidity pools, such as Uniswap and Sushiswap, to construct a price index for a particular token or cryptocurrency.

Assume we would like to find the price of wBitcoin. The following steps are taken:

1. Identify all pools where wBTC is paired with BUSD, USDC, USDT, or WETH.
2. Compute the implied price of wBTC from each pool (by assuming equal value of reserves for both tokens).
3. Compute a poolsize-weighted average of the implied prices, so that larger liquidity pools have more influence on what the price should be.

APR VS. APY: WHAT’S THE DIFFERENCE?

Both annual percentage yield (APY) and annual percentage rate (APR) refer to the annual return generated from an investment, but they do so in different ways.

APY takes into account the compounding effect, and reports the annual return using one piece of information: the annual return itself. However, APR's calculation does not factor in compounding, and therefore reports the annual return using two pieces of information: the APR + the compounding frequency.

Here's an example of how both metrics are computed. Assume that for the past month, the total return for an investment is 2%. We calculate APR and APY as follows:

• APR = 2% * 12 = 24%
• APY = (1+2%)12 -1 = 26.82%

In this case, APY > APR due to the compounding effect that is not taken into account by APR.

Also, note that these two statements are equivalent and both report how much return to expect in a year:

1. Annual return of this investment is 26.82%
2. This investment has an APR of 24%, compounded monthly

APY is the simpler way of reporting the same information. For this reason, FLUIDEFI emphasizes APY figures.

SUPPORTED BASE CURRENCIES FOR CALCULATIONS

FLUIDEFI currently supports 24 fiat currencies, gold, silver, and 8,000+ digital assets & cryptocurrencies. Examples: USD, WETH, GBP, CAD, CHF, JPY, AUD, NZD, HKD, EUR, NOK, SEK, SGD, CNY, KRW, AED, BRL, XAU8, & XAG. If you need a fiat currency that is not listed here, contact support using the method below.

PRECISION

FLUIDEFI supports a precision of 160, which is the size of sqrtX96 variable in many smart-contracts used vr DeFi platforms. The precision of a number is the total count of significant digits in the whole number, or, in other words, the number of digits to both sides of the decimal point. For example: the number 123.4567 has a precision of 7. It is not uncommon to have amounts displayed as 8 digits to the left of the decimal and 16 digits to the right.

DATETIME FORMAT

FLUIDEFI supports ISO 8601 standard format date and datetimes. All datetimes are in UTC. The GET methods support YYYY-MM-DD. Example: "2021-06-01". POST methods support datetimes. Example: "2021-10-18T19:19:06.982417".

RATE LIMITING

Rate limits are based on your subscription level and vary between 5 and 60 calls per second.

"CURRENTLY IN ALPHA" AND "CURRENTLY IN BETA"

From time to time FLUIDEFI documentation may indicate an API call or parameter is currently in Alpha or Beta. "Currently in Beta" functionality is available to FLUIDEFI customers with access to our staging environment. "Currently in Alpha" functionality is available upon request to FLUIDEFI customers with dedicated servers.

STATUS CODES AND ERROR RESPONSES

All error responses have error code and a human-readable message. All error messages are in English.

RESPONSE CODES FOR TRANSACTION ROUTES

The following is a list of response codes and messages that will be included in the response when an error is encountered in a request to execute a transaction or encode transaction data fields.

GENERAL

SWAPS

LIQUIDITY - GENERAL

ADDING LIQUIDITY

REMOVING LIQUIDITY

 

---