> For the complete documentation index, see [llms.txt](https://3commas.gitbook.io/3commas-official-api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://3commas.gitbook.io/3commas-official-api-docs/grid-bot/get-the-list-of-grid-bots.md).

# Get the list of Grid Bots

<br>

**Description:** Returns the list of Grid Bots. Use the body parameters to filter results<br>

**Permission:** BOTS\_READ\
**Security:** SIGNED\ <br>

> <mark style="color:blue;">**`GET`**</mark>
>
> `/ver1/grid_bots`

<br>

## Query Parameters<br>

**account\_id**     `string`\
Unique 3Commas ID for this Grid Bot entity.\
Use a comma-separated list to specify multiple account\_id values

**state**     `string`\
Return entities that match the specified state.\
Use `enabled` to get active bots and `disabled` to get inactive bots

**sort\_by**     `string`\
Specifies the field by which to sort the response

**sort\_direction**     `string`\
Sets the direction of order (`[ASC]` or `[DESC]`)\
Default: `[DESC]`

**limit**     `string`\
Quantity of the records you want to get in response.\
Minimum: `1`; Maximum: `1000`\
Default: `10`

**offset**     `integer`\
Used to specify the starting point for a set of records to return in a paginated list\
Default: `0`

**from**     `string`\
Parameter for a filter by created date

**base**     `string`\
Return entities that match the base currency of the trading pair (e.g., `BTC` for BTC/USDT)

**quote**     `string`\
Return entities that match the quote currency of the trading pair (e.g., `USDT` for BTC/USDT)

<br>

## Parameters response<br>

If successful, the response includes an array of [Grid Bot](/3commas-official-api-docs/grid-bot.md) entities.

<br>

## Example request<br>

```json
GET  /ver1/grid_bots?account_ids[]=32833909&account_ids[]32864603
```

<br>

## Example Response and errors<br>

<details>

<summary>Status: 200 OK</summary>

\
\[ { "id": 2338357, "account\_id": 32833909, "account\_name": "My Binance", "is\_enabled": true, "grids\_quantity": "81", "created\_at": "2024-10-03T19:53:35.530Z", "updated\_at": "2024-10-07T23:04:03.759Z", "strategy\_type": "manual", "upper\_stop\_loss\_enabled": false, "lower\_stop\_loss\_enabled": false, "note": "New comment about this Grid Bot", "editable": true, "lower\_price": "0.0175", "lower\_stop\_loss\_price": null, "lower\_stop\_loss\_action": "stop\_bot", "upper\_price": "0.024073", "upper\_stop\_loss\_price": null, "upper\_stop\_loss\_action": "stop\_bot", "quantity\_per\_grid": "20.0", "leverage\_type": "cross", "leverage\_custom\_value": "10.0", "name": "VETUSDT/BNFCR", "pair": "BNFCR\_VETUSDT", "start\_price": "0.022395", "grid\_price\_step": "1.00399408015751539830711995", "current\_profit": "2.8432585523697479", "current\_profit\_usd": "2.8432585523697479", "total\_profits\_count": "23", "bought\_volume": "0.0", "sold\_volume": "0.0", "profit\_percentage": "0.177716336029358217871680786990536", "current\_price": "0.022681", "max\_active\_buy\_lines": "81", "max\_active\_sell\_lines": "81", "order\_currency\_type": "quote", "profit\_currency\_type": "quote", "trailing\_up\_enabled": "true", "grid\_type": "geometric", "investment\_base\_currency": "830.806297511735138952353258838", "investment\_quote\_currency": "200.0", "unrealized\_profit\_loss": "0.14717986", "current\_profit\_loss": "2.9904384123697479", "current\_profit\_loss\_percent": "0.1869157334723778284605040877565797", "orderbook\_price\_currency": "BNFCR", "expansion\_down\_enabled": "false", "expansion\_down\_stop\_price": null, "grid\_lines": \[ { "id": 256427646, "price": "0.01957", "side": "buy", "order\_placed": false }, ... { "id": 256427674, "price": "0.021884", "side": "buy", "order\_placed": true } ] }, { "id": 2340692, "account\_id": 32864603, "account\_name": "My Gate.io", "is\_enabled": false, "grids\_quantity": "10", "created\_at": "2024-10-07T19:49:05.146Z", "updated\_at": "2024-10-07T19:49:05.266Z", "strategy\_type": "manual", "upper\_stop\_loss\_enabled": false, "lower\_stop\_loss\_enabled": false, "note": null, "editable": true, "lower\_price": "0.11016", "lower\_stop\_loss\_price": null, "lower\_stop\_loss\_action": "stop\_bot", "upper\_price": "0.15161", "upper\_stop\_loss\_price": null, "upper\_stop\_loss\_action": "stop\_bot", "quantity\_per\_grid": "32.0", "leverage\_type": "not\_specified", "leverage\_custom\_value": "10.0", "name": "DOGE\_USDT/USDT", "pair": "USDT\_DOGE\_USDT", "start\_price": null, "grid\_price\_step": "0.004605555555555555555555555555555555555555556", "current\_profit": "0.0", "current\_profit\_usd": "0.0", "total\_profits\_count": "0", "bought\_volume": "0.0", "sold\_volume": "0.0", "profit\_percentage": "0.0", "current\_price": "0.10658", "max\_active\_buy\_lines": "10", "max\_active\_sell\_lines": "10", "order\_currency\_type": "base", "profit\_currency\_type": "quote", "trailing\_up\_enabled": "false", "grid\_type": "arithmetic", "investment\_base\_currency": "0.0", "investment\_quote\_currency": "0.0", "unrealized\_profit\_loss": "0.0", "current\_profit\_loss": null, "current\_profit\_loss\_percent": null, "orderbook\_price\_currency": "USDT", "expansion\_down\_enabled": "false", "expansion\_down\_stop\_price": null, "grid\_lines": \[ { "id": 256564760, "price": "0.11016", "side": null, "order\_placed": false }, ... { "id": 256564761, "price": "0.11477", "side": "sell", "order\_placed": false } ] }, { "id": 2340683, "account\_id": 32864603, "account\_name": "My Gate.io", "is\_enabled": true, "grids\_quantity": "81", "created\_at": "2024-10-07T19:25:19.985Z", "updated\_at": "2024-10-08T06:09:06.596Z", "strategy\_type": "manual", "upper\_stop\_loss\_enabled": false, "lower\_stop\_loss\_enabled": false, "note": null, "editable": true, "lower\_price": "0.10709", "lower\_stop\_loss\_price": null, "lower\_stop\_loss\_action": "stop\_bot", "upper\_price": "0.14743", "upper\_stop\_loss\_price": null, "upper\_stop\_loss\_action": "stop\_bot", "quantity\_per\_grid": "1.525", "leverage\_type": "cross", "leverage\_custom\_value": "2.0", "name": "DOGE\_USDT/USDT", "pair": "USDT\_DOGE\_USDT", "start\_price": "0.11039", "grid\_price\_step": "1.00400404340336061876774988824634211028445743211701796", "current\_profit": "0.014301075", "current\_profit\_usd": "0.014301075", "total\_profits\_count": "6", "bought\_volume": "0.0", "sold\_volume": "0.0", "profit\_percentage": "0.0117628032189822567750298571790476629149161", "current\_price": "0.10658", "max\_active\_buy\_lines": "81", "max\_active\_sell\_lines": "81", "order\_currency\_type": "quote", "profit\_currency\_type": "quote", "trailing\_up\_enabled": "false", "grid\_type": "geometric", "investment\_base\_currency": "95.373316645187509287670722538", "investment\_quote\_currency": "0.0", "unrealized\_profit\_loss": "0.0", "current\_profit\_loss": null, "current\_profit\_loss\_percent": null, "orderbook\_price\_currency": "USDT", "expansion\_down\_enabled": "false", "expansion\_down\_stop\_price": null, "grid\_lines": \[ { "id": 256574543, "price": "0.1084", "side": "sell", "order\_placed": false }, ... { "id": 256563805, "price": "0.11283", "side": "sell", "order\_placed": true } ] } ]

</details>

<details>

<summary>Status: 500 Internal Server Error</summary>

\
{ "error": "unknown\_error", "error\_description": "Unknown error occurred#JSON::ParserError" }

</details>
