{ "openapi": "3.0.1", "info": { "title": "USAspending Federal Contract Awards Monitor (No API Key)", "description": "Search and monitor US federal contract awards from the official USAspending API: who won what, for how much, from which agency. Filter by NAICS, PSC, agency, state and amount, with new-award alerts for $0.004/award.", "version": "0.1", "x-build-id": "CaW2DXzZZXfF4coCD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lukehunter~usaspending-federal-awards-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lukehunter-usaspending-federal-awards-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/lukehunter~usaspending-federal-awards-monitor/runs": { "post": { "operationId": "runs-sync-lukehunter-usaspending-federal-awards-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/lukehunter~usaspending-federal-awards-monitor/run-sync": { "post": { "operationId": "run-sync-lukehunter-usaspending-federal-awards-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "Search the award description text, matching at least one of these words or phrases, e.g. [\"cloud migration\", \"cybersecurity\", \"zero trust\"]. Each needs 3 or more characters. Up to 20. Leave empty to keep every award that passes the other filters.", "items": { "type": "string" } }, "naicsCodes": { "title": "NAICS codes", "type": "array", "description": "Only contract awards classified under these NAICS industry codes: 2, 4 or 6 digits, e.g. [\"541512\"] (computer systems design) or [\"5415\", \"518210\"]. USAspending rejects 3 and 5 digit codes, so those stop the run with an error. Contracts only. Leave empty for any industry.", "items": { "type": "string" } }, "pscCodes": { "title": "PSC codes", "type": "array", "description": "Only contract awards with these Product and Service Codes: 1 to 4 letters or digits, e.g. [\"D302\"] (IT systems development), [\"R\"] (professional services) or [\"7A20\"]. Contracts only. An invalid code stops the run with an error. Leave empty for any product or service.", "items": { "type": "string" } }, "agencies": { "title": "Awarding agencies", "type": "array", "description": "Only awards made by these top-tier federal agencies, by exact name or common acronym, e.g. [\"Department of Homeland Security\"] or [\"DHS\", \"VA\", \"GSA\", \"NASA\"]. Other names are sent exactly as typed and match nothing if misspelled. Leave empty for every agency.", "items": { "type": "string" } }, "recipientName": { "title": "Recipient (winner) name", "type": "string", "description": "Only awards whose recipient name contains this text, e.g. Booz Allen or Lockheed Martin. At least 3 characters. Matched by USAspending against the registered business name. Leave empty for any recipient." }, "states": { "title": "Place of performance (US states)", "type": "array", "description": "Only awards performed in these US states or territories, as two-letter codes, e.g. [\"VA\", \"TX\", \"DC\"]. An unknown code stops the run with an error. Leave empty for the whole country.", "items": { "type": "string" } }, "minAmount": { "title": "Minimum award amount (USD)", "minimum": 0, "type": "integer", "description": "Keep awards worth at least this many US dollars, e.g. 1000000 for $1M and up. Leave empty for no lower bound." }, "maxAmount": { "title": "Maximum award amount (USD)", "minimum": 0, "type": "integer", "description": "Keep awards worth at most this many US dollars, e.g. 10000000. Leave empty for no upper bound." }, "awardTypes": { "title": "Award types", "type": "array", "description": "Which awards to return, e.g. [\"contracts\"]. contracts = federal procurement contracts, purchase orders and delivery orders (default); grants = federal grant awards. NAICS and PSC codes cannot be combined with grants.", "items": { "type": "string", "enum": [ "contracts", "grants" ] }, "default": [ "contracts" ] }, "awardedWithinDays": { "title": "Awarded within days", "minimum": 1, "maximum": 366, "type": "integer", "description": "Only awards first signed in the last N days including today, 1 to 366, e.g. 30 for the last month. Ignored when Date from is set. Federal agencies, DoD especially, can report awards late, so very recent windows may fill in over time.", "default": 30 }, "dateFrom": { "title": "Date from (optional date range)", "type": "string", "description": "First day of an explicit award range, written YYYY-MM-DD, e.g. 2026-09-01. Use with Date to (defaults to today). The range may not exceed 366 days; a longer one stops the run with an error. Overrides Awarded within days." }, "dateTo": { "title": "Date to (optional date range)", "type": "string", "description": "Last day of an explicit award range, written YYYY-MM-DD, e.g. 2026-09-30. Needs Date from. Leave empty to include everything up to today." }, "maxItems": { "title": "Maximum awards", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on delivered awards, newest first, 1 to 5000, e.g. 50. At $0.004 per delivered award this caps the result charge for the run (50 awards = $0.20). Awards beyond the cap are not charged.", "default": 50 }, "onlyNewSinceLastRun": { "title": "Alerts: only new since last run", "type": "boolean", "description": "Deliver and charge only awards not delivered before for this same set of filters, e.g. on a daily Schedule. The first run creates the baseline and delivers what currently matches. Pair with a Discord, Slack or Telegram destination below.", "default": false }, "stateStoreName": { "title": "Alerts: state store name", "type": "string", "description": "Named key-value store that remembers delivered awards between runs, used only when alerts are on. Example: my-it-awards. Use a different name to keep separate histories. Letters, numbers and hyphens only.", "default": "usaspending-federal-awards-monitor-seen-awards" }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Post results to a Discord channel. In Discord: Server Settings -> Integrations -> Webhooks -> New Webhook -> choose the channel -> Copy Webhook URL. Example: https://discord.com/api/webhooks//. Leave empty to skip Discord." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Post results to Telegram. Create a bot by chatting with @BotFather on Telegram (send /newbot) and paste the token it gives you, e.g. 123456789:AA.... Needs \"Telegram chat ID\" below. Leave empty to skip Telegram." }, "telegramChatId": { "title": "Telegram chat ID", "type": "string", "description": "Where the bot should post: a numeric chat id (e.g. 123456789, or -1001234567890 for a group or channel) or a public @channelusername. The bot must be added to that chat or channel first (as an administrator for a channel), and for a private chat you must press Start on the bot. Needs \"Telegram bot token\" above." }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Post results to a Slack channel (Block Kit cards, up to 10 per message). Create an incoming webhook at api.slack.com/apps -> Create New App -> Incoming Webhooks -> Add New Webhook to Workspace. Example: https://hooks.slack.com/services/T000/B000/XXXX. Leave empty to skip Slack." }, "slackCompatibleWebhookUrl": { "title": "Slack-compatible webhook URL (Mattermost, Rocket.Chat)", "type": "string", "description": "Post results to a Mattermost or Rocket.Chat incoming webhook, which accept Slack-style webhook payloads. Must be a public https:// address, e.g. https://chat.example.com/hooks/abc123 (no localhost, private IP or .local/.internal hosts). These apps do not render Slack Block Kit, so they get a plain Markdown list. For real Slack use \"Slack webhook URL\" above. Leave empty to skip." }, "teamsWebhookUrl": { "title": "Microsoft Teams webhook URL (Workflows)", "type": "string", "description": "Post results to a Teams channel as an Adaptive Card. In Teams: channel -> ... -> Workflows -> \"Post to a channel when a webhook request is received\" -> copy the URL. The host must end in .logic.azure.com or .powerplatform.com, e.g. https://prod-12.westeurope.logic.azure.com/workflows/... The retired Office 365 connector webhooks are not supported. Leave empty to skip Teams." }, "googleChatWebhookUrl": { "title": "Google Chat webhook URL", "type": "string", "description": "Post results to a Google Chat space. In the space: Apps & integrations -> Webhooks -> Add webhook -> copy the URL. Example: https://chat.googleapis.com/v1/spaces//messages?key=...&token=.... Leave empty to skip Google Chat." }, "ntfyTopic": { "title": "ntfy topic", "type": "string", "description": "Get a phone push with no account via ntfy (ntfy.sh). Install the ntfy app, subscribe to a topic name, and enter the same name here. Anyone who knows the topic can read it, so pick a long, unguessable name (letters, numbers, - and _), e.g. acme-leads-7k2x9q. At most 10 individual pushes per run, then one \"...and N more\". Leave empty to skip ntfy." }, "ntfyServer": { "title": "ntfy server", "type": "string", "description": "Only used with \"ntfy topic\". Leave as https://ntfy.sh, or enter the public https:// address of your own ntfy server, e.g. https://ntfy.example.com.", "default": "https://ntfy.sh" }, "ntfyToken": { "title": "ntfy access token (optional)", "type": "string", "description": "Only used with \"ntfy topic\", for a self-hosted server or a reserved topic that needs a login. An access token from ntfy (starts with tk_, e.g. tk_abc123...). Leave empty for open topics." }, "pushoverUserKey": { "title": "Pushover user key", "type": "string", "description": "Get a phone push via Pushover. Your user key (30 characters, e.g. uQiRzpo4DXghDmr9QzzfQu27cmVRsG) is shown on the Pushover dashboard (pushover.net). Needs \"Pushover app token\" below. At most 10 individual pushes per run, then one \"...and N more\". Leave empty to skip Pushover." }, "pushoverAppToken": { "title": "Pushover app token", "type": "string", "description": "The API token of a Pushover application you create at pushover.net/apps/build (name it after this Actor), e.g. azGDORePK8gMaC0QOYAMyEEuzJnyUi. Needs \"Pushover user key\" above." }, "webhookUrl": { "title": "Generic JSON webhook URL (Zapier, Make, n8n, Pipedream, IFTTT, Home Assistant)", "type": "string", "description": "POST the delivered rows as JSON to any public https:// URL: {source, actor, runId, count, items}. At most 100 rows per POST; every delivered row is sent regardless of the max-notifications cap. For example, route results to email, a spreadsheet or any app. Localhost, private IP and .local/.internal addresses are rejected. Leave empty to skip." }, "maxNotifications": { "title": "Max notifications per run", "minimum": 1, "maximum": 100, "type": "integer", "description": "Caps how many results are sent to chat and phone channels per run (Discord, Telegram, Slack, Teams, Google Chat, ntfy, Pushover), 1-100, default 25 (e.g. 10). Extra results are still in the dataset. The generic webhook is not capped. Only used when a destination above is set.", "default": 25 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }