Search Attributes
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
SearchAttributes | SearchAttributesQueryParams | SearchAttributesData |
Import Statement
from openbb_core.provider.standard_models.search_attributes import (
SearchAttributesData,
SearchAttributesQueryParams,
)
Parameters
- Standard
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | Query to search for. | False | |
| limit | int | The number of data entries to return. | 1000 | True |
| provider | Literal['intrinio'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default. | "intrinio" | True |
Data
- Standard
| Name | Type | Description |
|---|---|---|
| id | str | ID of the financial attribute. |
| name | str | Name of the financial attribute. |
| tag | str | Tag of the financial attribute. |
| statement_code | str | Code of the financial statement. |
| statement_type | str | Type of the financial statement. |
| parent_name | str | Parent's name of the financial attribute. |
| sequence | int | Sequence of the financial statement. |
| factor | str | Unit of the financial attribute. |
| transaction | str | Transaction type (credit/debit) of the financial attribute. |
| type | str | Type of the financial attribute. |
| unit | str | Unit of the financial attribute. |