# Settings

Retrieve all settings that have been set on the liveX, including internal inverter parameters.

URL: **`http://LIVEX_IP_ADDRESS/api.php?get=settings`**

Method: **`GET`**

Response Format: **`JSON`**

## Response Example

```javascript
{"BxOutPin":{"2":{"varname":"BxOutPin","entity":2,"name":"","inuse":1,"mode":0,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"","s2":"","updatetime":"2021-01-13 09:03:51"},"3":{"varname":"BxOutPin","entity":3,"name":"","inuse":1,"mode":0,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"","s2":"","updatetime":"2021-01-13 09:03:51"}},"GridInjection":{"0":{"varname":"GridInjection","entity":0,"name":"","inuse":1,"mode":0,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"","s2":"","updatetime":"2021-01-13 09:03:51"}},"BatteryCharging":{"0":{"varname":"BatteryCharging","entity":0,"name":"","inuse":1,"mode":0,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"","s2":"","updatetime":"2021-01-13 09:03:51"}},"BatteryDischarging":{"0":{"varname":"BatteryDischarging","entity":0,"name":"","inuse":1,"mode":0,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"","s2":"","updatetime":"2021-01-13 09:03:51"}},"IgnoreWarnings":{"0":{"varname":"IgnoreWarnings","entity":0,"name":"","inuse":1,"mode":0,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"","s2":"","updatetime":"2021-01-13 09:03:51"}},"BatteryMinSoC":{"0":{"varname":"BatteryMinSoC","entity":0,"name":"","inuse":1,"mode":1,"v1":15,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"","s2":"","updatetime":"2021-01-13 09:03:51"}},"SystemMode":{"0":{"varname":"SystemMode","entity":0,"name":"","inuse":1,"mode":0,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"","s2":"","updatetime":"2021-01-14 12:25:21"}},"Version":{"0":{"varname":"Version","entity":0,"name":"Version","inuse":1,"mode":0,"v1":20,"v2":12,"v3":1,"v4":0,"v5":0,"v6":0,"s1":"","s2":"","updatetime":"2021-01-15 13:17:08"}},"InjectionMode":{"0":{"varname":"InjectionMode","entity":0,"name":"","inuse":1,"mode":2,"v1":3500,"v2":0,"v3":0,"v4":0,"v5":0,"v6":2,"s1":"","s2":"","updatetime":"2021-01-15 13:45:17"}},"InverterParameters":{"0":{"varname":"InverterParameters","entity":0,"name":"Inverter DateTime","inuse":1,"mode":1,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"20210115145300","s2":"","updatetime":"2021-01-15 13:53:07"},"1":{"varname":"InverterParameters","entity":1,"name":"Flag Status","inuse":1,"mode":1,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"1,0,1,1,1,1,0,1,1,1,1,1,1,0","s2":"","updatetime":"2021-01-15 13:53:07"},"2":{"varname":"InverterParameters","entity":2,"name":"Energy Distribution","inuse":1,"mode":1,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"1,1,1,0,0,0,0,0","s2":"","updatetime":"2021-01-15 13:53:07"},"10":{"varname":"InverterParameters","entity":10,"name":"Min. Grid-connected Voltage","inuse":1,"mode":1,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"18400","s2":"","updatetime":"2021-01-15 13:53:07"},"11":{"varname":"InverterParameters","entity":11,"name":"Max. Grid-connected Voltage","inuse":1,"mode":1,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"28750","s2":"","updatetime":"2021-01-15 13:53:07"},"20":{"varname":"InverterParameters","entity":20,"name":"Min. PV Input Voltage","inuse":1,"mode":1,"v1":0,"v2":0,"v3":0,"v4":0,"v5":0,"v6":0,"s1":"32500","s2":"","updatetime":"2021-01-15 13:53:07"}}}
```

## Response Parameters

```
{
    "VAR_NAME": {
        "ENTITY": {
            "varname": "VAR_NAME",
            "entity": ENTITY,
            "name": "NAME",
            "inuse": IN_USE,
            "mode": MODE,
            "v1": VALUE_1,
            "v2": VALUE_2,
            "v3": VALUE_3,
            "v4": VALUE_4,
            "v5": VALUE_5,
            "v6": VALUE_6,
            "s1": "STRING_1",
            "s2": "STRING_2",
            "updatetime": "UPDATE_TIME"
        },
        ...
    },
    ...
}
```

**`varname`**, **`entity`** - (`String`, `Integer`) Identifiers for the type of setting

**`name`** - (`String`) User-defined label for the setting

**`inuse`**, **`mode`**, **`v1`**, **`v2`**, **`v3`**, **`v4`**, **`v5`**, **`v6`** - (`Integers`) Documented in our ID Protocol

**`s1`**, **`s2`** - (`Strings`) Documented in our ID Protocol

**`updatetime`** - (`String`) Timestamp when then setting was last updated

## Examples

#### **`JavaScript Example (jQuery)`**

```javascript
$.get({
    url: "http://LIVEX_IP_ADDRESS/api.php?get=settings",
    success: function(response) {
        console.log(response);
    }
});
```

#### **`PHP Example`**

```php
$response = file_get_contents("http://LIVEX_IP_ADDRESS/api.php?get=settings");
$jsonObject = json_decode($response, true);
var_dump($jsonObject);
```

#### **`Python Example (requests)`**

```python
import requests
response = requests.get("http://LIVEX_IP_ADDRESS/api.php?get=settings")
jsonObject = response.json()
print(jsonObject)
```