Files
aiomql/docs/ticks.md
T

98 lines
3.1 KiB
Markdown
Raw Normal View History

2023-10-16 15:36:31 +01:00
## <a id="ticks"></a> ticks
2023-10-11 09:49:06 +01:00
Module for working with price ticks.
```python
class Tick()
```
Price Tick of a Financial Instrument.
2023-10-16 15:36:31 +01:00
### Attributes:
|Name|Type|Description|Default|
|---|---|---|---|
|**symbol**|**Symbol**|The Financial Instrument as a Symbol Object|None|
|**time**|**datetime**|Time of the last prices update for the symbol|None|
|**bid**|**float**|Current Bid price|None|
|**ask**|**float**|Current Ask price|None|
|**last**|**float**|Price of the last deal (Last)|None|
|**volume**|**float**|Volume for the current Last price|None|
|**time_msc**|**int**|Time of the last prices update for the symbol in milliseconds|None|
|**flags**|**TickFlag**|Tick flags|None|
|**volume_real**|**float**|Volume for the current Last price|None|
|**Index**|**int**|Custom attribute representing the position of the tick in a sequence.|None|
2023-10-11 09:49:06 +01:00
2023-10-16 15:36:31 +01:00
### set\_attributes
2023-10-11 09:49:06 +01:00
```python
def set_attributes(**kwargs)
```
Set attributes from keyword arguments
2023-10-16 15:36:31 +01:00
## Ticks
2023-10-11 09:49:06 +01:00
```python
class Ticks()
```
Container data class for price ticks. Arrange in chronological order.
Supports iteration, slicing and assignment
2023-10-16 15:36:31 +01:00
### Attributes:
|Name|Type|Description|Default|
|---|---|---|---|
|**data**|**DataFrame**|DataFrame of price ticks arranged in chronological order.|None|
2023-10-11 09:49:06 +01:00
2023-10-16 15:36:31 +01:00
### \_\_init\_\_
2023-10-11 09:49:06 +01:00
```python
def __init__(*, data: DataFrame | Iterable, flip=False)
```
Initialize the Ticks class. Creates a DataFrame of price ticks from the data argument.
2023-10-16 15:36:31 +01:00
#### Arguments:
|Name| Type | Description | Default |
|---|--------------------|-----------------------------|-------------------|
|**data**| **DataFrame** \| **Iterable** | Dataframe of price ticks or any iterable object that can be converted to a pandas DataFrame | None |
|**flip**| **bool** | If flip is True reverse data chronological order. | False |
2023-10-11 09:49:06 +01:00
2023-10-16 15:36:31 +01:00
### ta
2023-10-11 09:49:06 +01:00
```python
@property
def ta()
```
Access to the pandas_ta library for performing technical analysis on the underlying data attribute.
2023-10-16 15:36:31 +01:00
#### Returns:
|Name|Type|Description|
|---|---|---|
|**pandas_ta**|**pandas_ta**|The pandas_ta library|
2023-10-11 09:49:06 +01:00
2023-10-16 15:36:31 +01:00
### ta\_lib
2023-10-11 09:49:06 +01:00
```python
@property
def ta_lib()
```
Access to the ta library for performing technical analysis. Not dependent on the underlying data attribute.
2023-10-16 15:36:31 +01:00
#### Returns:
|Name|Type|Description|
|---|---|---|
|**ta**|**ta**|The ta library|
2023-10-11 09:49:06 +01:00
2023-10-16 15:36:31 +01:00
### data
2023-10-11 09:49:06 +01:00
```python
@property
def data() -> DataFrame
```
DataFrame of price ticks arranged in chronological order.
2023-10-16 15:36:31 +01:00
#### Returns:
|Name|Type|Description|
|---|---|---|
|**data**|**DataFrame**|DataFrame of price ticks arranged in chronological order.|
2023-10-11 09:49:06 +01:00
2023-10-16 15:36:31 +01:00
### rename
2023-10-11 09:49:06 +01:00
```python
def rename(inplace=True, **kwargs) -> _Ticks | None
```
Rename columns of the candle class.
2023-10-16 15:36:31 +01:00
#### Arguments:
|Name| Type | Description | Default |
|---|--------------------|-----------------------------|-------------------|
|**inplace**| **bool** | Rename the columns inplace or return a new instance of the class with the renamed columns | True |
|**kwargs**| | The new names of the columns | |
#### Returns:
|Type|Description|
|---|---|
|**Ticks**|A new instance of the class with the renamed columns if inplace is False.|
|**None**|If inplace is True|