Files
OpenBB/website/content/platform/data_models/EquityQuote.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

5.2 KiB
Vendored

title, description
title description
Equity Quote OpenBB Platform Data Model

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


Implementation details

Class names

Model name Parameters class Data class
EquityQuote EquityQuoteQueryParams EquityQuoteData

Import Statement

from openbb_core.provider.standard_models.equity_quote import (
EquityQuoteData,
EquityQuoteQueryParams,
)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. In this case, the comma separated list of symbols. False
provider Literal['fmp', 'intrinio'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. fmp True
Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. In this case, the comma separated list of symbols. False
provider Literal['fmp', 'intrinio'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. fmp True
source Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip'] Source of the data. iex True

Data

Name Type Description
day_low float Lowest price of the stock in the current trading day.
day_high float Highest price of the stock in the current trading day.
date datetime The date of the data.
Name Type Description
day_low float Lowest price of the stock in the current trading day.
day_high float Highest price of the stock in the current trading day.
date datetime The date of the data.
symbol str Symbol of the company.
name str Name of the company.
price float Current trading price of the stock.
changes_percentage float Change percentage of the stock price.
change float Change in the stock price.
year_high float Highest price of the stock in the last 52 weeks.
year_low float Lowest price of the stock in the last 52 weeks.
market_cap float Market cap of the company.
price_avg50 float 50 days average price of the stock.
price_avg200 int 200 days average price of the stock.
volume int Volume of the stock in the current trading day.
avg_volume int Average volume of the stock in the last 10 trading days.
exchange str Exchange the stock is traded on.
open float Opening price of the stock in the current trading day.
previous_close float Previous closing price of the stock.
eps float Earnings per share of the stock.
pe float Price earnings ratio of the stock.
earnings_announcement str Earnings announcement date of the stock.
shares_outstanding int Number of shares outstanding of the stock.
Name Type Description
day_low float Lowest price of the stock in the current trading day.
day_high float Highest price of the stock in the current trading day.
date datetime The date of the data.
last_price float Price of the last trade.
last_time datetime Date and Time when the last trade occurred.
last_size int Size of the last trade.
bid_price float Price of the top bid order.
bid_size int Size of the top bid order.
ask_price float Price of the top ask order.
ask_size int Size of the top ask order.
open_price float Open price for the trading day.
close_price float Closing price for the trading day (IEX source only).
high_price float High Price for the trading day.
low_price float Low Price for the trading day.
exchange_volume int Number of shares exchanged during the trading day on the exchange.
market_volume int Number of shares exchanged during the trading day for the whole market.
updated_on datetime Date and Time when the data was last updated.
source str Source of the data.
listing_venue str Listing venue where the trade took place (SIP source only).
sales_conditions str Indicates any sales condition modifiers associated with the trade.
quote_conditions str Indicates any quote condition modifiers associated with the trade.
market_center_code str Market center character code.
is_darkpool bool Whether or not the current trade is from a darkpool.
messages List[str] Messages associated with the endpoint.
security Dict[str, Any] Security details related to the quote.