# 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.

***


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sov.ai/api-reference/utils/stream.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
