{ "openapi": "3.0.1", "info": { "title": "Nyc Open Data Scraper", "description": "Easily search and extract US federal grant opportunities by keyword or ID. Track deadlines, open status, agencies, and listing numbers without logging in. Results export seamlessly to JSON, CSV, or Excel datasets on Apify.", "version": "0.0", "x-build-id": "GgLocMviWGanacZV8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bigibyte~nyc-open-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bigibyte-nyc-open-data-scraper", "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/bigibyte~nyc-open-data-scraper/runs": { "post": { "operationId": "runs-sync-bigibyte-nyc-open-data-scraper", "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/bigibyte~nyc-open-data-scraper/run-sync": { "post": { "operationId": "run-sync-bigibyte-nyc-open-data-scraper", "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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "rows", "catalog" ], "type": "string", "description": "rows reads a Socrata 4x4 on data.cityofnewyork.us. catalog searches the NYC catalog API.", "default": "rows" }, "datasetId": { "title": "Dataset id", "type": "string", "description": "Socrata 4x4 used in rows mode. erm2-nwe9 is 311 service requests. 43nn-pn8j is restaurant inspections. Ignored in catalog mode.", "default": "erm2-nwe9" }, "query": { "title": "Catalog query", "type": "string", "description": "Search text sent as q to the NYC catalog endpoint. Used only in catalog mode.", "default": "restaurant" }, "where": { "title": "SoQL where", "type": "string", "description": "Optional SoQL $where filter for rows mode. Leave empty to skip the filter. Ignored in catalog mode.", "default": "" }, "order": { "title": "SoQL order", "type": "string", "description": "SoQL $order for rows mode. Default is :id. Leave empty to omit $order. Ignored in catalog mode.", "default": ":id" }, "appToken": { "title": "Socrata app token", "type": "string", "description": "Optional Socrata application token sent as the X-App-Token header. Leave empty for the public shared pool. The token is not written into rows or source URLs." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum result rows to save this run. Hard cap is 1000.", "default": 100 }, "timeoutSecs": { "title": "Run timeout (seconds)", "minimum": 1, "maximum": 3600, "type": "integer", "description": "Stop the run after this many seconds. Default is 300. Maximum is 3600.", "default": 300 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 1, "maximum": 120, "type": "integer", "description": "How long to wait for one HTTP response before retrying. Default is 30 seconds.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy for requests. Default is no proxy. Leave it off so calls stay on the public Socrata pool.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }