CS.ORDERBOOKS

Use Case Scenarios

ORDERBOOKS - Sy...

Function arguments

Function argume...

PARAMETERS - Ab...

ORDERBOOKS - Ex...

Troubleshooting


## CS.ORDERBOOKS

In its simplest form, the ORDERBOOKS function says
**=CS.ORDERBOOKS(get orderbook data on a given base asset, quote asset, exchange, instrument type, for this time period and with this much order book depth detail)**

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

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

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

### Use Case Scenarios

`When you need variable levels of order book depth and a high level of control & flexibility for specific base, quote and exchange pairs or instrument types`

---

## ORDERBOOKS - Syntax

### Function arguments

Arguments: `=CS.ORDERBOOKS("base","quote","exchange","type","timeStart","timeEnd","limitLevels","args")`

Example Values: `=CS.ORDERBOOKS("BTC","USD","Coinbase","SPOT","43446","43811","25","")`

### Function argument descriptions

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

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

- **base**: The cryptocurrency symbol of interest [string] required
- **quote**: Symbol of asset or currency to convert into [string] required
- **exchange**: Name of exchange [string] required
- **type**: Type of price ie spot or futures [string] required
- **timeStart**: Timeseries starting time in ISO 8601 [string] optional
- **timeEnd**: Timeseries ending time in ISO 8601 [string] optional
- **limitLevels**: Maximum amount of levels from each side of the book to include in response (optional) [string] optional
- **args**: Optional: Global arguments, ex. limit, fields [any] optional

### 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.ORDERBOOKS("BTC","USD","Coinbase","SPOT","43446","43811","25","")`

**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.ORDERBOOKS("B1","B2","B3","B4","B5","B6","B7","B8:C8")`

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

<a
  href="https://app.cryptosheets.com/#/browse"
  rel="noopener noreferrer"
  target="_blank"
>
  Click here
</a> to search for data providers and endpoints

---

## ORDERBOOKS - Examples

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

**Example 1:**

> `=CS.ORDERBOOKS("btc","usd","coinbase","spot",,,"1")`

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

**Example 2:**

> **`=CS.ORDERBOOKS("btc","usd","okex","perp",,,,"2")`**

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

**Example 3:**

> **`=CS.ORDERBOOKS("eth","usd","gemini","spot",,,,"2")`**

![image](https://res.cloudinary.com/cryptosheets/image/upload/cryptosheets-docs/excel/functions/csORDERBOOKS-example3.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**


Use the ORDERBOOKS function to get calls related to order book data, also known as books or passive level 2 data.

How to use ORDERBOOKS in Excel & Googlesheets

ORDERBOOKS