Raw schema
{
"type": "object",
"properties": {
"group_by": {
"type": "string",
"enum": [
"agency",
"sub_tier",
"office",
"naics",
"psc",
"set_aside",
"notice_type",
"place_of_performance_state",
"office_state",
"posted_month"
],
"description": "Field to group counts by."
},
"keywords": {
"type": "string",
"maxLength": 300,
"description": "Words that must all appear in the title or full description. Put exact phrases in double quotes, e.g. zero trust \"cloud migration\". Word endings are matched loosely (bridge matches bridges)."
},
"notice_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Solicitation",
"Combined Synopsis/Solicitation",
"Presolicitation",
"Sources Sought",
"Special Notice",
"Award Notice",
"Justification",
"Justification and Approval (J&A)",
"Modification/Amendment/Cancel",
"Consolidate/(Substantially) Bundle",
"Sale of Surplus Property"
]
},
"description": "Current notice types to include. Omit for all types."
},
"naics_codes": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "NAICS codes or prefixes (2 to 6 digits); a prefix such as 5415 matches every code under it."
},
"psc_codes": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Product and service codes or prefixes, e.g. D3 or R425."
},
"set_aside_codes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"SBA",
"SBP",
"8A",
"8AN",
"HZC",
"HZS",
"SDVOSBC",
"SDVOSBS",
"WOSB",
"WOSBSS",
"EDWOSB",
"EDWOSBSS",
"VSA",
"VSS",
"ISBEE",
"IEE",
"BICiv",
"LAS",
"ESB",
"NONE"
]
},
"description": "SAM.gov set-aside codes, e.g. SBA (total small business), 8A, SDVOSBC, WOSB, HZC. NONE means the notice says no set-aside was used."
},
"agency": {
"type": "string",
"maxLength": 200,
"description": "Text matched against the department, sub-tier, and office names, e.g. Army, Veterans Affairs, NSWC Dahlgren. Field activities post under their own office names, so a command name matches only its headquarters office (NAVSEA matches NAVSEA HQ, not NSWC or NUWC offices)."
},
"place_of_performance_state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter state code for the place of performance. Most notices leave the place of performance blank, so results also report how many more notices have a contracting office in that state (see office_state)."
},
"office_state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter state code of the contracting office. Filled in on nearly every notice, but an office's state is not always where the work happens."
},
"solicitation_number": {
"type": "string",
"maxLength": 100,
"description": "Exact solicitation number."
},
"posted_from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Earliest posted date, YYYY-MM-DD."
},
"posted_to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Latest posted date, YYYY-MM-DD."
},
"deadline_from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Earliest response deadline date, YYYY-MM-DD, in the deadline's own time zone."
},
"deadline_to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Latest response deadline date, YYYY-MM-DD."
},
"include_past_deadlines": {
"type": "boolean",
"default": false,
"description": "Include notices whose response deadline has already passed. SAM.gov keeps notices active for a while after the deadline; by default they are left out. Award notices and justifications are always included, even when they list a past deadline, and so are notices with no deadline."
},
"include_earlier_versions": {
"type": "boolean",
"default": false,
"description": "Include earlier versions of amended notices. SAM.gov's file lists every version of a notice as its own row; by default only the latest version of each is included."
},
"top": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25,
"description": "Number of groups to return, largest first. For posted_month, the most recent months, in month order."
}
},
"required": [
"group_by"
],
"additionalProperties": false
}