> ## Documentation Index
> Fetch the complete documentation index at: https://systematica.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Base

> systematica.data.base

## `DefaultBinanceSymbols`

```python theme={null}
DefaultBinanceSymbols(
    *args,
    **kwds,
)
```

Default symbols for Binance exchange.

### Ancestors

* `enum.Enum`

### Class variables

* `BTCUSDT`: Bitcoin to USDT trading pair.

* `ETHUSDT`: Ethereum to USDT trading pair.

### Static methods

#### `get_fields`

```python theme={null}
get_fields()
```

Get list of symbol names.

**Returns**:

| Type          | Description                        |
| ------------- | ---------------------------------- |
| `list of str` | List of symbol names in uppercase. |

#### `from_name`

```python theme={null}
from_name(
    name: str,
) ‑> int
```

Convert symbol name to its column index.

**Parameters**:

| Name   | Type  | Default | Description                                 |
| ------ | ----- | ------- | ------------------------------------------- |
| `name` | `str` | `--`    | Symbol name in uppercase (e.g., 'BTCUSDT'). |

**Returns**:

| Type  | Description                                    |
| ----- | ---------------------------------------------- |
| `int` | Column index corresponding to the symbol name. |

#### `is_valid`

```python theme={null}
is_valid(
    name: str,
) ‑> bool
```

Check if a symbol name is valid.

**Parameters**:

| Name   | Type  | Default | Description                                 |
| ------ | ----- | ------- | ------------------------------------------- |
| `name` | `str` | `--`    | Symbol name in uppercase (e.g., 'BTCUSDT'). |

**Returns**:

| Type   | Description                                        |
| ------ | -------------------------------------------------- |
| `bool` | True if the symbol name is valid, False otherwise. |

## `DefaultCoinbaseSymbols`

```python theme={null}
DefaultCoinbaseSymbols(
    *args,
    **kwds,
)
```

Default symbols for Coinbase exchange.

### Ancestors

* `enum.Enum`

### Class variables

* `BTC_USD`: Bitcoin to USD trading pair.

* `ETH_USD`: Ethereum to USD trading pair.

### Static methods

#### `get_fields`

```python theme={null}
get_fields()
```

Get list of formatted symbol names (with slashes).

**Returns**:

| Type          | Description                                                    |
| ------------- | -------------------------------------------------------------- |
| `list of str` | List of symbol names formatted with slashes (e.g., 'BTC/USD'). |

#### `from_name`

```python theme={null}
from_name(
    name: str,
) ‑> int
```

Convert symbol name (with slashes) to its column index.

**Parameters**:

| Name   | Type  | Default | Description                                           |
| ------ | ----- | ------- | ----------------------------------------------------- |
| `name` | `str` | `--`    | Symbol name formatted with slashes (e.g., 'BTC/USD'). |

**Returns**:

| Type  | Description                                    |
| ----- | ---------------------------------------------- |
| `int` | Column index corresponding to the symbol name. |

#### `is_valid`

```python theme={null}
is_valid(
    name: str,
) ‑> bool
```

Check if a symbol name (with slashes) is valid.

**Parameters**:

| Name   | Type  | Default | Description                                           |
| ------ | ----- | ------- | ----------------------------------------------------- |
| `name` | `str` | `--`    | Symbol name formatted with slashes (e.g., 'BTC/USD'). |

**Returns**:

| Type   | Description                                        |
| ------ | -------------------------------------------------- |
| `bool` | True if the symbol name is valid, False otherwise. |

#### `get_symbol`

```python theme={null}
get_symbol(
    index: int,
) ‑> str
```

Get formatted symbol name (with slashes) from index.

**Parameters**:

| Name    | Type  | Default | Description                 |
| ------- | ----- | ------- | --------------------------- |
| `index` | `int` | `--`    | Column index of the symbol. |

**Raises**:

| Type         | Description              |
| ------------ | ------------------------ |
| `ValueError` | If the index is invalid. |

**Returns**:

| Type  | Description                                           |
| ----- | ----------------------------------------------------- |
| `str` | Symbol name formatted with slashes (e.g., 'BTC/USD'). |