Files
OpenBB/website/content/platform/reference/rate/estr.md
James Maslek dce447b423 install v4 (#5766)
* install v4

* add run on pr

* this seems sus

* thnx juan

* flip

* thnx juan

* idk

* Update index.js

* Update Root.tsx

* Update index.js

* try again

* fix front matter

* fix description front matter

* Revert "fix description front matter"

This reverts commit cccc7b2469.

* try to fix this mickey

* fixed all that mickey @DidierRLopes broke

* Update index.js

* generate platform fix

* black fix

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: tehcoderer <me@tehcoderer.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-11-21 06:38:50 +00:00

3.5 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
estr Learn about the euro short-term rate ($ACSTR), wholesale euro unsecured overnight borrowing costs, TARGET2 business day transactions, parameters for the Python obb.fixedincome.rate.estr method, and the data and returns provided.
euro short-term rate
$ACSTR
wholesale euro unsecured overnight borrowing costs
TARGET2 business day
transactions
arm's length
market rates
Python obb.fixedincome.rate.estr
parameters
start date
end date
provider
fred
data
returns
results
warnings
chart
metadata
volume_weighted_trimmed_mean_rate
number_of_transactions
number_of_active_banks
total_volume
share_of_volume_of_the_5_largest_active_banks
rate_at_75th_percentile_of_volume
rate_at_25th_percentile_of_volume
data
date
rate

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

Euro Short-Term Rate.

The euro short-term rate (€STR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in the euro area. The €STR is published on each TARGET2 business day based on transactions conducted and settled on the previous TARGET2 business day (the reporting date “T”) with a maturity date of T+1 which are deemed to have been executed at arm’s length and thus reflect market rates in an unbiased way.

obb.fixedincome.rate.estr(start_date: Union[date, str] = None, end_date: Union[date, str] = None, provider: Literal[str] = fred)

Parameters

Name Type Description Default Optional
start_date Union[date, str] Start date of the data, in YYYY-MM-DD format. None True
end_date Union[date, str] End date of the data, in YYYY-MM-DD format. None True
provider Literal['fred'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. fred True
Name Type Description Default Optional
start_date Union[date, str] Start date of the data, in YYYY-MM-DD format. None True
end_date Union[date, str] End date of the data, in YYYY-MM-DD format. None True
provider Literal['fred'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. fred True
parameter Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume'] Period of ESTR rate. volume_weighted_trimmed_mean_rate True

Returns

OBBject
    results : List[ESTR]
        Serializable results.

    provider : Optional[Literal['fred']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    metadata: Optional[Metadata]
        Metadata info about the command execution.

Data

Name Type Description
date date The date of the data.
rate float ESTR rate.