Provenance
Freshness & coverage
Methods (8)
searchAwards
readFederal awards search. Filter timePeriod, awardTypeGroup, recipient, NAICS, agency, place.
Input schema
{ "type": "object", "properties": { "timePeriod": { "type": "object", "properties": { "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "required": [ "start_date", "end_date" ], "additionalProperties": false }, "awardTypeGroup": { "type": "string", "examples": [ "contracts" ], "oneOf": [ { "type": "string", "enum": [ "contracts" ] }, { "type": "string", "enum": [ "idvs" ] }, { "type": "string", "enum": [ "grants" ] }, { "type": "string", "enum": [ "loans" ] }, { "type": "string", "enum": [ "direct_payments" ] }, { "type": "string", "enum": [ "other_financial_assistance" ] } ] }, "awardTypeCodes": { "type": "array", "items": { "type": "string" } }, "recipientSearchText": { "type": "string" }, "naicsCodes": { "type": "array", "items": { "type": "string" } }, "agencyCodes": { "type": "array", "items": { "type": "string" } }, "placeOfPerformanceLocations": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "city": { "type": "string" }, "district_original": { "type": "string" }, "district_current": { "type": "string" }, "zip": { "type": "string" } }, "additionalProperties": false } }, "keywords": { "type": "array", "items": { "type": "string" } }, "sortField": { "type": "string" }, "order": { "oneOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "page": { "type": "number" }, "limit": { "type": "number" } }, "additionalProperties": false, "required": [ "timePeriod" ] }awardTypeGroup must be a single group; mixed groups return 422.
getAwardById
readFull award record by generated_internal_id (agency, period of performance, exec comp).
Input schema
{ "type": "object", "properties": { "awardId": { "type": "string", "examples": [ "CONT_AWD_W519TC22FA001_9700_-NONE-_-NONE-" ] } }, "additionalProperties": false, "required": [ "awardId" ] }Pass generated_internal_id verbatim from a searchAwards result.
searchByRecipient
readRecipient-name fuzzy convenience wrapper (uses recipient_search_text under the hood).
Input schema
{ "type": "object", "properties": { "recipientName": { "type": "string", "examples": [ "HALLIBURTON" ] }, "awardTypeGroup": { "oneOf": [ { "type": "string", "enum": [ "contracts" ] }, { "type": "string", "enum": [ "idvs" ] }, { "type": "string", "enum": [ "grants" ] }, { "type": "string", "enum": [ "loans" ] }, { "type": "string", "enum": [ "direct_payments" ] }, { "type": "string", "enum": [ "other_financial_assistance" ] } ] }, "timePeriod": { "type": "object", "properties": { "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "required": [ "start_date", "end_date" ], "additionalProperties": false }, "page": { "type": "number" }, "limit": { "type": "number" } }, "additionalProperties": false, "required": [ "recipientName" ] }Defaults to contracts + past 5 fiscal years if timePeriod omitted.
searchByNaics
readNAICS slicing wrapper. Oil-services use 21 / 2111 / 2131 / 213111 / 213112.
Input schema
{ "type": "object", "properties": { "naicsCode": { "type": "string", "examples": [ "213112" ] }, "awardTypeGroup": { "oneOf": [ { "type": "string", "enum": [ "contracts" ] }, { "type": "string", "enum": [ "idvs" ] }, { "type": "string", "enum": [ "grants" ] }, { "type": "string", "enum": [ "loans" ] }, { "type": "string", "enum": [ "direct_payments" ] }, { "type": "string", "enum": [ "other_financial_assistance" ] } ] }, "timePeriod": { "type": "object", "properties": { "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "required": [ "start_date", "end_date" ], "additionalProperties": false }, "page": { "type": "number" }, "limit": { "type": "number" } }, "additionalProperties": false, "required": [ "naicsCode" ] }Accepts 2- to 6-digit prefixes; pass highest specificity available.
searchByAgency
readAwards filtered by awarding agency toptier_code (089 DOE, 097 DoD, 014 Interior).
Input schema
{ "type": "object", "properties": { "agencyCode": { "type": "string", "examples": [ "089" ] }, "awardTypeGroup": { "oneOf": [ { "type": "string", "enum": [ "contracts" ] }, { "type": "string", "enum": [ "idvs" ] }, { "type": "string", "enum": [ "grants" ] }, { "type": "string", "enum": [ "loans" ] }, { "type": "string", "enum": [ "direct_payments" ] }, { "type": "string", "enum": [ "other_financial_assistance" ] } ] }, "timePeriod": { "type": "object", "properties": { "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "required": [ "start_date", "end_date" ], "additionalProperties": false }, "page": { "type": "number" }, "limit": { "type": "number" } }, "additionalProperties": false, "required": [ "agencyCode" ] }getRecipientById
readRecipient profile by hash. -C (child) / -P (parent) / -R (standalone) suffix.
Input schema
{ "type": "object", "properties": { "recipientHash": { "type": "string", "examples": [ "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-P" ] } }, "additionalProperties": false, "required": [ "recipientHash" ] }Pass hash verbatim; bare hash (no suffix) is rejected upstream.
autocompleteRecipient
unknownFuzzy name -> recipient hit list (use to discover recipient hashes).
Input schema
{ "type": "object", "properties": { "searchText": { "type": "string", "examples": [ "EXXON" ] }, "limit": { "type": "number" } }, "additionalProperties": false, "required": [ "searchText" ] }getServiceInfo
readAward type taxonomy, agency (toptier_code) reference, NAICS reference, pagination caps.
Input schema
{ "type": "object", "properties": {}, "additionalProperties": false }
