mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-01 06:51:38 +00:00
4400cd9a8f
* small changes - moving provider inside the core * uptade readme * lint * remove old provider readme * leftovers * refactor website examples * ruff * fix nox * relock * fix fails_to_deliver headers * fix for tests that have renamed endpoints * fix discovery * removed test for renamed endpoint * fix broken syntax - test_search_financial_attributes * fix cash/income/balance * fix derivatives tests * fix etf tests * fix news tests * fix regulators * black * wrong test param * sort equity gainers/losers by percent * platform markdown generation import * Hotfix/fix int tests core merge (#5779) * removing tests on old endpoint * removing visualization on old endpoint * fixing equity tests * fixing examples * fix news tests * fix index test * example * add comments * example --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
89 lines
2.8 KiB
Markdown
Vendored
89 lines
2.8 KiB
Markdown
Vendored
---
|
|
title: Company Overview
|
|
description: OpenBB Platform Data Model
|
|
---
|
|
|
|
<!-- markdownlint-disable MD012 MD031 MD033 -->
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
---
|
|
|
|
## Implementation details
|
|
|
|
### Class names
|
|
|
|
| Model name | Parameters class | Data class |
|
|
| ---------- | ---------------- | ---------- |
|
|
| `CompanyOverview` | `CompanyOverviewQueryParams` | `CompanyOverviewData` |
|
|
|
|
### Import Statement
|
|
|
|
```python
|
|
from openbb_core.provider.standard_models.company_overview import (
|
|
CompanyOverviewData,
|
|
CompanyOverviewQueryParams,
|
|
)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | Union[str, List[str]] | Symbol to get data for. | | False |
|
|
| provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
## Data
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol representing the entity requested in the data. |
|
|
| price | float | Price of the company. |
|
|
| beta | float | Beta of the company. |
|
|
| vol_avg | int | Volume average of the company. |
|
|
| mkt_cap | int | Market capitalization of the company. |
|
|
| last_div | float | Last dividend of the company. |
|
|
| range | str | Range of the company. |
|
|
| changes | float | Changes of the company. |
|
|
| company_name | str | Company name of the company. |
|
|
| currency | str | Currency of the company. |
|
|
| cik | str | CIK of the company. |
|
|
| isin | str | ISIN of the company. |
|
|
| cusip | str | CUSIP of the company. |
|
|
| exchange | str | Exchange of the company. |
|
|
| exchange_short_name | str | Exchange short name of the company. |
|
|
| industry | str | Industry of the company. |
|
|
| website | str | Website of the company. |
|
|
| description | str | Description of the company. |
|
|
| ceo | str | CEO of the company. |
|
|
| sector | str | Sector of the company. |
|
|
| country | str | Country of the company. |
|
|
| full_time_employees | str | Full time employees of the company. |
|
|
| phone | str | Phone of the company. |
|
|
| address | str | Address of the company. |
|
|
| city | str | City of the company. |
|
|
| state | str | State of the company. |
|
|
| zip | str | Zip of the company. |
|
|
| dcf_diff | float | Discounted cash flow difference of the company. |
|
|
| dcf | float | Discounted cash flow of the company. |
|
|
| image | str | Image of the company. |
|
|
| ipo_date | date | IPO date of the company. |
|
|
| default_image | bool | If the image is the default image. |
|
|
| is_etf | bool | If the company is an ETF. |
|
|
| is_actively_trading | bool | If the company is actively trading. |
|
|
| is_adr | bool | If the company is an ADR. |
|
|
| is_fund | bool | If the company is a fund. |
|
|
</TabItem>
|
|
|
|
</Tabs>
|