{ "openapi": "3.0.1", "info": { "title": "USCIS Processing Time Monitor", "description": "Look up and monitor official USCIS case processing times for any form, category and office, and get USCIS's own answer on whether a case is outside normal processing time yet so an inquiry can be filed.", "version": "0.1", "x-build-id": "xdqi4HCxmVUa7aNyQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nerolabs~uscis-processing-time-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nerolabs-uscis-processing-time-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/nerolabs~uscis-processing-time-monitor/runs": { "post": { "operationId": "runs-sync-nerolabs-uscis-processing-time-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/nerolabs~uscis-processing-time-monitor/run-sync": { "post": { "operationId": "run-sync-nerolabs-uscis-processing-time-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": { "listAvailableOptions": { "title": "Reference mode: list valid form, category and office codes", "type": "boolean", "description": "Turn this on to get the codes the other modes need. On its own it lists all 44 USCIS forms with their category codes. Combine it with a Form number below to also get that form's office codes. This mode is never charged.", "default": false }, "formName": { "title": "Form number", "type": "string", "description": "USCIS form number exactly as published, for example I-130, N-400, I-485, I-765. Use reference mode above to see the full list." }, "formCategory": { "title": "Form category code", "type": "string", "description": "The category (subtype) code for the form, for example 134A-IR for a U.S. citizen filing for a spouse, parent or child under 21. These codes are not guessable, use reference mode to find the right one." }, "officeCode": { "title": "Office code", "type": "string", "description": "The processing office code, for example SCD (Service Center Operations), NBC (National Benefits Center), FOD (All Field Offices), or a specific field office such as NYC. Use reference mode to find valid codes for your form." }, "receiptDate": { "title": "Case receipt date (optional)", "type": "string", "description": "The receipt date printed on the USCIS receipt notice, in YYYY-MM-DD format. When supplied, the result also includes USCIS's own answer on whether this case is outside normal processing time and a case inquiry can be submitted now, or the exact date from which it can. Leave empty for a plain processing-time lookup." }, "targets": { "title": "Multiple combinations to check", "type": "array", "description": "Check many form/category/office combinations in one run. Each entry takes formName, formCategory and officeCode, plus an optional label and an optional receiptDate (YYYY-MM-DD). Cheaper and faster than one run per case, because the browser session is shared across all of them." }, "monitorMode": { "title": "Monitor mode: only report what changed", "type": "boolean", "description": "Compare each combination against the figures seen on the previous run and report only real movement: the processing-time range moving, the inquiry-eligibility date shifting, a figure being suppressed or published again, or a tracked case becoming eligible for an inquiry. Schedule this monthly, USCIS republishes monthly. The first run records a baseline.", "default": false }, "watchlistId": { "title": "Watchlist ID", "type": "string", "description": "Keeps separate monitor histories apart. Use a different ID per client list or per schedule so their baselines don't overwrite each other.", "default": "default" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "USCIS sits behind Cloudflare. The default (US residential) is the setting confirmed to work; change it only if you have a reason to.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } }, "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 } } } } } } } } } }