{ "openapi": "3.0.1", "info": { "title": "Philly311 Service Requests - City Service & Response Data", "description": "Philly311 service requests (public open data, 5.9M requests, 2014-today): service type and code, responsible agency, request, update and close timestamps, expected completion, status note, plus address, ZIP and geocode where supplied.", "version": "0.0", "x-build-id": "Tk8Hhp3prXEMVqejN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~philly-311/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-philly-311", "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/j0401~philly-311/runs": { "post": { "operationId": "runs-sync-j0401-philly-311", "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/j0401~philly-311/run-sync": { "post": { "operationId": "run-sync-j0401-philly-311", "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": { "service": { "title": "Service name (contains)", "type": "string", "description": "Substring match on the service name, e.g. 'Street Defect' (potholes), 'Graffiti Removal', 'Street Light Outage'. Blank = any.", "default": "" }, "serviceType": { "title": "Service type (contains)", "type": "string", "description": "Substring match on the service type. 140 types exist, e.g. 'Pothole Repair', 'Rubbish Collection'. Blank = any.", "default": "" }, "agency": { "title": "Responsible agency (contains)", "type": "string", "description": "Substring match on the agency responsible, e.g. 'Streets', 'Police', 'Licenses'. Blank = any.", "default": "" }, "address": { "title": "Address (contains)", "type": "string", "description": "Substring match on the reported address. Present on 46% of requests - a query using this is answering over the geolocated subset. Blank = any.", "default": "" }, "zip": { "title": "ZIP (prefix)", "type": "string", "description": "ZIP or ZIP prefix. Present on 43% of requests. Blank = any.", "default": "" }, "serviceCode": { "title": "Service code (contains)", "type": "string", "description": "Substring match on the service code, e.g. 'SR-IR01'. Blank = any.", "default": "" }, "statusNote": { "title": "Status note (contains)", "type": "string", "description": "Substring match on the free-text status note, e.g. 'Answered', 'Inspected'. Blank = any.", "default": "" }, "status": { "title": "Status", "enum": [ "", "Closed", "Open" ], "type": "string", "description": "Request status. 'Closed' 5,844,270 / 'Open' 97,889. Blank = any.", "default": "" }, "requestedFrom": { "title": "Requested date from", "type": "string", "description": "Earliest request date, YYYY-MM-DD. Blank = any.", "default": "" }, "requestedTo": { "title": "Requested date to", "type": "string", "description": "Latest request date, YYYY-MM-DD. Blank = any.", "default": "" }, "recentDays": { "title": "Requested within the last N days", "minimum": 0, "type": "integer", "description": "Only requests filed in the last N days. Ignored when 'Requested date from' is set. 0 = off.", "default": 0 }, "mode": { "title": "Mode", "enum": [ "rows", "aggregate" ], "type": "string", "description": "rows = service requests matching your filters (default). aggregate = one count row per group (see groupBy).", "default": "rows" }, "groupBy": { "title": "Aggregate by", "enum": [ "", "agency", "service", "serviceType", "status" ], "type": "string", "description": "Which dimension to aggregate over (mode=aggregate). Blank = serviceType. Every group is returned - aggregate mode is not cut off by maxResults.", "default": "" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed in rows mode (0 = default 50; up to 2,000 per run). Each record is metered individually, so there is no per-run charge cap. Aggregate mode returns every group.", "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 }, "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 } } } } } } } } } }