Skip to content
New: Star-import, signal unraveling, Python 3.12 support, and more

#
price_records module

Base class for working with records that can make use of OHLC data.

## price_records_shortcut_config ReadonlyConfig

Config of shortcut properties to be attached to PriceRecords.

    ReadonlyConfig(
        bar_open_time=dict(
            obj_type='mapped'
        ),
        bar_close_time=dict(
            obj_type='mapped'
        ),
        bar_open=dict(
            obj_type='mapped'
        ),
        bar_high=dict(
            obj_type='mapped'
        ),
        bar_low=dict(
            obj_type='mapped'
        ),
        bar_close=dict(
            obj_type='mapped'
        )
    )

## PriceRecords class

    PriceRecords(
        wrapper,
        records_arr,
        open=None,
        high=None,
        low=None,
        close=None,
        **kwargs
    )

Extends Records for records that can make use of OHLC data.

Superclasses

- Analyzable
- AttrResolverMixin
- Cacheable
- Chainable
- Comparable
- Configured
- ExtPandasIndexer
- HasSettings
- IndexingBase
- PandasIndexer
- Pickleable
- PlotsBuilderMixin
- Prettified
- Records
- RecordsWithFields
- StatsBuilderMixin
- Wrapping

Inherited members

- AttrResolverMixin.deep_getattr()
- AttrResolverMixin.post_resolve_attr()
- AttrResolverMixin.pre_resolve_attr()
- AttrResolverMixin.resolve_attr()
- AttrResolverMixin.resolve_shortcut_attr()
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- IndexingBase.indexing_setter_func()
- PandasIndexer.xs()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
- PlotsBuilderMixin.build_subplots_doc()
- PlotsBuilderMixin.override_subplots_doc()
- PlotsBuilderMixin.plots()
- Records.apply()
- Records.apply_mask()
- Records.build_field_config_doc()
- Records.cls_dir
- Records.col_arr
- Records.col_mapper
- Records.column_only_select
- Records.column_stack()
- Records.column_stack_records_arrs()
- Records.config
- Records.count()
- Records.coverage_map()
- Records.field_names
- Records.first_n()
- Records.get_apply_mapping_arr()
- Records.get_apply_mapping_str_arr()
- Records.get_column_stack_record_indices()
- Records.get_field_arr()
- Records.get_field_mapping()
- Records.get_field_name()
- Records.get_field_setting()
- Records.get_field_title()
- Records.get_map_field()
- Records.get_map_field_to_columns()
- Records.get_map_field_to_index()
- Records.get_pd_mask()
- Records.get_row_stack_record_indices()
- Records.group_select
- Records.has_conflicts()
- Records.id_arr
- Records.idx_arr
- Records.iloc
- Records.indexing_kwargs
- Records.is_sorted()
- Records.last_n()
- Records.loc
- Records.map()
- Records.map_array()
- Records.map_field()
- Records.override_field_config_doc()
- Records.pd_mask
- Records.plots_defaults
- Records.prepare_customdata()
- Records.random_n()
- Records.range_only_select
- Records.rec_state
- Records.records
- Records.records_arr
- Records.records_readable
- Records.replace()
- Records.resample_meta()
- Records.resample_records_arr()
- Records.row_stack()
- Records.row_stack_records_arrs()
- Records.select_cols()
- Records.self_aliases
- Records.sort()
- Records.stats_defaults
- Records.to_readable()
- Records.values
- Records.wrapper
- Records.xloc
- RecordsWithFields.field_config
- StatsBuilderMixin.build_metrics_doc()
- StatsBuilderMixin.override_metrics_doc()
- StatsBuilderMixin.stats()
- Wrapping.regroup()
- Wrapping.resolve_self()
- Wrapping.resolve_stack_kwargs()
- Wrapping.select_col()
- Wrapping.select_col_from_obj()
- Wrapping.split()

Subclasses

- Logs
- Orders
- Ranges

### bar_close property

PriceRecords.get_bar_close() with default arguments.

### bar_close_time property

PriceRecords.get_bar_close_time() with default arguments.

### bar_high property

PriceRecords.get_bar_high() with default arguments.

### bar_low property

PriceRecords.get_bar_low() with default arguments.

### bar_open property

PriceRecords.get_bar_open() with default arguments.

### bar_open_time property

PriceRecords.get_bar_open_time() with default arguments.

### close property

Close price.

### from_records class method

    PriceRecords.from_records(
        wrapper,
        records,
        data=None,
        open=None,
        high=None,
        low=None,
        close=None,
        attach_data=True,
        **kwargs
    )

Build PriceRecords from records.

### get_bar_close method

    PriceRecords.get_bar_close(
        **kwargs
    )

Get a mapped array with the closing price of the bar.

### get_bar_close_time method

    PriceRecords.get_bar_close_time(
        **kwargs
    )

Get a mapped array with the closing time of the bar.

### get_bar_high method

    PriceRecords.get_bar_high(
        **kwargs
    )

Get a mapped array with the high price of the bar.

### get_bar_low method

    PriceRecords.get_bar_low(
        **kwargs
    )

Get a mapped array with the low price of the bar.

### get_bar_open method

    PriceRecords.get_bar_open(
        **kwargs
    )

Get a mapped array with the opening price of the bar.

### get_bar_open_time method

    PriceRecords.get_bar_open_time(
        **kwargs
    )

Get a mapped array with the opening time of the bar.

### high property

High price.

### indexing_func method

    PriceRecords.indexing_func(
        *args,
        price_records_meta=None,
        **kwargs
    )

Perform indexing on PriceRecords.

### indexing_func_meta method

    PriceRecords.indexing_func_meta(
        *args,
        records_meta=None,
        **kwargs
    )

Perform indexing on PriceRecords and return metadata.

### low property

Low price.

### open property

Open price.

### resample method

    PriceRecords.resample(
        *args,
        ffill_close=False,
        fbfill_close=False,
        records_meta=None,
        **kwargs
    )

Perform resampling on PriceRecords.

### resolve_column_stack_kwargs class method

    PriceRecords.resolve_column_stack_kwargs(
        *objs,
        reindex_kwargs=None,
        ffill_close=False,
        fbfill_close=False,
        **kwargs
    )

Resolve keyword arguments for initializing PriceRecords after stacking along columns.

### resolve_row_stack_kwargs class method

    PriceRecords.resolve_row_stack_kwargs(
        *objs,
        **kwargs
    )

Resolve keyword arguments for initializing PriceRecords after stacking along columns.

#### Cookie consent

We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.

- Google Analytics
- GitHub

Manage settings