Treasury Auction Results
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
TreasuryAuctionResults | TreasuryAuctionResultsQueryParams | TreasuryAuctionResultsData |
Import Statement
from openbb_core.provider.standard_models. import (
TreasuryAuctionResultsData,
TreasuryAuctionResultsQueryParams,
)
Parameters
- standard
- us_treasury
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format. Filters on the auction date. Data begins 1979-11-15. 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 the auction date.
security_type: str | None
Filter by security type. TIPS, FRNs, and cash management bills are flagged in the output, not separate types.
cusip: str | None
Filter by CUSIP. Accepts a comma-separated list.
Data
- standard
- us_treasury
auction_date: date
Date of the auction. This is the observation axis of the series, and rows read newest first.
security_type: str
Type of the security: Bill, Note, or Bond.
security_term: str
Term of the security, e.g. 13-Week or 29-Year 9-Month.
cusip: str
CUSIP of the security. Repeats across reopenings; (cusip, issue_date) is the unique key.
issue_date: date
Date the security is issued.
maturity_date: date
Date the security matures.
announcement_date: date
Date the auction was announced.
price_per_100: float | None
Settlement price per $100 face value.
accrued_interest_per_100: float | None
Accrued interest per $100 face value, on FRN reopenings.
accrued_interest_per_1000: float | None
Accrued interest per $1,000 face value, on coupon reopenings and back-dated issues.
adjusted_accrued_interest_per_1000: float | None
Inflation-adjusted accrued interest per $1,000 face value, on TIPS.
adjusted_price: float | None
Inflation-adjusted price per $100 face value, on TIPS.
allocation_percentage: float | None
Share of bids at the high rate or yield that was awarded, as a normalized decimal (percent / 100).
allocation_percentage_decimals: int | None
Number of decimals in the allocation percentage.
announced_cusip: str | None
CUSIP announced for an unscheduled reopening.
auction_format: str | None
Auction format: Single-Price, Multi-Price, or Price-Based.
avg_median_discount_rate: float | None
Weighted-average or median discount rate of accepted bill bids, as a normalized decimal (percent / 100).
avg_median_investment_rate: float | None
Weighted-average or median investment rate of accepted bill bids, as a normalized decimal (percent / 100). Discontinued after 1998-10-29.
avg_median_price: float | None
Weighted-average or median accepted price per $100 face value, on multi-price auctions. Discontinued after 2008-04-03.
avg_median_discount_margin: float | None
Weighted-average or median discount margin of accepted FRN bids, as a normalized decimal (percent / 100).
avg_median_yield: float | None
Weighted-average or median yield of accepted bids on notes and bonds, as a normalized decimal (percent / 100).
back_dated: bool | None
Whether the issue is back-dated.
back_dated_date: date | None
Date to which the issue is back-dated.
bid_to_cover_ratio: float | None
Ratio of total tendered to total accepted.
callable: bool | None
Whether the security is callable.
call_date: date | None
Earliest call date, on pre-1985 callable bonds.
called_date: date | None
Date the security was called, on pre-1985 callable bonds.
cash_management_bill: bool
Whether the security is a cash management bill.
closing_time_competitive: str | None
Closing time for competitive tenders, Eastern Time.
closing_time_noncompetitive: str | None
Closing time for noncompetitive tenders, Eastern Time.
competitive_accepted: float | None
Competitive bids accepted, in dollars.
competitive_bid_decimals: int | None
Number of decimals allowed in competitive bids.
competitive_tendered: float | None
Competitive bids tendered, in dollars.
competitive_tenders_accepted: bool | None
Whether competitive tenders were accepted.
corpus_cusip: str | None
CUSIP of the stripped principal component.
cpi_base_reference_period: str | None
CPI base reference period, on TIPS.
currently_outstanding: float | None
Amount currently outstanding before a reopening, in dollars.
dated_date: date | None
Date from which interest accrues, on coupon securities.
direct_bidder_accepted: float | None
Direct bidder tenders accepted, in dollars.
direct_bidder_tendered: float | None
Direct bidder tenders submitted, in dollars.
estimated_amount_of_publicly_held_maturing_securities: float | None
Estimated amount of publicly held maturing securities of the same type, in dollars.
fima_included: bool | None
Whether FIMA noncompetitive tenders were included.
fima_noncompetitive_accepted: float | None
FIMA noncompetitive tenders accepted, in dollars.
fima_noncompetitive_tendered: float | None
FIMA noncompetitive tenders submitted, in dollars.
first_interest_period: str | None
First interest period: Long, Normal, or Short.
first_interest_payment_date: date | None
Date of the first interest payment, on coupon securities.
floating_rate: bool
Whether the security is a floating rate note.
frn_index_determination_date: date | None
Date the FRN index rate was determined.
frn_index_determination_rate: float | None
FRN index rate on the determination date, as a normalized decimal (percent / 100).
high_discount_rate: float | None
Highest accepted discount rate on bills, as a normalized decimal (percent / 100).
high_investment_rate: float | None
Coupon-equivalent yield of the high discount rate, as a normalized decimal (percent / 100).
high_price: float | None
Price at the highest accepted rate or yield, per $100 face value.
high_discount_margin: float | None
Highest accepted discount margin on FRNs, as a normalized decimal (percent / 100).
high_yield: float | None
Highest accepted yield on notes and bonds, as a normalized decimal (percent / 100).
index_ratio_on_issue_date: float | None
Inflation index ratio on the issue date, on TIPS.
indirect_bidder_accepted: float | None
Indirect bidder tenders accepted, in dollars.
indirect_bidder_tendered: float | None
Indirect bidder tenders submitted, in dollars.
interest_payment_frequency: str | None
Interest payment frequency: Annual, Quarterly, Semi-Annual, or None.
interest_rate: float | None
Coupon rate of the security, as a normalized decimal (percent / 100).
low_discount_rate: float | None
Lowest accepted discount rate on bills, as a normalized decimal (percent / 100).
low_investment_rate: float | None
Lowest accepted investment rate on multi-price bill auctions, as a normalized decimal (percent / 100). Discontinued after 1998-10-29.
low_price: float | None
Lowest accepted price per $100 face value, on multi-price auctions. Discontinued after 2008-04-03.
low_discount_margin: float | None
Lowest accepted discount margin on FRNs, as a normalized decimal (percent / 100).
low_yield: float | None
Lowest accepted yield on notes and bonds, as a normalized decimal (percent / 100).
maturing_date: date | None
Date of the maturing securities being refunded, not the maturity of the offered security.
maximum_competitive_award: float | None
Maximum competitive award to a single bidder, in dollars.
maximum_noncompetitive_award: float | None
Maximum noncompetitive award to a single bidder, in dollars.
maximum_single_bid: float | None
Maximum single bid, in dollars.
minimum_bid_amount: float | None
Minimum bid amount, in dollars.
minimum_strip_amount: float | None
Minimum amount that can be stripped, in dollars.
minimum_to_issue: float | None
Minimum amount to issue, in dollars.
multiples_to_bid: float | None
Bid multiples, in dollars.
multiples_to_issue: float | None
Issue multiples, in dollars.
nlp_exclusion_amount: float | None
Net long position exclusion amount, in dollars.
nlp_reporting_threshold: float | None
Net long position reporting threshold, in dollars.
noncompetitive_accepted: float | None
Noncompetitive tenders accepted, in dollars.
noncompetitive_tenders_accepted: bool | None
Whether noncompetitive tenders were accepted.
offering_amount: float | None
Announced offering amount, in dollars.
original_cusip: str | None
Original CUSIP for an unscheduled reopening.
original_dated_date: date | None
Dated date of the original issue, on reopenings.
original_issue_date: date | None
Issue date of the original issue, on reopenings.
original_security_term: str | None
Term of the security at original issuance.
pdf_announcement: str | None
PDF filename of the announcement, on treasurydirect.gov.
pdf_competitive_results: str | None
PDF filename of the competitive results, on treasurydirect.gov.
pdf_noncompetitive_results: str | None
PDF filename of the noncompetitive results, on treasurydirect.gov.
primary_dealer_accepted: float | None
Primary dealer tenders accepted, in dollars.
primary_dealer_tendered: float | None
Primary dealer tenders submitted, in dollars.
reference_cpi_on_dated_date: float | None
Reference CPI on the dated date, on TIPS.
reference_cpi_on_issue_date: float | None
Reference CPI on the issue date, on TIPS.
reopening: bool
Whether the auction reopens an existing security.
security_term_day_month: str | None
Security term expressed in days or months.
security_term_week_year: str | None
Security term expressed in weeks or years.
series: str | None
Series of the security, on coupon securities.
soma_accepted: float | None
SOMA tenders accepted, in dollars.
soma_holdings: float | None
SOMA holdings of maturing securities, in dollars.
soma_included: bool | None
Whether SOMA tenders were included in the offering amount.
soma_tendered: float | None
SOMA tenders submitted, in dollars.
spread: float | None
FRN spread over the index rate, as a normalized decimal (percent / 100).
standard_interest_payment_per_1000: float | None
Standard interest payment per $1,000 face value, on coupon securities.
strippable: bool | None
Whether the security can be stripped.
tiin_conversion_factor_per_1000: float | None
TIIN conversion factor per $1,000 face value, on TIPS.
total_accepted: float | None
Total tenders accepted, in dollars.
total_tendered: float | None
Total tenders submitted, in dollars.
treasury_retail_accepted: float | None
Treasury retail tenders accepted, in dollars.
treasury_retail_tenders_accepted: bool | None
Whether Treasury retail tenders were accepted.
unadjusted_accrued_interest_per_1000: float | None
Unadjusted accrued interest per $1,000 face value, on TIPS.
unadjusted_price: float | None
Unadjusted price per $100 face value, on TIPS.
xml_announcement: str | None
XML filename of the announcement, on treasurydirect.gov.
xml_competitive_results: str | None
XML filename of the competitive results, on treasurydirect.gov.
inflation_index_security: bool
Whether the security is a TIPS.
tint_cusip_1: str | None
CUSIP of the first stripped interest component.
tint_cusip_2: str | None
CUSIP of the second stripped interest component.
pdf_special_announcement: str | None
PDF filename of a special announcement, on treasurydirect.gov.