Skip to main content

Search Attributes


Implementation details

Class names

Model nameParameters classData class
SearchAttributesSearchAttributesQueryParamsSearchAttributesData

Import Statement

from openbb_core.provider.standard_models.search_attributes import (
SearchAttributesData,
SearchAttributesQueryParams,
)

Parameters

query: str

Query to search for.

Optional: False


limit: int

The number of data entries to return.

Default: 1000

Optional: True

Data

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.