Wealthnow
Sign up

API ReferenceAlt-Data

Status

Treasury auction results

GET/api/v3/macro_history/treasury_auctions
Plan
Pro and up
Price
3 credits per call
MCP tool
macro_history_treasury_auctions

U.S. Treasury auction results: CUSIP, term, auction/issue/maturity dates, high yield (percent; bills: high discount and investment rate; FRNs: high discount margin), coupon, bid-to-cover, offering, tendered and accepted amounts (USD), and indirect, direct and primary-dealer takedown (percent of the competitive amount accepted). tail_bp is null: the record has no when-issued yield. Results post the auction day; held_range says where the held history starts. Newest first, up to limit. Call it for auction demand, foreign/indirect appetite or dealer take-up by tenor.

Parameters

Query

security_typestringOptional

Note includes TIPS notes and FRNs and Bill includes cash management bills; TIPS, FRN and CMB select only those.

One ofBillNoteBondTIPSFRNCMB
termstringOptional

e.g. 10-Year, 13-Week (matches the original term of a reopening too)

startstringOptional

YYYY-MM-DD (default end - 180 days)

endstringOptional

YYYY-MM-DD (default today); at most 10 years per call.

limitintegerOptional
Default100
Range1 to 500

Response

A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Macro, Rates & FX). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.

A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.

Errors

No error is billed. The body is { "ok": false, "error", "detail", "request_id" }; read the code from error.

ErrorMeaning
400 invalid_tickerThe request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed.
401 unauthorizedMissing or invalid API key.
402 plan_requiredYour plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed.
403 scope_deniedThis API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed.
404 not_foundNo such resource. Not billed.
422 validationA parameter is missing, out of range or the wrong type; param names it. Not billed.
429 rate_limitedYour plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed.
503 paid_data_unavailableThe data could not be served completely right now; retry later. Not billed.
504 request_timeoutThe request ran past the server's time budget; retry. Not billed.

This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.

Guides

Read the Macro, Rates & FX guide for this endpoint's fields and examples.