Documentation Sections

1.  Syntax Basics
2.  Syntax Shorthand
3.  Running IEX-Sharp
4.  Excel Template Syntax
5.  Excel Functions
6.  Cryptocurrency Syntax


Syntax Basics

The current full syntax for a template in IEX-Sharp Version 1.0 is:

{{ TICKER=StockTicker; METRIC=ValidMetric; FORMAT=MicrosoftStyleFormat; MARKET=ValidMarket; }}

An example of valid inputs for a template is:

{{ TICKER=AMZN; METRIC=Profit; FORMAT=$ #,##0.00; MARKET=Equity; }}

For a detailed explanation of all the arguments available in IEX-Sharp:

Argument Description
TICKER=AmZn Fetch data on the company Amazon
METRIC=Profit Fetch the Profit/Net Income for, in this case, Amazon
FORMAT=$ #,##0.00 Format the data, using Microsoft style formatting, so that, say, if the Profit is 1000000, it will be reformatted as $ 1,000,000.00. This formatting is available in Excel when using the =FORMAT() function, and more information on it can be found here
MARKET=Equity Toggles between which market we should pull data from. Currently, IEX-Sharp supports 2 markets, Equity and Crypto, which can be used to pull in data on equity securities and cryptocurrencies, both of which comes from the IEX Cloud

However, some of these arguments are optional. As of IEX-Sharp Version 1.0, TICKER is the only required argument, all the rest of them can be omitted. If an argument is omitted, a default value will be used. This table explains the optional values and default arguments


Template construction is very flexible in IEX-Sharp and is designed to allow the user to make small errors in the template while still remaining valid. For example, while the recommended format of the templates is to separate each argument with a semicolon and a space, extra spaces or semicolons, or even no spaces between arguments, would still be valid. All of the below templates are valid templates

{{TICKER=AMZN;METRIC=Profit;FORMAT=$ #,##0.00;MARKET=Equity;}}

{{TICKER=AMZN;  ; METRIC=Profit;      FORMAT=$ #,##0.00;;;MARKET=Equity; }}

Also, templates are not case-sensitive, so the following is a valid template templates

{{Ticker=AMZN; metric=Profit; FoRmAt=$ #,##0.00;mARKET=Equity}}

And while semicolons are needed between arguments, the last argument doesn't need to end in a semicolon, so we can omit it like in the above template


Syntax Shorthand

The IEX-Sharp templating language also allows for short-hand versions of the names of arguments, such as Ticker and Metric, by using T and M respectively instead. Here is a list of all current short-hand versions:

Long-Hand Short-Hand
Ticker T
Metric M
Format F
Market S

The short-hand versions are also not case-sensitive, and so the following are all valid templates

{{ T=AMZN; m=Profit; F=$ #,##0.00; s=Equity }}

And so the shortest template we can make would be:

{{T=AMZN}}

Which would pull in the current stock price for, in this case, Amazon.


Running the Program

Once all your templates are constructed and you want to pull data from the IEX Cloud into your document, presentation, or email, simply go to the IEX-Sharp tab in the Microsoft Office Ribbon, and click the Fetch All Data button:

Document.docx - Word
File Home Insert Design Layout Review IEX-Sharp             
 Fetch
All Data
API Key Help

Excel Template Syntax

To pull in data from Excel into Word, PowerPoint, or Outlook, use the following template syntax:

{{ C:\Users\Person\Desktop\[FinacialModelsWorkbook.xlsx]Sheet5'!$B$3 }}

This template contains four key elements that IEX-Sharp uses to pull the data for you from your Excel Workbooks into your Word, PowerPoint, and Outlook documents:

Path C:\Users\Person\Desktop\
Workbook Name [FinacialModelsWorkbook.xlsx]
Sheet Name Sheet5'!
Cell $B$3

This is the default syntax that Excel uses to pull in data from other workbooks, so an easy way to create this template is to open the workbook you want to pull data from, open a new workbook, press the "=" key in a cell to start a function in the new workbook, and click on the other workbook. This will create a cell linked to the other workbook, and when you save and close the other workbook, Excel will update the formula so that it uses the same syntax as IEX-Sharp. You can then simply copy and paste the template into your Word, PowerPoint, or Outlook document.

IEX-Sharp also comes with a shorthand version of the Excel templates. If the workbook you cant to pull data from is in the same folder as the Word or PowerPoint document, you can use the following syntax for the template:

{{ [FinacialModelsWorkbook.xlsx]Sheet5'!$B$3 }}

Additionally, like IEX-Sharp templates, Excel templates attempt to correct errors in the template by correcting for excess spaces in the template. so the following is also valid:

{{    [FinacialModelsWorkbook.xlsx]Sheet5'!$B$3  }}

One difference between IEX templates and Excel templates is that Excel templates use the format of the cells that you pull from in Excel, and so a FORMAT argument cannot be used as of version 1.0.


Excel Functions

IEX-Sharp also allows you to pull data from IEX Cloud into Excel using a function called =IEX() in Excel. Here is the syntax of this function:

=IEX(StockTicker, MetricName, MarketName)

Here is an example of how you would use the function in Excel:

A B C D E
1
2 =IEX("AMZN")
3 =IEX("AMZN", "Profit")
4 =IEX("AMZN", "Revenue", "Equity")
5

The first function =IEX("AMZN") will default to price as the value it pulls from the IEX Cloud, just like IEX templates

The second function =IEX("AMZN", "Profit") will pull in Amazon's profit in this case

The third function =IEX("AMZN", "Revenue", "Equity") will pull in Amazon's revenue. The third input, "Equity" is used to switch between pulling in data on Equity securities (when it is set to "Equity"), and Cryptocurrencies (when it is set to "Crypto"). By default this value will be set to "Equity", so it can be excluded when you want to pull in data on equities such as AMZN, AAPL, MSFT, etc.

We can also uses references in Excel in the formula like so:

A B C D E
1 AMZN
2 Revenue   =IEX($B$1, A2)  
3 Profit   =IEX($B$1, A3)  
4 Assets   =IEX($B$1, A4)  
5 Liabilities   =IEX($B$1, A5)  

Both Excel and IEX-templates take the exact same metrics which can be found on the Metrics Page. Unlike the IEX-templates, but similar to the Excel-Templates, the =IEX() function does not take a FORMAT input. To format a cell pulling in data using the =IEX() function, use the built-in =TEXT() function in Excel. Here is an example:

A B C D E
1 =TEXT(IEX("AMZN", "Revenue"), "$ #,##0.00")
2 $ 72,383,000,000.00
3
4
5


Using a combination of IEX-templates, Excel-templates, and the =IEX() function can be very powerful. For example, you can create a financial model in Excel, pull the data needed for the financial model from the IEX Cloud, and then pull in the output of the financial models into a PowerPoint Presentation, into a Word Document, and into an Outlook Email, saving significant amounts of time in the long run, and reducing numerous errors from routine tasks. There are many situations where you might have a template Presentation, Document, or Email that you are using, and IEX-Sharp allows you to augment your templates in a quick and effortless way, with just a click of a button



Cryptocurrency Syntax

IEX Cloud also has data on Cryptocurrencies. To pull Cryptocurrency data, a Cryptocurrency ticker must be used, and the Market must be set to Crypto. As an example, here is how we would pull data for Bitcoin:

{{ TICKER=BTCUSDT; METRIC=LatestPrice; MARKET=Crypto }}

This will pull the latest price that the IEX Cloud has for Bitcoin. And, if we wanted to pull this same data into Excel using the =IEX(), the syntax would be:

A B C
1 =IEX("BTCUSDT", "LatestPrice", "Crypto")
2 5034.11
3
4

Below is a list of some cryptocurrency tickers that are supported by IEX-Sharp and that are available on IEX Cloud:

Name Ticker
Bitcoin BTCUSDT
EOS EOSUSDT
Ethereum ETHUSDT
Binance Coin BNBUSDT
Ontology ONTUSDT
Bitcoin Cash BCCUSDT
Cardano ADAUSDT
Ripple XRPUSDT
TrueUSD TUSDUSDT
TRON TRXUSDT
Litecoin LTCUSDT
Ethereum Classic ETCUSDT
MIOTA IOTAUSDT
ICON ICXUSDT
NEO NEOUSDT
VeChain VENUSDT
Stellar Lumens XLMUSDT
Qtum QTUMUSDT