mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 05:21:48 +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>
74 lines
2.0 KiB
Markdown
Vendored
74 lines
2.0 KiB
Markdown
Vendored
---
|
|
title: Get aggressive small cap Equities
|
|
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 |
|
|
| ---------- | ---------------- | ---------- |
|
|
| `EquityAggressiveSmallCaps` | `EquityAggressiveSmallCapsQueryParams` | `EquityAggressiveSmallCapsData` |
|
|
|
|
### Import Statement
|
|
|
|
```python
|
|
from openbb_core.provider.standard_models. import (
|
|
EquityAggressiveSmallCapsData,
|
|
EquityAggressiveSmallCapsQueryParams,
|
|
)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| sort | str | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True |
|
|
| provider | Literal['yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'yfinance' if there is no default. | yfinance | True |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
## Data
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol representing the entity requested in the data. |
|
|
| name | str | Name of the entity. |
|
|
| price | float | Last price. |
|
|
| change | float | Change in price value. |
|
|
| percent_change | float | Percent change. |
|
|
| volume | float | The trading volume. |
|
|
</TabItem>
|
|
|
|
<TabItem value='yfinance' label='yfinance'>
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol representing the entity requested in the data. |
|
|
| name | str | Name of the entity. |
|
|
| price | float | Last price. |
|
|
| change | float | Change in price value. |
|
|
| percent_change | float | Percent change. |
|
|
| volume | float | The trading volume. |
|
|
| market_cap | str | Market Cap. |
|
|
| avg_volume_3_months | float | Average volume over the last 3 months in millions. |
|
|
| pe_ratio_ttm | float | PE Ratio (TTM). |
|
|
</TabItem>
|
|
|
|
</Tabs>
|