{ "openapi": "3.0.1", "info": { "title": "NOLA Occupational License Portfolio Status Monitor", "description": "Watch named City of New Orleans occupational business license numstring values; emit APPEARED/DROPPED/STATUS_CHANGED from official Socrata abc4-h3u3. Portfolio PPE only — not a citywide dump; not Calgary/Montgomery/NYC DOB/DCWP twin; not STR lead scraper.", "version": "0.1", "x-build-id": "qXNpfyrJzwEX0q94B" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plym-actor-factory~us-la-nola-occupational-numstring-portfolio-status-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plym-actor-factory-us-la-nola-occupational-numstring-portfolio-status-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/plym-actor-factory~us-la-nola-occupational-numstring-portfolio-status-monitor/runs": { "post": { "operationId": "runs-sync-plym-actor-factory-us-la-nola-occupational-numstring-portfolio-status-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/plym-actor-factory~us-la-nola-occupational-numstring-portfolio-status-monitor/run-sync": { "post": { "operationId": "run-sync-plym-actor-factory-us-la-nola-occupational-numstring-portfolio-status-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": { "licenseNumbers": { "title": "NOLA occupational numstring values (watchlist)", "type": "array", "description": "City of New Orleans Occupational Business License numbers (numstring) to monitor against official Socrata abc4-h3u3. Exact match after normalize (digits). Invalid entries skipped with no charge. Not a citywide dump — only IDs on the book are evaluated.", "default": [ "2414505", "1808379", "1923812", "1922457" ], "items": { "type": "string" } }, "licenses": { "title": "Licenses (alias)", "type": "array", "description": "Alias of licenseNumbers.", "items": { "type": "string" } }, "licenseNos": { "title": "License nos (alias)", "type": "array", "description": "Alias of licenseNumbers.", "items": { "type": "string" } }, "signalGroups": { "title": "Signal groups", "type": "array", "description": "directory = APPEARED/DROPPED; status = STATUS_CHANGED; attributes = business type / category / address / description changes.", "default": [ "directory", "status" ], "items": { "type": "string" } }, "maxRunSeconds": { "title": "Max run seconds", "minimum": 5, "maximum": 900, "type": "integer", "description": "Hard run budget in seconds.", "default": 180 }, "maxEvents": { "title": "Max delivered change events", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Max billable change events to deliver this run.", "default": 500 }, "resumeFromCheckpoint": { "title": "Resume from stored checkpoint", "type": "boolean", "description": "Resume entity baselines and seen event UIDs from the actor key-value store.", "default": true }, "sourceMode": { "title": "Source mode", "enum": [ "fixture", "live" ], "type": "string", "description": "fixture = offline fixtures (FIXTURE_HEALTH / demo). live = official City of New Orleans Open Data Socrata.", "default": "fixture" }, "emitFixtureDemoEvents": { "title": "Emit fixture demo change events", "type": "boolean", "description": "When sourceMode=fixture, emit CATCHUP APPEARED/DROPPED/STATUS_CHANGED demo events (charges in cloud).", "default": false }, "asOfHint": { "title": "as_of hint (YYYY-MM-DD)", "type": "string", "description": "Optional as-of date hint (YYYY-MM-DD) for live runs." }, "maxTotalChargeUsd": { "title": "Max total charge (USD)", "minimum": 0, "type": "number", "description": "Optional Apify platform max total charge USD for this run." }, "socrataUrl": { "title": "Socrata resource URL override", "type": "string", "description": "Override official City of New Orleans Occupational Business License Socrata resource URL (default data.nola.gov/resource/abc4-h3u3.json).", "default": "https://data.nola.gov/resource/abc4-h3u3.json" }, "numstrings": { "title": "Numstrings (alias)", "type": "array", "description": "Alias of licenseNumbers.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }