bulletin
Get tables from the quarterly Treasury Bulletin - offerings, ownership distribution, currency and coin, foreign currency positions, the Exchange Stabilization Fund, and internal revenue receipts.
Examples
from openbb import obb
obb.ustreasury.bulletin(table='ofs2', provider='us_treasury')
# Get the distribution of federal securities by class of investors.
obb.ustreasury.bulletin(table='ofs1', provider='us_treasury')
# Get offerings of marketable securities other than regular weekly bills.
obb.ustreasury.bulletin(table='pdo2', start_date='2025-01-01', provider='us_treasury')
Parameters
- standard
- us_treasury
table: str | None
Default: ofs2
The Treasury Bulletin table to query. pdo1: auction results of regular weekly Treasury bills; pdo2: auction results of other marketable securities (CMBs, notes, bonds, TIPS, FRNs); ofs1: distribution of federal securities by class of investors and type of issues; ofs2: estimated ownership of U.S. Treasury securities; uscc1: currency and coin outstanding and in circulation; uscc2: currency in circulation by denomination; fcp1: weekly foreign currency positions of major market participants; fcp2: monthly foreign currency positions of major market participants; fcp3: quarterly foreign currency positions of large market participants; esf1: Exchange Stabilization Fund balances; esf2: Exchange Stabilization Fund statement of net cost; ffo5: internal revenue receipts by state; ffo6: Customs and Border Protection collections of duties, taxes, and fees by district and port.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format. Filters on record_date, the bulletin edition date: PDO, USCC, FCP, and ESF editions fall on the 1st of Mar/Jun/Sep/Dec, FFO editions on Dec 1, and OFS tables use quarter-end dates; for ofs2, record_date is only the date the series was last restated. Editions begin 2021. When None, defaults to the trailing 365 days rather than the full history; set it explicitly to reach further back.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format. Filters on record_date, the bulletin edition date.
Returns
results: TreasuryBulletin
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- us_treasury
table_code: str
Treasury Bulletin table code of the row, e.g. 'OFS-2'.
report_date: date | None
Date the figures are as of - the observation axis for the OFS, USCC, FCP, and ESF tables. Declared first so it leads the served columns, which this model orders by field declaration because its omit-None serializer carries no column config.
record_date: date
Publication date of the bulletin edition reporting the row; for ofs2, the date the series was last restated. This is edition metadata, not the observation axis.
auction_date: date | None
Date of the auction. (pdo2)
issue_date: date | None
Date the security was issued. (pdo1, pdo2)
maturity_date: date | None
Date the bills mature. (pdo1)
days_to_maturity: int | None
Number of days from issue to maturity, identifying the bill tenor. (pdo1)
fiscal_year: int | None
Fiscal year the collections were received in. (ffo5, ffo6)
line_number: int | None
Line number of the row in the published bulletin table; not present for ofs2.
classification: str | None
Primary classification of the row - securities classification (ofs1), securities owner (ofs2), holder category (uscc1), or statement line item (esf1, esf2).
sub_classification: str | None
Class of investors holding the securities. (ofs1)
issue_type: str | None
Type of issues held - Marketable, Nonmarketable, or Total. (ofs1)
security_description: str | None
Description of the security auctioned, including the rate, type, and maturity. (pdo2)
period_to_final_maturity: str | None
Period from the issue date to final maturity, e.g. '42d' or '9y 10m'. (pdo2)
denomination: str | None
Currency denomination, e.g. '$100', or 'Total Currency'. (uscc2)
currency: str | None
Foreign currency of the reported positions. (fcp1, fcp2, fcp3)
state: str | None
U.S. state, or aggregate area, of the collections. (ffo5)
district: str | None
Customs district of the collection port. (ffo6)
port: str | None
Collection port name, or 'Total' for the district roll-up. (ffo6)
port_code: str | None
Five-digit CBP port code; not present on district roll-up rows. (ffo6)
bids_tendered: float | None
Amount of bids tendered at auction, in dollars. (pdo1, pdo2)
bids_accepted: float | None
Total amount of bids accepted at auction, in dollars. (pdo1, pdo2)
bids_accepted_competitive: float | None
Amount of bids accepted on a competitive basis, in dollars. (pdo1)
bids_accepted_noncompetitive: float | None
Amount of bids accepted on a non-competitive basis, in dollars. (pdo1)
high_price_per_hundred: float | None
High price per hundred on competitive bids accepted. (pdo1)
high_discount_rate: float | None
High discount rate on competitive bids accepted, as a normalized decimal (percent / 100). (pdo1)
high_investment_rate: float | None
High investment rate on competitive bids accepted, as a normalized decimal (percent / 100). (pdo1)
accepted_yield_discount_margin: float | None
Accepted yield for notes, bonds, and TIPS, or discount margin for FRNs, as a normalized decimal (percent / 100). (pdo2)
equivalent_price: float | None
Equivalent price per hundred for notes and bonds. (pdo2)
securities_amount: float | None
Amount of securities held, in dollars. (ofs1, ofs2)
total_currency_and_coins: float | None
Total currency and coins, in dollars. (uscc1)
total_currency: float | None
Total currency, in dollars. (uscc1, uscc2)
federal_reserve_notes: float | None
Federal Reserve notes, in dollars. (uscc1, uscc2)
us_notes: float | None
U.S. notes, in dollars; can be negative by denomination. (uscc1, uscc2)
currency_no_longer_issued: float | None
Currency no longer issued, in dollars. (uscc1, uscc2)
total_coins: float | None
Total coins, in dollars. (uscc1)
dollar_coins: float | None
Dollar coins, in dollars. (uscc1)
fractional_coins: float | None
Fractional coins, in dollars. (uscc1)
per_capita: float | None
Currency in circulation per capita, in dollars; populated only on the 'Total Currency' row, 0 otherwise. (uscc2)
spot_forward_futures_purchased: float | None
Spot, forward, and futures contracts purchased, in units of the currency. (fcp1, fcp2, fcp3)
spot_forward_futures_sold: float | None
Spot, forward, and futures contracts sold, in units of the currency. (fcp1, fcp2, fcp3)
net_options_position: float | None
Net options position, in units of the currency. (fcp1)
assets: float | None
Foreign currency assets, in units of the currency. (fcp2, fcp3)
liabilities: float | None
Foreign currency liabilities, in units of the currency. (fcp2, fcp3)
call_options_bought: float | None
Call options bought, in units of the currency. (fcp2, fcp3)
call_options_written: float | None
Call options written, in units of the currency. (fcp2, fcp3)
put_options_bought: float | None
Put options bought, in units of the currency. (fcp2, fcp3)
put_options_written: float | None
Put options written, in units of the currency. (fcp2, fcp3)
options_net_delta: float | None
Net delta-equivalent options position, in units of the currency. (fcp2, fcp3)
exchange_rate: float | None
Units of the foreign currency per U.S. dollar; not applicable to U.S. Dollars rows. (fcp1, fcp2, fcp3)
activity: float | None
Activity since the last report date, in dollars. (esf1)
balance: float | None
Balance as of the report date, in dollars. (esf1)
current_quarter_amount: float | None
Amount for the current quarter, in dollars. (esf2)
fiscal_year_to_date_amount: float | None
Fiscal year-to-date amount, in dollars. (esf2)
total_collections: float | None
Total collections, in dollars - gross internal revenue collections (ffo5) or duties, taxes, and fees collected (ffo6).
business_income_taxes: float | None
Business income taxes collected, in dollars. (ffo5)
total_individual_taxes: float | None
Total individual taxes collected, in dollars. (ffo5)
withheld_income_and_fica_taxes: float | None
Individual income taxes withheld and FICA taxes, in dollars. (ffo5)
not_withheld_income_and_seca_taxes: float | None
Individual income taxes not withheld and SECA taxes, in dollars. (ffo5)
unemployment_insurance_taxes: float | None
Unemployment insurance taxes, in dollars. (ffo5)
railroad_retirement_taxes: float | None
Railroad retirement taxes, in dollars. (ffo5)
estate_and_trust_income_taxes: float | None
Estate and trust income taxes, in dollars. (ffo5)
estate_taxes: float | None
Estate taxes, in dollars. (ffo5)
gift_taxes: float | None
Gift taxes, in dollars. (ffo5)
excise_taxes: float | None
Excise taxes, in dollars; excludes those collected by CBP and TTB. (ffo5)