Unified Functions

QUERY 

Parameters

PARAMETERS 

Core Functions

EXRATE 

PRICE 

ORDERBOOKS 

OHLCV 

TRADES 

Calculating ROI...

ATH 

Supported Excha...

Troubleshooting

Tips & Tricks

Additional Reso...

Find Fields


> Get started with Cryptosheets **core custom functions** to pull dynamic, customized data into your worksheet with highly flexible formulas.

![Example 1](https://res.cloudinary.com/cryptosheets/image/upload/v1571966039/cryptosheets-docs/excel/functions/exrate-hp-9.gif)

1. Browse through the functions below
2. Start with our **[custom functions templates](https://app.cryptosheets.com/#/templates)** by clicking the **templates button** in the ribbon

![img](https://paradigmas.blob.core.windows.net/paradigmas-content/sharex/Book1_-_Excel_847x138.png)

3. Learn how to use our quick start **[auto templates in the help center](https://intercom.help/cryptosheets/en/articles/3469879-templates-custom-functions)**

## Unified Functions

---

The **parameters** and **query** functions allow users universal access to all data providers available in Cryptosheets

### QUERY [`=CS.QUERY()`](https://app.cryptosheets.com/#/functions/query)

Query function to pull any endpoint from any available provider

#### Parameters

- `provider` **[string]** Data provider, ex. Cryptunit.
- `endpoint` **[string]** Data endpoint of provider, ex. 'earnings-auto'.
- `parameters`
- `args`

### PARAMETERS [`=CS.PARAMETERS()`](https://app.cryptosheets.com/#/functions/parameters)

Function to pull all possible parameters by provider and endpoint

#### Parameters

- `provider` **[string]** Data provider, ex. Cryptunit.
- `endpoint` **[string]** Data endpoint of provider, ex. 'earnings-auto'.
- `args`

## Core Functions

---

The **core** functions are designed to pull in specific, large data sets including market and on chain data

### EXRATE [`=CS.EXRATE()`](https://app.cryptosheets.com/#/functions/exrate)

Get (streaming) exchange rate between pair of requested assets at specific or current time.

#### Parameters

- `base` **[string]** Requested exchange rate base asset identifier. Ex. "BTC"
- `quote` **[string]** Requested exchange rate quote asset identifier. Ex. "USD"
- `refresh` **[number]** Update frequency in seconds. Ex. 5 = 5 seconds. Default refresh rate is 15 minutes.

### PRICE [`=CS.PRICE()`](https://app.cryptosheets.com/#/functions/price)

Get the current price of any cryptocurrency in any other currency that you need.

#### Parameters

- `base` **[string]** The cryptocurrency symbol of interest.
- `quote` **[string]** Cryptocurrency symbol to convert into

### ORDERBOOKS [`=CS.ORDERBOOKS()`](https://app.cryptosheets.com/#/functions/orderbooks)

Get two sided bid and ask order book data, also known as books or passive level 2 data.

#### Parameters

- `base` **[string][41]** The cryptocurrency symbol of interest
- `quote` **[string][41]** Symbol of asset or currency to convert into
- `exchange` **[string][41]** Name of exchange
- `type` **[string][41]** Type of price ie spot or futures
- `timeStart` **[string][41]?** Timeseries starting time in ISO 8601
- `timeEnd` **[string][41]?** Timeseries ending time in ISO 8601
- `limitLevels` **[string][41]?** Maximum amount of levels from each side of the book to include in response (optional)
- `args`

### OHLCV [`=CS.OHLCV()`](https://app.cryptosheets.com/#/functions/ohlcv)

Get the historical open, high, low, close and volume of any cryptocurrency in any other currency that you need over a wide range of resolutions (intervals).

#### Parameters

- `base` **[string]** The cryptocurrency symbol of interest
- `quote` **[string]** Symbol of asset or currency to convert into
- `exchange` **[string]** Name of exchange
- `type` **[string]** Type of price ie spot or futures
- `period` **[string]** The time period for each candle aka the resolution
- `timeStart` **[string]** Timeseries starting time in ISO 8601
- `timeEnd` **[string]** Timeseries ending time in ISO 8601
- `args`

### TRADES [`=CS.TRADES()`](https://app.cryptosheets.com/#/functions/trades)

Get historical transactions from specific symbol, returned in time ascending order.

#### Parameters

- `base` **[string]** The cryptocurrency symbol of interest
- `quote` **[string]** Symbol of asset or currency to convert into
- `exchange` **[string]** Name of exchange
- `type` **[string]** Type of price ie spot or futures
- `timeStart` **[string]** Timeseries starting time in ISO 8601
- `timeEnd` **[string]** Timeseries ending time in ISO 8601
- `args`

### TA [`=CS.TA()`](https://app.cryptosheets.com/#/functions/ta)

#### Calculating ROI using CS.TA

You can easily calculate multi period returns for any supported pair and exchange by using the =CS.TA function

**Examples:**

**Return over Specific Period**
Available periods are: **1, 5, 7, 10, 30, 50, 100, 180, 200, 365**

`=CS.TA("BTC","USD",,{"Fields","change1,change10,change30,change180"})`

**Multi-Period Returns**

`=CS.TA("BTC","USD")`

> ![[kraken](https://res.cloudinary.com/cryptosheets/image/upload/cryptosheets-docs/excel/functions/csta-btc-usd.png)](https://res.cloudinary.com/cryptosheets/image/upload/cryptosheets-docs/excel/functions/csta-btc-usd.png)

**Exchange Specific Multi-Period Returns**

`=CS.TA("BTC","USD","Kraken")`

![[kraken](https://res.cloudinary.com/cryptosheets/image/upload/cryptosheets-docs/excel/functions/csta.png)](https://res.cloudinary.com/cryptosheets/image/upload/cryptosheets-docs/excel/functions/csta.png)

**Exchange Comparison Multi-Period Returns**
You can specify multiple exchanges as comma seperated names to return a comparison table.

> **TIP**: use `=CS.QUERY("Cryptosheets","Exchanges")` to quickly retrieve a list of over 280+ supported exchanges as of February 2020)

`=CS.TA("BTC","USD","Kraken,Bittrex,Gemini,Coinbase")`

![[multi-exchange](https://res.cloudinary.com/cryptosheets/image/upload/cryptosheets-docs/excel/functions/csta-multi-exchange.png)](https://res.cloudinary.com/cryptosheets/image/upload/cryptosheets-docs/excel/functions/csta-multi-exchange.png)
_This example uses TRANSPOSE() to wrap the Cryptosheets function and return a pivoted version of the dataset for display purposes only, the CS.TA function along with any other functions can be used with or without TRANSPOSE_

### ATH [`=CS.ATH()`](https://app.cryptosheets.com/#/functions/ath)

#### Supported Exchanges

- Use `=CS.QUERY("Cryptosheets","Exchanges")` to quickly retrieve a list of over 280+ supported exchanges as of February 2020

---

_Click on each custom function above to visit its dedicated support and resources page._

> - The goal is to keep our custom functions as easy and natural for users to remember and use. That means they are designed to be broadly useable with hundreds of different provider/endpoint combinations.

> - Future releases will include additional custom functions for more advanced use cases as well as additional tools and universal parameters. Stay up to date with our latest by visiting our **roadmap** and joining our **mailing list.**

## Troubleshooting

---

1. Check your syntax for **=CS.PARAMETERS()** carefully, different functions for the same data may have slightly different required syntax
2. Check the **required arguments** for **=CS.PARAMETERS()** vs the **optional arguments**
3. Check your data & API quotas and limits
4. Check your formulas carefully
5. Check your relative references (**=CS.PARAMETERS("CryptUnit", "earnings-auto")** vs. **=CS.PARAMETERS("A1", "B1")**)
6. Use Excel's **error checking tools**
7. Check Excel's help sections: https://support.office.com/en-us/article/function-arguments-65b29fb5-ec7b-4c0b-a54b-a67923571519
8. Find **additional troubleshooting resources** and tips **[here](https://app.cryptosheets.com/#/resources/troubleshooting)**
9. Error Response Codes Reference

**[See more troubleshooting tips & tricks here](https://app.cryptosheets.com/#/resources/troubleshooting)**

**Formula Syntax Error:**

![Example Error](https://res.cloudinary.com/cryptosheets/image/upload/v1568655136/cryptosheets-docs/errors/cs-custom-functions-query-error2_rmrl1n.png)

**Login error:**

![Example Error](https://res.cloudinary.com/cryptosheets/image/upload/v1568669257/cryptosheets-docs/errors/cs-custom-function-error-login_lofmnb.png)

### Tips & Tricks

**Pull up the full Excel function argument dialog box**

- Begin typing the function into any cell (for example **=CS.QUERY**) then press **cntrl + A** and it will open the popup dialog window
- Use the **formatDates** argument in custom functions to save significant time and effort reformatting and converting datetime data and columns **[read the article here](https://help.cryptosheets.com/en/articles/3577487-date-formatting-with-custom-functions)**

## Additional Resources

_For Microsoft Excel_

- **Web browsers used by add-ins:** https://docs.microsoft.com/en-us/office/dev/add-ins/concepts/browsers-used-by-office-web-add-ins
- **Office versions and requirement sets:** https://docs.microsoft.com/en-us/office/dev/add-ins/develop/office-versions-and-requirement-sets
- **How to check your Office version:** https://docs.microsoft.com/en-us/office/dev/add-ins/develop/office-versions-and-requirement-sets#how-to-check-your-office-version
- **Install the latest version of Office:** https://docs.microsoft.com/en-us/office/dev/add-ins/develop/install-latest-office-version
- **Custom Function Requirements:** https://docs.microsoft.com/en-us/office/dev/add-ins/excel/custom-functions-architecture

_For Googlesheets_

- **Throughput Quotas & Limits:** https://developers.google.com/apps-script/guides/services/quotas

---

## Find Fields

(Coming soon, please check back)


Get started with **core custom functions** to pull dynamic, customized data into your worksheet with highly flexible formulas.