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
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Search query. | True | |
| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | "sec" | True |
Data
- Standard
- sec
| Name | Type | Description |
|---|
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |