addedInput schema / properties / filters / additionalProperties
Added value: +false
changedInput schema / properties / filters / properties / agency_name / description
Previous value: -"Awarding agency name filter"New value: +"Awarding agency name filter, top-tier only (e.g., \"Department of Defense\") — the toptier_name from usaspending_autocomplete_filters type=awarding_agency; a sub-agency name matches nothing"
addedInput schema / properties / filters / properties / assistance_listings
Added value: +{
+ "description": "Filter by Assistance Listing (CFDA) program numbers, e.g. [\"15.507\"]: two digits, a dot, then three digits or capital letters (11.67A). Matches an award when any of its listings equals one of these exactly; several values match any of them. A matching award's primary listing can differ from the one requested, and amounts cover the whole award, not that listing's share. Only assistance awards (grants, direct payments, loans, other assistance) carry listings, so a call whose award types are all contracts or IDVs — including a contract default — is rejected as assistance_listings_type_mismatch. Use usaspending_autocomplete_filters type=cfda to look up numbers.",
+ "items": {
+ "description": "Assistance Listing number, e.g. 15.507",
+ "pattern": "^\\d{2}\\.[0-9A-Z]{3}$",
+ "type": "string"
+ },
+ "type": "array"
+}
changedInput schema / properties / filters / properties / award_type_codes / description
Previous value: -"Award type code filters (A/B/C/D, 02–05, etc.). All codes must belong to a single group. When omitted, defaults to contracts (A, B, C, D)."New value: +"Award type code filters (A/B/C/D, 02–05, etc.); groups may be mixed. When omitted, defaults to contracts (A, B, C, D)."
addedInput schema / properties / filters / properties / def_codes
Added value: +{
+ "description": "Filter by Disaster Emergency Fund Codes (DEF), e.g. [\"Z\"], or [\"L\", \"M\", \"N\", \"O\", \"P\"] for COVID-19: 1–3 letters or digits, sent uppercased — the codes usaspending_disaster_spending takes and usaspending_get_agency lists. Matches awards of any type funded under any of these codes. Amounts cover the whole matching award, not the share funded by the code, and DEF-filtered totals can be negative. An unknown code is rejected with the list of codes USAspending accepts.",
+ "items": {
+ "description": "Disaster Emergency Fund Code, e.g. Z or L",
+ "pattern": "^[0-9A-Za-z]{1,3}$",
+ "type": "string"
+ },
+ "type": "array"
+}
addedInput schema / properties / filters / properties / psc_codes
Added value: +{
+ "description": "Filter by Product and Service Codes (PSC), e.g. [\"Y1NE\"]: 1–4 letters or digits, sent uppercased. A shorter code covers every code under it (\"Y1\" covers \"Y1NE\"); several values match any of them. Only contracts and IDVs carry a PSC, so a call whose award types are all assistance types is rejected as psc_codes_type_mismatch, and pairing psc_codes with assistance_listings matches nothing, since no award carries both. Use usaspending_autocomplete_filters type=psc to look up codes.",
+ "items": {
+ "description": "Product and Service Code or prefix, e.g. Y1NE or Y1",
+ "pattern": "^[0-9A-Za-z]{1,4}$",
+ "type": "string"
+ },
+ "type": "array"
+}
addedOutput schema / properties / applied_assistance_listings
Added value: +{
+ "description": "Assistance Listing numbers sent (comma-separated)",
+ "type": "string"
+}
addedOutput schema / properties / applied_def_codes
Added value: +{
+ "description": "DEF codes sent, uppercased (comma-separated)",
+ "type": "string"
+}
addedOutput schema / properties / applied_psc_codes
Added value: +{
+ "description": "PSC codes sent, uppercased (comma-separated)",
+ "type": "string"
+}
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `api_unavailable`: USAspending.gov API is unreachable or returns an error. `api_timeout`: USAspending.gov did not respond before the request deadline elapsed. `date_range_inverted`: Both filters.time_period_start and filters.time_period_end were supplied and the start falls after the end. `date_before_earliest`: The resolved start date precedes the 2007-10-01 earliest date this endpoint can search. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `api_unavailable`: USAspending.gov API is unreachable or returns an error. `api_timeout`: USAspending.gov did not respond before the request deadline elapsed. `date_range_inverted`: Both filters.time_period_start and filters.time_period_end were supplied and the start falls after the end. `date_before_earliest`: The resolved start date precedes the 2007-10-01 earliest date this endpoint can search. `assistance_listings_type_mismatch`: filters.assistance_listings was given while every code in filters.award_type_codes is a contract or IDV code, or award_type_codes was left at its contract default. `psc_codes_type_mismatch`: filters.psc_codes was given while every code in filters.award_type_codes is an assistance code. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "api_unavailable",
- "api_timeout",
- "date_range_inverted",
- "date_before_earliest"
-]New value: +[
+ "api_unavailable",
+ "api_timeout",
+ "date_range_inverted",
+ "date_before_earliest",
+ "assistance_listings_type_mismatch",
+ "psc_codes_type_mismatch"
+]
changedOutput schema / properties / notice / description
Previous value: -"Names a time-window bound that was filled in because only the other was supplied, and suggests broadening filters when no periods are returned. Absent when neither applies."New value: +"Names a time-window bound that was filled in because only the other was supplied, and — when no periods are returned — names any Assistance Listing, PSC, or DEF codes sent and suggests broadening filters. Absent when neither applies."