Federal Spending Forensic API icon

Federal Spending Forensic API

Forensic federal spending intelligence - Uncover the $195B USASpending blind spot

Actions9

Set-Aside Scanner

AI-generated

Summary

Initiate actor run to scan set-aside contracts, returning small-business opportunities with optional filtering and forensic analysis.

Inputs

  • agency — Filter by federal agency; default 'all'. If specified and not 'all', passed to actor as 'agency'.
  • fiscalYear — Federal fiscal year (October 1 – September 30); default 2024, valid range 2015–2026. Passed to actor if operation is setAside.
  • keywords — Search keywords (comma-separated); default ''. Passed to actor if operation is setAside and non-empty.
  • naicsCode — North American Industry Classification Code (e.g., 541512); default ''. Passed to actor if operation is setAside and non-empty.
  • maxResults — Maximum number of results to return; default 50, min 1, max 500. Passed to actor.
  • setAsideType — Filter by small business program; default 'all'. Options: all, 8a, hubzone, sdvosb, wosb, edwosb, small_business, sdb. If not 'all', passed to actor as 'setAsideType'.
  • waitForCompletion — Whether to wait for extraction to complete; default true. If false, returns immediately with runId and status 'RUNNING'.
  • advancedOptions — Collection of advanced filtering and behavioral options. Supported keys: recipientName, recipientState, placeOfPerformanceState, pscCode, enableForensicFlags (default true), traceSubAwards (default false), timeout (default 300 seconds).

Output shape

When waitForCompletion is true: returns array of items, each containing the actor's dataset result json merged with metadata { _operation, _runId, _datasetId }. When waitForCompletion is false: returns single item { success: true, status: 'RUNNING', runId, datasetId, operation, message: 'Extraction started. Use

Get Run Status to check progress.' }.

Examples

Example 1: Default call with waitForCompletion=true

Agency defaults to 'all', fiscalYear 2024, maxResults 50, setAsideType 'all', waitForCompletion true. Actor returns up to 50 set-aside contract results with forensic flags enabled.

Example 2: Targeted scan with waitForCompletion=false

Agency 'Department of Defense', fiscalYear 2023, setAsideType '8a', waitForCompletion false. Actor run starts immediately; workflow author can subsequently use the 'Get Run Status' operation with the returned runId.

Links

Discussion