# NYC Open Data Dataset Search (`scrupulous_waterbird_m4w/nyc-open-data`) Actor Search NYC Open Data and Socrata datasets including 311 requests, restaurant inspections, building permits, and the public catalog. Export normalized records with SoQL filters and pagination. - **URL**: https://apify.com/scrupulous\_waterbird\_m4w/nyc-open-data.md - **Developed by:** [Mori](https://apify.com/scrupulous_waterbird_m4w) (community) - **Categories:** Business, Developer tools, Other - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## NYC Open Data Dataset Search Search and export records from NYC Open Data / Socrata public datasets including 311 requests, restaurant inspections, and building permits. No auth, no proxy.. ### What it does - Extracts ITEM_TYPE from URL_LIST - Outputs structured JSON (SCHEMA_LINK) - Handles pagination, retries, proxy rotation out of the box ### Input | Field | Required | Description | |---|---|---| | `startUrls` | yes | List of URLs to scrape | | `maxRequestsPerRun` | no | Cap on total requests (default 100) | | `proxyConfiguration` | no | Proxy settings (default: Apify Proxy) | ### Output One record per source page: ```json { "url": "...", "title": "...", "items": [...], "scrapedAt": "ISO-8601" } ```` ### Pricing Free tier: 100 runs/month. Pro: $X/mo. ### Limitations - Static HTML only (no JS rendering — use the playwright template for SPAs). - Single-domain by default. Set `enqueueLinks` globs to crawl. ### Changelog - 0.1.0 — initial release. # Actor input Schema ## `dataset` (type: `string`): Which NYC Open Data dataset to query. '311' = 311 Service Requests (erm2-nwe9), 'restaurants' = DOHMH Restaurant Inspections (43nn-pn8j), 'building\_permits' = DOB Building Permits (ipu4-2q9a), 'catalog\_search' = Socrata catalog search across all data.cityofnewyork.us datasets, 'custom' = any Socrata resource id you provide via customResourceId. ## `customResourceId` (type: `string`): Only used when dataset='custom'. Provide the 9-character Socrata resource id (e.g. erm2-nwe9). Found in the dataset URL on data.cityofnewyork.us. ## `query` (type: `string`): Free-text search. For 'catalog\_search' this maps to the Socrata catalog q= parameter. For row datasets (311, restaurants, building\_permits, custom) this maps to the SoQL $q= full-text parameter. ## `where` (type: `string`): Optional SoQL WHERE expression (e.g. "borough='BROOKLYN'"). Only used for row datasets. Leave empty for no filter. See https://dev.socrata.com/docs/queries/ for syntax. ## `maxItems` (type: `integer`): Cap on total records exported. Socrata caps $limit at 50,000 per request; this actor walks pages until maxItems is reached. ## Actor input object example ```json { "dataset": "311", "customResourceId": "erm2-nwe9", "query": "noise", "where": "", "maxItems": 50 } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("scrupulous_waterbird_m4w/nyc-open-data").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("scrupulous_waterbird_m4w/nyc-open-data").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call scrupulous_waterbird_m4w/nyc-open-data --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=scrupulous_waterbird_m4w/nyc-open-data", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "NYC Open Data Dataset Search", "description": "Search NYC Open Data and Socrata datasets including 311 requests, restaurant inspections, building permits, and the public catalog. Export normalized records with SoQL filters and pagination.", "version": "0.0", "x-build-id": "ZLcgO4oXkvVmGHevN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrupulous_waterbird_m4w~nyc-open-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrupulous_waterbird_m4w-nyc-open-data", "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/scrupulous_waterbird_m4w~nyc-open-data/runs": { "post": { "operationId": "runs-sync-scrupulous_waterbird_m4w-nyc-open-data", "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/scrupulous_waterbird_m4w~nyc-open-data/run-sync": { "post": { "operationId": "run-sync-scrupulous_waterbird_m4w-nyc-open-data", "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": [ "dataset" ], "properties": { "dataset": { "title": "Dataset", "enum": [ "311", "restaurants", "building_permits", "catalog_search", "custom" ], "type": "string", "description": "Which NYC Open Data dataset to query. '311' = 311 Service Requests (erm2-nwe9), 'restaurants' = DOHMH Restaurant Inspections (43nn-pn8j), 'building_permits' = DOB Building Permits (ipu4-2q9a), 'catalog_search' = Socrata catalog search across all data.cityofnewyork.us datasets, 'custom' = any Socrata resource id you provide via customResourceId.", "default": "311" }, "customResourceId": { "title": "Custom Socrata resource id (4x4 like)", "type": "string", "description": "Only used when dataset='custom'. Provide the 9-character Socrata resource id (e.g. erm2-nwe9). Found in the dataset URL on data.cityofnewyork.us.", "default": "erm2-nwe9" }, "query": { "title": "Search query", "type": "string", "description": "Free-text search. For 'catalog_search' this maps to the Socrata catalog q= parameter. For row datasets (311, restaurants, building_permits, custom) this maps to the SoQL $q= full-text parameter.", "default": "noise" }, "where": { "title": "SoQL $where clause", "type": "string", "description": "Optional SoQL WHERE expression (e.g. \"borough='BROOKLYN'\"). Only used for row datasets. Leave empty for no filter. See https://dev.socrata.com/docs/queries/ for syntax.", "default": "" }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on total records exported. Socrata caps $limit at 50,000 per request; this actor walks pages until maxItems is reached.", "default": 50 } } }, "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 } } } } } } } } } } ```