diff options
Diffstat (limited to 'website/content/platform/data_models/EquitySearch.md')
| -rw-r--r-- | website/content/platform/data_models/EquitySearch.md | 193 |
1 files changed, 0 insertions, 193 deletions
diff --git a/website/content/platform/data_models/EquitySearch.md b/website/content/platform/data_models/EquitySearch.md deleted file mode 100644 index 0c9a4115132..00000000000 --- a/website/content/platform/data_models/EquitySearch.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -title: "Equity Search" -description: "Search for stock symbol, CIK, LEI, or company name" ---- - -<!-- 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 | -| ---------- | ---------------- | ---------- | -| `EquitySearch` | `EquitySearchQueryParams` | `EquitySearchData` | - -### Import Statement - -```python -from openbb_core.provider.standard_models.equity_search import ( -EquitySearchData, -EquitySearchQueryParams, -) -``` - ---- - -## Parameters - -<Tabs> - -<TabItem value='standard' label='standard'> - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True | -</TabItem> - -<TabItem value='cboe' label='cboe'> - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True | -</TabItem> - -<TabItem value='intrinio' label='intrinio'> - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True | -| active | bool | When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. | True | True | -| limit | int | The number of data entries to return. | 10000 | True | -</TabItem> - -<TabItem value='nasdaq' label='nasdaq'> - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True | -| is_etf | bool | If True, returns ETFs. | None | True | -</TabItem> - -<TabItem value='sec' label='sec'> - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True | -| is_fund | bool | Whether to direct the search to the list of mutual funds and ETFs. | False | True | -</TabItem> - -<TabItem value='tmx' label='tmx'> - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | True | -</TabItem> - -<TabItem value='tradier' label='tradier'> - -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| query | str | Search query. | | True | -| is_symbol | bool | Whether to search by ticker symbol. | False | True | -| use_cache | bool | Whether to use the cache or not. | True | True | -| provider | Literal['cboe', 'intrinio', 'nasdaq', 'sec', 'tmx', 'tradier'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default. | cboe | 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 company. | -</TabItem> - -<TabItem value='cboe' label='cboe'> - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| dpm_name | str | Name of the primary market maker. | -| post_station | str | Post and station location on the CBOE trading floor. | -</TabItem> - -<TabItem value='intrinio' label='intrinio'> - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| cik | str | | -| lei | str | The Legal Entity Identifier (LEI) of the company. | -| intrinio_id | str | The Intrinio ID of the company. | -</TabItem> - -<TabItem value='nasdaq' label='nasdaq'> - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| nasdaq_traded | str | Is Nasdaq traded? | -| exchange | str | Primary Exchange | -| market_category | str | Market Category | -| etf | str | Is ETF? | -| round_lot_size | float | Round Lot Size | -| test_issue | str | Is test Issue? | -| financial_status | str | Financial Status | -| cqs_symbol | str | CQS Symbol | -| nasdaq_symbol | str | NASDAQ Symbol | -| next_shares | str | Is NextShares? | -</TabItem> - -<TabItem value='sec' label='sec'> - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| cik | str | Central Index Key | -</TabItem> - -<TabItem value='tmx' label='tmx'> - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -</TabItem> - -<TabItem value='tradier' label='tradier'> - -| Name | Type | Description | -| ---- | ---- | ----------- | -| symbol | str | Symbol representing the entity requested in the data. | -| name | str | Name of the company. | -| exchange | str | Exchange where the security is listed. | -| security_type | Literal['stock', 'option', 'etf', 'index', 'mutual_fund'] | Type of security. | -</TabItem> - -</Tabs> - |