Files
OpenBB/website/content/platform/data_models/UpcomingReleaseDays.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.3 KiB
Vendored

title, description
title description
Get upcoming release days OpenBB Platform Data Model

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


Implementation details

Class names

Model name Parameters class Data class
UpcomingReleaseDays UpcomingReleaseDaysQueryParams UpcomingReleaseDaysData

Import Statement

from openbb_core.provider.standard_models.upcoming_release_days import (
UpcomingReleaseDaysData,
UpcomingReleaseDaysQueryParams,
)

Parameters

Name Type Description Default Optional
provider Literal['seeking_alpha'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'seeking_alpha' if there is no default. seeking_alpha True
Name Type Description Default Optional
provider Literal['seeking_alpha'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'seeking_alpha' if there is no default. seeking_alpha True
limit int The number of data entries to return.In this case, the number of lookahead days. 10 True

Data

Name Type Description
symbol str Symbol representing the entity requested in the data.
name str The full name of the asset.
exchange str The exchange the asset is traded on.
release_time_type str The type of release time.
release_date date The date of the release.
Name Type Description
symbol str Symbol representing the entity requested in the data.
name str The full name of the asset.
exchange str The exchange the asset is traded on.
release_time_type str The type of release time.
release_date date The date of the release.
sector_id int The sector ID of the asset.