addedInput schema / properties / include_idvs
Added value: +{
+ "description": "Include umbrella contracts (indefinite delivery vehicles) as a separate `idvs` array. Default true. Leave it on: these are often a recipient's largest awards, and excluding them understates a total silently.",
+ "type": "boolean"
+}
changedInput schema / properties / limit / description
Previous value: -"Number of results (1-100, default 10)"New value: +"Number of results per page (1-100, default 10)"
addedInput schema / properties / page
Added value: +{
+ "description": "1-based page number (default 1). total_results can exceed limit; page through with this and read page_metadata.has_next / total_pages to reach every row. The `idvs` array is served on page 1 only.",
+ "type": "number"
+}
changedInput schema / properties / recipient_name / description
Previous value: -"Contractor/recipient name (e.g., \"Lockheed Martin\"). Use for awards won by a company; do not put company names in keywords."New value: +"Contractor/recipient name (e.g., \"Lockheed Martin\"). Use for awards won by a company; do not put company names in keywords. Matched as a SUBSTRING of the registered legal name, so a brand name can miss the company entirely (\"SpaceX\" is not inside \"SPACE EXPLORATION TECHNOLOGIES CORP.\"); a known brand that matches nothing is retried under its legal name and the response says so in `recipient_resolution`. An empty result distinguishes `no_match` (no registered recipient has this name) from `recipient_matched_no_awards` (it does, but holds nothing under your window/agency filters) and lists the near-miss names in `recipient_candidates`."
addedOutput schema / properties / awards / items / properties / outlays_reported
Added value: +{
+ "description": "Whether the upstream published an outlay figure for this award. false means NOT REPORTED (most DoD contract awards are not linked to Treasury File C data), not that nothing was paid.",
+ "type": "boolean"
+}
changedOutput schema / properties / awards / items / properties / total_outlays / description
Previous value: -"Total amount paid out"New value: +"Total amount paid out, or null when the upstream reports none. null means not reported, not zero paid — see outlays_reported."
changedOutput schema / properties / awards / items / required
Previous value: -[
- "award_id",
- "recipient_name",
- "award_amount",
- "total_outlays",
- "start_date",
- "end_date",
- "awarding_agency",
- "awarding_sub_agency",
- "description",
- "naics_code",
- "contract_type"
-]New value: +[
+ "award_id",
+ "recipient_name",
+ "award_amount",
+ "total_outlays",
+ "start_date",
+ "end_date",
+ "awarding_agency",
+ "awarding_sub_agency",
+ "description",
+ "naics_code",
+ "contract_type",
+ "outlays_reported"
+]
addedOutput schema / properties / outlays_note
Added value: +{
+ "description": "Explains that a null total_outlays means not reported, and why DoD awards usually report none",
+ "type": "string"
+}
addedOutput schema / properties / outlays_unreported_rows
Added value: +{
+ "description": "How many rows in this response carry no outlay figure",
+ "type": "number"
+}
addedOutput schema / properties / page
Added value: +{
+ "description": "1-based page of results this response represents",
+ "type": "number"
+}
addedOutput schema / properties / page_metadata
Added value: +{
+ "description": "Where this response sits in the full result set",
+ "properties": {
+ "has_next": {
+ "description": "Whether a further page exists",
+ "type": "boolean"
+ },
+ "has_previous": {
+ "description": "Whether an earlier page exists",
+ "type": "boolean"
+ },
+ "page": {
+ "description": "1-based page number",
+ "type": "number"
+ },
+ "per_page": {
+ "description": "Rows requested per page (max 100)",
+ "type": "number"
+ },
+ "returned": {
+ "description": "Rows actually in this response",
+ "type": "number"
+ },
+ "total_pages": {
+ "description": "Total pages at this per_page, or null when no total is published",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "total_results": {
+ "description": "Total matching awards, or null when no total is published",
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "page",
+ "per_page",
+ "returned",
+ "has_next",
+ "has_previous"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / period_note
Added value: +{
+ "description": "States that the date filter selects awards ACTIVE in the window and that award_amount is a lifetime obligation, not window spending",
+ "type": "string"
+}
addedOutput schema / properties / total_results_note
Added value: +{
+ "description": "Present when no verified total is available for the query shape; says total_results is the rows in this response",
+ "type": "string"
+}
changedOutput schema / required
Previous value: -[
- "total_results",
- "limit",
- "awards"
-]New value: +[
+ "total_results",
+ "limit",
+ "awards",
+ "page",
+ "page_metadata",
+ "period_note",
+ "outlays_note",
+ "outlays_unreported_rows"
+]