changedInput schema / properties / agency_name / description
Previous value: -"Filter to a specific awarding agency by name (e.g., \"Department of Defense\"). Use usaspending_autocomplete_filters type=awarding_agency to find exact names."New value: +"Filter to one awarding agency by its top-tier name (e.g., \"Department of Defense\"). Top-tier only: a sub-agency name matches no awards. Take the value from toptier_name in usaspending_autocomplete_filters type=awarding_agency — for a sub-agency that is its parent, so results cover the whole department."
changedInput schema / properties / assistance_listings / description
Previous value: -"Filter by Assistance Listing (CFDA) program numbers, e.g. [\"93.866\"]: 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 row's primary listing can differ from the one requested, and its amount is the whole award, not that listing's share. Assistance award types only — set award_type_codes to grants, direct payments, loans, or other assistance; contracts and IDVs carry no listings, so pairing them (including the default award_type_codes) is rejected. Use usaspending_autocomplete_filters type=cfda to look up numbers."New value: +"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."
changedInput schema / properties / assistance_listings / items / description
Previous value: -"Assistance Listing number, e.g. 93.866"New value: +"Assistance Listing number, e.g. 15.507"
addedInput schema / 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 / additionalProperties
Added value: +false
changedInput schema / properties / filters / description
Previous value: -"Optional analytics-style filter object mirroring the shape the spending analytics tools accept, for reusing one filter set across tools. When both this object and the equivalent top-level flat filters are given, this object wins per-field. recipient_id is intentionally not accepted — this endpoint silently ignores it; filter by recipient via recipient_name."New value: +"Optional analytics-style filter object mirroring the shape the spending analytics tools accept, for reusing one filter set across tools. When both this object and the equivalent top-level flat filters are given, this object wins per-field. recipient_id is rejected — this endpoint silently ignores it; filter by recipient via recipient_name."
changedInput schema / properties / filters / properties / agency_name / description
Previous value: -"Awarding agency name (toptier), e.g., \"Department of Defense\""New value: +"Awarding agency name, top-tier only (e.g., \"Department of Defense\") — the toptier_name from usaspending_autocomplete_filters type=awarding_agency; a sub-agency name matches no awards"
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"
+}
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"
+}
addedInput schema / properties / location_filter / additionalProperties
Added value: +false
changedInput schema / properties / location_filter / description
Previous value: -"Filter by place of performance location. Uses FIPS codes and 2-letter state abbreviations, not place names — use a geocoding server to resolve names to codes first."New value: +"Filter by place of performance. Takes codes, not place names — use a geocoding server to resolve names to codes first. Blank fields are ignored, and an all-blank object is no location filter. The location sent is echoed as applied_location."
addedInput schema / properties / location_filter / properties / country / anyOf
Added value: +[
+ {
+ "const": "",
+ "type": "string"
+ },
+ {
+ "pattern": "^[A-Za-z]{3}$",
+ "type": "string"
+ }
+]
changedInput schema / properties / location_filter / properties / country / description
Previous value: -"ISO 3166-1 alpha-3 country code (e.g., USA)"New value: +"ISO 3166-1 alpha-3 country code (e.g., USA); USA when omitted. A US territory code — PRI, GUM, VIR, ASM, MNP — is sent as USA with the territory as state."
removedInput schema / properties / location_filter / properties / country / type
Removed value: -"string"
addedInput schema / properties / location_filter / properties / county / anyOf
Added value: +[
+ {
+ "const": "",
+ "type": "string"
+ },
+ {
+ "pattern": "^(?:\\d{3}|\\d{5})$",
+ "type": "string"
+ }
+]
changedInput schema / properties / location_filter / properties / county / description
Previous value: -"FIPS county code (e.g., 06037 for Los Angeles County)"New value: +"US county FIPS code: 3 digits with state (049 with state NM), or the 5-digit state + county code (35049, Santa Fe County, NM), whose first two digits set the state — the form usaspending_spending_by_geography county rows carry as shape_code."
removedInput schema / properties / location_filter / properties / county / type
Removed value: -"string"
addedInput schema / properties / location_filter / properties / state / anyOf
Added value: +[
+ {
+ "const": "",
+ "type": "string"
+ },
+ {
+ "pattern": "^(?:[A-Za-z]{2}|\\d{2})$",
+ "type": "string"
+ }
+]
changedInput schema / properties / location_filter / properties / state / description
Previous value: -"Two-letter US state abbreviation (e.g., CA)"New value: +"Under USA (the default): a US state, DC, territory, freely associated state, or armed-forces code as a 2-letter postal code (NM, PR, FM, AE) or 2-digit FIPS code (35). Under another country: that country's own 2-letter subdivision code (ON with CAN)."
removedInput schema / properties / location_filter / properties / state / type
Removed value: -"string"
addedInput schema / 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"
+}
addedInput schema / properties / time_period / additionalProperties
Added value: +false
addedOutput schema / properties / applied_def_codes
Added value: +{
+ "description": "DEF codes sent, uppercased (comma-separated)",
+ "type": "string"
+}
addedOutput schema / properties / applied_location
Added value: +{
+ "description": "Place of performance location sent, as normalized (e.g. country=USA, state=NM, county=049)",
+ "type": "string"
+}
addedOutput schema / properties / applied_psc_codes
Added value: +{
+ "description": "PSC codes sent, uppercased (comma-separated)",
+ "type": "string"
+}
changedOutput schema / properties / cap / description
Previous value: -"Per-page cap (limit) applied to this page."New value: +"Per-page cap (limit) applied to this page, when truncated."
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. `pagination_limit_exceeded`: page multiplied by limit exceeds the endpoint 50,000-result page window and no cursor was supplied. `date_before_earliest`: The resolved start date precedes the 2007-10-01 earliest date this endpoint can search. `date_range_inverted`: Both ends of the date range were supplied and the start date falls after the end date. `unsupported_sort`: The sort value is not one the award type group supports. `assistance_listings_type_mismatch`: assistance_listings was given while the award type codes include contract or IDV codes, or were left at the contract default. 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. `pagination_limit_exceeded`: page multiplied by limit exceeds the endpoint 50,000-result page window and no cursor was supplied. `date_before_earliest`: The resolved start date precedes the 2007-10-01 earliest date this endpoint can search. `date_range_inverted`: Both ends of the date range were supplied and the start date falls after the end date. `unsupported_sort`: The sort value is not one the award type group supports. `assistance_listings_type_mismatch`: assistance_listings was given while the award type codes include contract or IDV codes, or were left at the contract default. `psc_codes_type_mismatch`: psc_codes was given while the award type codes include assistance codes. `invalid_location`: location_filter names an unknown US state, a county without a state or under an armed-forces code, a county or FIPS-number state under a non-USA country, or parts that place it in different states. 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",
- "pagination_limit_exceeded",
- "date_before_earliest",
- "date_range_inverted",
- "unsupported_sort",
- "assistance_listings_type_mismatch"
-]New value: +[
+ "api_unavailable",
+ "api_timeout",
+ "pagination_limit_exceeded",
+ "date_before_earliest",
+ "date_range_inverted",
+ "unsupported_sort",
+ "assistance_listings_type_mismatch",
+ "psc_codes_type_mismatch",
+ "invalid_location"
+]
changedOutput schema / properties / shown / description
Previous value: -"Number of awards returned on this page."New value: +"Number of awards returned on this page, when truncated."
changedOutput schema / properties / truncated / description
Previous value: -"True when this page was capped at `limit` and more results may remain (continue via page or the cursor)."New value: +"True when the upstream reports more results beyond this page (continue via page or the cursor). Absent on a full page the upstream marks as last, including every page past a 10,000-result offset where the upstream stops reporting continuation — has_next still says whether to request another."