Gunbot

https://www.gunbot.com/support/docs
Admin
Gunbot is an advanced, easy-to-use crypto trading bot offering unique features like real-time...
Tokens:391,626
Snippets:3,025
Trust Score:9.7
Update:4 days ago
Show doc for...
Tokens:
Raw
### Start System JavaScript Request

Source: https://www.gunbot.com/support/docs/rest-api/api-system-status-license

Example of starting the system using the JavaScript fetch API.

```javascript
fetch('https://your-gunbot-instance.com:3001/api/v1/system/start', {  

  method: 'POST',  

  headers: {  

    'Authorization': 'Bearer YOUR_BEARER_TOKEN',  

    'Content-Type': 'application/json'  

  }  

})  

  .then(response => response.json())  

  .then(data => console.log(data))  

  .catch(error => console.error('Error:', error));
```

--------------------------------

### Start System cURL Request

Source: https://www.gunbot.com/support/docs/rest-api/api-system-status-license

Example of starting the system using the cURL command line tool.

```bash
curl -X POST "https://your-gunbot-instance.com:3001/api/v1/system/start" \

  -H "Content-Type: application/json" \

  -H "Authorization: Bearer YOUR_BEARER_TOKEN"
```

--------------------------------

### Start System Python Request

Source: https://www.gunbot.com/support/docs/rest-api/api-system-status-license

Example of starting the system using the Python requests library.

```python
import requests  

  

url = 'https://your-gunbot-instance.com:3001/api/v1/system/start'  

headers = {  

    'Authorization': 'Bearer YOUR_BEARER_TOKEN',  

    'Content-Type': 'application/json'  

}  

  

response = requests.post(url, headers=headers)  

print(response.json())
```

--------------------------------

### Get Daily Orders via Python Requests

Source: https://www.gunbot.com/support/docs/rest-api/api-trading-orders

Example of using the Python requests library to fetch daily orders.

```python
import requests  

  

url = 'https://your-gunbot-instance.com:3001/api/v1/orders/day'  

headers = {  

    'Authorization': 'Bearer YOUR_TOKEN'  

}  

params = [  

    ('timezone', 'America/New_York'),  

    ('keys[]', 'binance/USDT-XRP'),  

    ('keys[]', 'mex_gunthy/USDT-DOGE')  

]  

response = requests.get(url, headers=headers, params=params)  

print(response.json())
```

--------------------------------

### Get Server Time Response Example

Source: https://www.gunbot.com/support/docs/rest-api/onepage

Example JSON response from the GET /api/v1/time endpoint, containing the serverTime in milliseconds.

```json
{
  "serverTime": 1733307452501
}
```

--------------------------------

### POST /api/v1/system/start

Source: https://www.gunbot.com/support/docs/rest-api/onepage

Starts the system. This endpoint requires no request parameters and returns the current configuration without private keys.

```APIDOC
## POST /api/v1/system/start

### Description
Starts the system.

### Method
POST

### Endpoint
/api/v1/system/start

### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **Content-Type** (string) - Required - application/json

### Parameters
This endpoint does not require any request parameters.

### Request Example
No request body is required.

### Response
#### Success Response
Returns the current configuration without private keys.

#### Response Example
{
  // returns the current configuration without private keys
}
```

--------------------------------

### Install system dependencies

Source: https://www.gunbot.com/support/docs/setup-installation/armv7l-installation

Install required libraries and build tools to resolve startup errors.

```bash
sudo apt-get update  

sudo apt-get install crossbuild-essential-armhf  

sudo apt-get install libatomic1  

sudo apt-get install libatomic1-armhf  
```

--------------------------------

### POST /api/v1/system/start

Source: https://www.gunbot.com/support/docs/rest-api/api-system-status-license

Starts the system and returns the current configuration (excluding private keys). This endpoint requires authentication via a bearer token and does not require any request parameters.

```APIDOC
## POST /api/v1/system/start

### Description
Starts the system and returns the current configuration (excluding private keys).

### Method
POST

### Endpoint
/api/v1/system/start

### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **Content-Type** (string) - Required - application/json

### Parameters
This endpoint does not require any request parameters.

### Request Example
No request body is required.

### Response
#### Success Response
Returns the current configuration without private keys.

#### Response Example
{
  // returns the current configuration without private keys
}

```

--------------------------------

