> For the complete documentation index, see [llms.txt](https://docs.sov.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sov.ai/api-reference/utils/stream.md).

# Stream

**Module:** `sovai.utils.stream`

## Functions

### `stream_data()`

```python
def stream_data(res: Response) -> pd.DataFrame
```

Get streaming data from server and convert to pd.DataFrame. Ensure 'ticker' column (if it exists) is at the front of the DataFrame.

**Parameters**

| Parameter | Type       | Description                    |
| --------- | ---------- | ------------------------------ |
| `res`     | `Response` | Response object from requests. |

**Returns**

pd.DataFrame: DataFrame with 'ticker' column at the front if it exists.

***

### `stream_data_pyarrow()`

```python
def stream_data_pyarrow(response: Response) -> pd.DataFrame
```

Read a Response object containing a serialized Arrow table and convert it to a Pandas DataFrame.

**Parameters**

| Parameter  | Type       | Description                                                                 |
| ---------- | ---------- | --------------------------------------------------------------------------- |
| `response` | `Response` | The response object from an HTTP request containing serialized Arrow table. |

**Returns**

pd.DataFrame: DataFrame representation of the Arrow table.

***