mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
dce447b423
* install v4
* add run on pr
* this seems sus
* thnx juan
* flip
* thnx juan
* idk
* Update index.js
* Update Root.tsx
* Update index.js
* try again
* fix front matter
* fix description front matter
* Revert "fix description front matter"
This reverts commit cccc7b2469.
* try to fix this mickey
* fixed all that mickey @DidierRLopes broke
* Update index.js
* generate platform fix
* black fix
---------
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: tehcoderer <me@tehcoderer.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
1.9 KiB
Vendored
1.9 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| symbol_map | Retrieve the ticker symbol corresponding to a company CIK using the OBB API endpoint. This function allows you to perform a search query and get the results along with additional metadata, warnings, and optional chart data. |
|
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Get the ticker symbol corresponding to a company's CIK. Enter the CIK as a string, e.g. '0001067983'. This function is not intended for funds.
obb.regulators.sec.symbol_map(query: str, provider: Literal[str] = sec)
Parameters
| 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 |
Returns
OBBject
results : List[SymbolMap]
Serializable results.
provider : Optional[Literal['sec']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
metadata: Optional[Metadata]
Metadata info about the command execution.
Data
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |