=CS.QUERY()

Scenario

1) CS.QUERY - S...

Function arguments

Function argume...

PARAMETERS - Ab...

2) CS.QUERY - E...

Examples - 

Troubleshooting

Additional Reso...

## =CS.QUERY()

<video-player></video-player>

In its simplest form, the CS.QUERY function says
**=CS.QUERY(what data source you want to use**, **what specific dataset from that source**, **list of specific parameters to filter the dataset**)



Check out the <a href="https://intercom.help/cryptosheets/en/articles/3600077-cs-query-pull-any-data-available-on-the-cryptosheets-platform-into-your-worksheets-with-formulas" rel="noopener noreferrer" target="_blank">latest tutorial documentation and examples for CS.QUERY</a> in the Cryptosheets Help Center

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

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

![image](https://res.cloudinary.com/cryptosheets/image/upload/cryptosheets-docs/google/functions/csquery-autocomplete.png)

### Scenario

Use **=CS.QUERY()** when you need maximum flexibility across all available providers including the ability to call any of their specific endpoints or datasets. This function is also generally the easiest to start using when you're learning how to use the Cryptosheets platform.

---

# 1) CS.QUERY - Syntax


### Function arguments

_Arguments:_ **=CS.QUERY("provider", "endpoint", {"parameter1", "parameter1value", "parameter2", "parameter2value"})**

_Values:_ `=CS.QUERY("CryptUnit", "earnings-auto")`

> **NOTE**: arguments like additional parameters that are wrapped in **curly brackets** **{like this}** are **required**, all other arguments should generally be considered **optional**

### Function argument descriptions

- **provider**: Data provider, ex. Cryptunit (required)
- **endpoint**: Data endpoint of provider, ex. 'earnings-auto' (required)
- **parameters**: List of path and query parameters (optional)
- **arguments**: Universal argument parameters (optional) configurable for use with any provider or endpoint combination

![image](https://res.cloudinary.com/cryptosheets/image/upload/cryptosheets-docs/excel/functions/ftx-funding-rates.gif)

### PARAMETERS - Absolute vs. Relative

**Absolute Parameter Values**

Formulas using **absolute values** for arguments with multiple parameters must be referenced inside an array using `{"curly_brackets"}` and will look like this:

`=CS.QUERY("Paradigm","clusters", {"clusterGroup","Scenario Benchmarks"})`

**Relative Parameter Values**

Formulas using **referenced values** for arguments with multiple parameters must be referenced inside an array using a defined range and will look like this _(\*Note - `{"curly_brackets"}` are NOT required when using referenced values)_:

`=CS.QUERY("Paradigm","clusters", A3:B4)`

**Relative Provider, Endpoint & Parameter Values**

Formulas using **referenced values for arguments with multiple parameters** must be referenced inside an array using a defined range and will look like this _(\*Note - `{"curly_brackets"}` are NOT required when using referenced values)_:

`=CS.QUERY(B1,B2,A3:B4)`



![image](https://downloads.intercomcdn.com/i/o/173366703/96e1682f33d8d5263eaa9e2f/image.png)

> **HINT**: if you ever get stuck on the syntax for a specific function formula, you can use the side panel console to **[build the entire formula for you!](https://intercom.help/cryptosheets/en/articles/3472916-using-the-cryptosheets-api-console-query-and-function-formula-builder-for-excel-googlesheets)**

![image](https://downloads.intercomcdn.com/i/o/173368105/bfe3fa7de8ba5aefd5cb4a0c/image.png)

**[Click here](https://app.cryptosheets.com/#/browse)** to search for data providers and endpoints



---

# 2) CS.QUERY - Examples

**TIP**: _Try copying + pasting the example formulas directly into your worksheet_

**Example 1:**

> **`=CS.QUERY("CryptUnit", "earnings-auto")`**

![image](https://downloads.intercomcdn.com/i/o/173341265/ffe951a66d9768513df3f78b/image.png)

**Example 2:**

> **`=CS.QUERY("CryptUnit", "coins-list")`**

![image](https://downloads.intercomcdn.com/i/o/173341586/fe24fa5ba35befd67943f8ee/image.png)

**Example 3:**

> **`=CS.QUERY("Bitmex", "Funding")`**

![image](https://downloads.intercomcdn.com/i/o/173368588/6a2edbb56c0a204b2337d9cf/image.png)

**Example 4:**

> **`=CS.QUERY("Paradigm", "TA Historical",{"symbol","btc";"limit","10"}))`**

**Try the example below by following these steps:**

1. Copy and past the formula (above) in the exact same place inside a new sheet **(E2)**
2. Rebuild the formula using only relative references **(B13:C20)**
3. Dynamically adjust the relative references for the **'fields' argument (C19)** to return only the `symbol` , `sma50` and `sma200` for **BTC**

**Step 1...**

![image](https://downloads.intercomcdn.com/i/o/173369979/8eb36d9e49e69ce12e627145/image.png)

**Step 2...**

![image](https://downloads.intercomcdn.com/i/o/173370139/01b14844c1d7ad2bc039425f/image.png)

**Step 3...**

![image](https://downloads.intercomcdn.com/i/o/173370571/2f3ccf3da5efedf2e3ac8016/image.png)



### Examples - **Errors**

![image](https://res.cloudinary.com/cryptosheets/image/upload/v1568981087/cryptosheets-docs/cs-custom-functions-query-error-syntax_uidvcs.png)

### Troubleshooting

1. Check your formula syntax for carefully, different functions for the same data may have slightly different required syntax
2. Check the **required arguments** for your function vs the **optional arguments**
3. Check your data & API quotas and limits
4. Check your formulas carefully
5. Check your relative references
6. Use Excels **error checking tools**
7. <a href="https://support.office.com/en-us/article/function-arguments-65b29fb5-ec7b-4c0b-a54b-a67923571519" rel="noopener noreferrer" target="_blank">Check Excels help sections</a>
8. Error Response Codes Reference

   - **#N/A** OK – Everything worked as expected
   - **#BUSY** Heavy query and/or unauthorized – Your User/Password API Keys are incorrect
   - **#LIMIT** Forbidden – You are not subscribed to the data feed requested
   - **Other** Something else? Reach out to us directly

## Additional Resources

_For Microsoft Excel_

- <a href="https://docs.microsoft.com/en-us/office/dev/add-ins/concepts/browsers-used-by-office-web-add-ins" rel="noopener noreferrer" target="_blank">Web browsers used by add-ins</a>
- <a href="https://docs.microsoft.com/en-us/office/dev/add-ins/develop/office-versions-and-requirement-sets" rel="noopener noreferrer" target="_blank">Office versions and requirement sets</a>
- <a href="https://docs.microsoft.com/en-us/office/dev/add-ins/develop/office-versions-and-requirement-sets#how-to-check-your-office-version" rel="noopener noreferrer" target="_blank">How to check your Office version</a>
- <a href="https://docs.microsoft.com/en-us/office/dev/add-ins/develop/install-latest-office-version" rel="noopener noreferrer" target="_blank">Install the latest version of Office</a>
- <a href="https://docs.microsoft.com/en-us/office/dev/add-ins/excel/custom-functions-architecture" rel="noopener noreferrer" target="_blank">Custom Function Requirements</a>

_For Googlesheets_

- <a href="https://developers.google.com/apps-script/guides/services/quotas" rel="noopener noreferrer" target="_blank">Throughput Quotas & Limits</a>

Use the CS.QUERY() function for all queries in Cryptosheets.

Query

QUERY