Symbol Map
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
SymbolMap | SymbolMapQueryParams | SymbolMapData |
Import Statement
from openbb_core.provider.standard_models. import (
SymbolMapData,
SymbolMapQueryParams,
)
Parameters
- standard
- sec
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | False | |
| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True |
| provider | Literal['sec'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: s, e, c. | None | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | False | |
| use_cache | bool | Whether or not to use cache. If True, cache will store for seven days. | True | True |
| provider | Literal['sec'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: s, e, c. | None | True |
Data
- standard
- sec
| Name | Type | Description |
|---|
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |