Files
OpenBB/website/content/platform/data_models/ETFActive.md
Henrique Joaquim 4400cd9a8f Merge provider and core into core (#5774)
* 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>
2023-11-22 13:48:01 +00:00

2.2 KiB
Vendored

title, description
title description
Get the most active ETFs OpenBB Platform Data Model

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';


Implementation details

Class names

Model name Parameters class Data class
ETFActive ETFActiveQueryParams ETFActiveData

Import Statement

from openbb_core.provider.standard_models. import (
ETFActiveData,
ETFActiveQueryParams,
)

Parameters

Name Type Description Default Optional
sort str Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. desc True
limit int The number of data entries to return. 10 True
provider Literal['wsj'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'wsj' if there is no default. wsj True

Data

Name Type Description
symbol str Symbol representing the entity requested in the data.
name str Name of the entity.
last_price float Last price.
percent_change float Percent change.
net_change float Net change.
volume float The trading volume.
date date The date of the data.
Name Type Description
symbol str Symbol representing the entity requested in the data.
name str Name of the entity.
last_price float Last price.
percent_change float Percent change.
net_change float Net change.
volume float The trading volume.
date date The date of the data.
country str Country of the entity.
mantissa int Mantissa.
type str Type of the entity.
formatted_price str Formatted price.
formatted_volume str Formatted volume.
formatted_price_change str Formatted price change.
formatted_percent_change str Formatted percent change.
url str The source url.