{ "openapi": "3.0.1", "info": { "title": "US Immigrant Visa Interview Scheduling Monitor (NVC)", "description": "Returns which month of documentarily complete immigrant visa cases NVC is scheduling at each US consulate, a verdict for your DQ date, and monitor alerts when it moves. Inputs: post names, category, DQ date, monitorMode. Agent-ready: pay per event (x402 and MCP), no charge for unmatched posts.", "version": "0.1", "x-build-id": "fG5LUjNhBYcZPX3VO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nerolabs~us-immigrant-visa-scheduling-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nerolabs-us-immigrant-visa-scheduling-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~us-immigrant-visa-scheduling-monitor/runs": { "post": { "operationId": "runs-sync-nerolabs-us-immigrant-visa-scheduling-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~us-immigrant-visa-scheduling-monitor/run-sync": { "post": { "operationId": "run-sync-nerolabs-us-immigrant-visa-scheduling-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": { "posts": { "title": "Embassies / consulates to check", "type": "array", "description": "City names as they appear on the State Department tool, one per line, for example Ciudad Juarez, Manila, Mumbai, Guangzhou, Ho Chi Minh City. Partial names work when unambiguous. Turn on listAvailablePosts below to see all 140+ valid names.", "items": { "type": "string" } }, "category": { "title": "Immigrant visa category", "enum": [ "all", "immediateRelative", "familyPreference", "employment" ], "type": "string", "description": "Which column to report and (in monitor mode) watch. immediateRelative = spouse, child or parent of a US citizen. familyPreference = F1 to F4. employment = EB-1 to EB-5. all = every column.", "default": "all" }, "documentarilyCompleteDate": { "title": "Your documentarily complete date (optional)", "type": "string", "description": "The date NVC told you your case became documentarily complete (DQ), in YYYY-MM-DD or YYYY-MM. When supplied, each post gets a plain-English verdict: has NVC reached your month for your category yet, and if not, by how many months is it behind. Pick a single category above for the clearest answer." }, "monitorMode": { "title": "Monitor mode: only report what moved", "type": "boolean", "description": "Compare each post against the months seen on the previous run and report only real movement: NVC advanced or moved back (with the number of months), or a category's month appeared or disappeared. The State Department updates the tool monthly, so a weekly schedule catches each update promptly. 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" }, "listAvailablePosts": { "title": "Reference mode: list every post name", "type": "boolean", "description": "Turn this on to get the full list of embassy/consulate names on the tool and the category keys. This mode is never charged.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "travel.state.gov 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 } } } } } } } } } }