commercial_paper
Commercial Paper.
Commercial paper (CP) consists of short-term, promissory notes issued primarily by corporations. Maturities range up to 270 days but average about 30 days. Many companies use CP to raise cash needed for current transactions, and many find it to be a lower-cost alternative to bank loans.
Examples
from openbb import obb
obb.fixedincome.corporate.commercial_paper(provider='fred')
obb.fixedincome.corporate.commercial_paper(category=all, maturity=15d, provider='fred')
Parameters
- standard
- fred
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
maturity: Union[Union[str, Literal['all', 'overnight', '7d', '15d', '30d', '60d', '90d']], list[Union[str, Literal['all', 'overnight', '7d', '15d', '30d', '60d', '90d']]]]
Default: all
A target maturity. Multiple items allowed for provider(s): fred.
category: Union[Union[str, Literal['all', 'asset_backed', 'financial', 'nonfinancial', 'a2p2']], list[Union[str, Literal['all', 'asset_backed', 'financial', 'nonfinancial', 'a2p2']]]]
Default: all
The category of asset. Multiple items allowed for provider(s): fred.
frequency: Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']
Description
Frequency aggregation to convert daily data to lower frequency.
a = Annual
q = Quarterly
m = Monthly
w = Weekly
wef = Weekly, Ending Friday
weth = Weekly, Ending Thursday
wew = Weekly, Ending Wednesday
wetu = Weekly, Ending Tuesday
wem = Weekly, Ending Monday
wesu = Weekly, Ending Sunday
wesa = Weekly, Ending Saturday
bwew = Biweekly, Ending Wednesday
bwem = Biweekly, Ending Monday
aggregation_method: Literal['avg', 'sum', 'eop']
Description
A key that indicates the aggregation method used for frequency aggregation.
avg = Average
sum = Sum
eop = End of Period
transform: Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']
Description
Transformation type
None = No transformation
chg = Change
ch1 = Change from Year Ago
pch = Percent Change
pc1 = Percent Change from Year Ago
pca = Compounded Annual Rate of Change
cch = Continuously Compounded Rate of Change
cca = Continuously Compounded Annual Rate of Change
log = Natural Log
Returns
results: list[CommercialPaper]
Serializable results.
provider: Optional[Literal['fred']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- fred
date: date | str
The date of the data.
symbol: str
Symbol representing the entity requested in the data.
maturity: str
Maturity length of the item.
rate: float
Interest rate.
title: str
Title of the series.
date: date | str
The date of the data.
symbol: str
Symbol representing the entity requested in the data.
maturity: str
Maturity length of the item.
rate: float
Interest rate.
title: str
Title of the series.
asset_type: Literal['asset_backed', 'financial', 'nonfinancial', 'a2p2']
The category of asset.