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>
85 lines
2.8 KiB
Markdown
Vendored
85 lines
2.8 KiB
Markdown
Vendored
---
|
|
title: Index Search
|
|
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 |
|
|
| ---------- | ---------------- | ---------- |
|
|
| `IndexSearch` | `IndexSearchQueryParams` | `IndexSearchData` |
|
|
|
|
### Import Statement
|
|
|
|
```python
|
|
from openbb_core.provider.standard_models.index_search import (
|
|
IndexSearchData,
|
|
IndexSearchQueryParams,
|
|
)
|
|
```
|
|
|
|
## 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 |
|
|
| provider | Literal['cboe'] | 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 |
|
|
| provider | Literal['cboe'] | 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 |
|
|
| europe | bool | Filter for European indices. False for US indices. | False | 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 index. |
|
|
</TabItem>
|
|
|
|
<TabItem value='cboe' label='cboe'>
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol representing the entity requested in the data. |
|
|
| name | str | Name of the index. |
|
|
| isin | str | ISIN code for the index. Valid only for European indices. |
|
|
| region | str | Region for the index. Valid only for European indices |
|
|
| description | str | Description for the index. |
|
|
| data_delay | int | Data delay for the index. Valid only for US indices. |
|
|
| currency | str | Currency for the index. |
|
|
| time_zone | str | Time zone for the index. Valid only for US indices. |
|
|
| open_time | datetime.time | Opening time for the index. Valid only for US indices. |
|
|
| close_time | datetime.time | Closing time for the index. Valid only for US indices. |
|
|
| tick_days | str | The trading days for the index. Valid only for US indices. |
|
|
| tick_frequency | str | Tick frequency for the index. Valid only for US indices. |
|
|
| tick_period | str | Tick period for the index. Valid only for US indices. |
|
|
</TabItem>
|
|
|
|
</Tabs>
|