### Get AutoConfig Variable File Response

Source: https://www.gunbot.com/support/docs/rest-api/api-config-files

Example JSON response received after a successful request to the get AutoConfig variable file endpoint.

```json
{

  "this": 0.1855499735435755,

  "pnd": false

}
```

--------------------------------

### Get Server Time with Python requests library

Source: https://www.gunbot.com/support/docs/rest-api/onepage

Use this Python requests example to call the GET /api/v1/time endpoint. It requires a Bearer token in the Authorization header. The response is printed as JSON.

```python
import requests

url = 'https://your-gunbot-instance.com:3001/api/v1/time'
headers = {
    'Authorization': 'Bearer YOUR_BEARER_TOKEN'
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Start System with Python requests library

Source: https://www.gunbot.com/support/docs/rest-api/onepage

Sends a POST request to start the system using the requests library. Prints the JSON response.

```python
import requests

url = 'https://your-gunbot-instance.com:3001/api/v1/system/start'
headers = {
    'Authorization': 'Bearer YOUR_BEARER_TOKEN',
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())
```

--------------------------------

### Get Server Time with JavaScript fetch API

Source: https://www.gunbot.com/support/docs/rest-api/onepage

Use this JavaScript fetch API example to call the GET /api/v1/time endpoint. It requires a Bearer token in the Authorization header. The response is logged to the console.

```javascript
fetch('https://your-gunbot-instance.com:3001/api/v1/time', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_BEARER_TOKEN'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

--------------------------------

### Get Backup File Response

Source: https://www.gunbot.com/support/docs/rest-api/api-config-files

Example JSON response containing the content of the requested backup file.

```json
{
  "manageOverrides_binance": {
    "pairs": {
      "exclude": "UP,DOWN,1L,2L,3L,1S,2S,3S",
      "include": "USDT-",
      "exchange": "binances",
      "maxPairs": 6
    },
    "filters": {},
    "overrides": {},
    // Truncated for brevity
  }
}
```

--------------------------------

### Start System with cURL

Source: https://www.gunbot.com/support/docs/rest-api/onepage

Sends a POST request to start the system. Requires a Bearer token in the Authorization header.

```bash
curl -X POST "https://your-gunbot-instance.com:3001/api/v1/system/start" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN"
```

--------------------------------

### Get Chart Data via cURL

Source: https://www.gunbot.com/support/docs/rest-api/onepage

Example of how to retrieve chart data using the cURL command-line tool.

```bash
curl -X POST "https://your-gunbot-instance.com:3001/api/v1/chart/data" \

  -H "Content-Type: application/json" \

  -H "Authorization: Bearer YOUR_TOKEN" \

  -d '{

  "exchange": "binance",

  "pair": "USDT-XRP"

}'
```

--------------------------------

### Install NodeJS and NPM

Source: https://www.gunbot.com/support/docs/setup-installation/linux-installation

Install the NodeSource repository and the required NodeJS and NPM packages.

```bash
sudo apt-get install -y ca-certificates curl gnupg  

sudo mkdir -p /etc/apt/keyrings  

curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg  

echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_18.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list  

sudo apt-get install nodejs -y  

apt-get install npm  
```

--------------------------------

### Get Paginated Orders via cURL

Source: https://www.gunbot.com/support/docs/rest-api/api-trading-orders

Example of using cURL to request paginated orders with URL-encoded parameters.

```bash
curl -G https://your-gunbot-instance.com:3001/api/v1/orders/page/multi \

-H "Authorization: Bearer YOUR_TOKEN" \

--data-urlencode "page=0" \

--data-urlencode "pageSize=10" \

--data-urlencode "keys[]=binance/USDT-XRP" \

--data-urlencode "keys[]=mex_gunthy/USDT-DOGE"
```

--------------------------------

### Set Permissions and Start Gunbot

Source: https://www.gunbot.com/support/docs/setup-installation/linux-installation

Navigate to the Gunbot directory, grant execution permissions to the binary, and launch the application.

```bash
cd /home/Gunbot  

chmod +x gunthy-linux  
```

```bash
./gunthy-linux  
```

--------------------------------

### Start System Response Format

Source: https://www.gunbot.com/support/docs/rest-api/api-system-status-license

The expected JSON response structure when starting the system.

```json
{

  // returns the current configuration without private keys

}
```
Tokens:
Raw