{ "openapi": "3.0.1", "info": { "title": "Socrata SODA Open-Data Extractor", "description": "Point at ANY Socrata open-data portal (NYC, Chicago, WA, hundreds of gov portals). Query rows via SoQL, list a domain's catalog, or pull a dataset's column schema. One runner for the whole SODA ecosystem.", "version": "0.1", "x-build-id": "jeDPnFlmkFAidF7w2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~socrata-soda-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-socrata-soda-extractor", "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/datamule~socrata-soda-extractor/runs": { "post": { "operationId": "runs-sync-datamule-socrata-soda-extractor", "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/datamule~socrata-soda-extractor/run-sync": { "post": { "operationId": "run-sync-datamule-socrata-soda-extractor", "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": [ "domain" ], "properties": { "mode": { "title": "Mode", "enum": [ "rows", "catalog", "metadata" ], "type": "string", "description": "rows = query dataset records via SoQL; catalog = list all datasets on a domain; metadata = column schema for one dataset.", "default": "rows" }, "domain": { "title": "Portal domain", "type": "string", "description": "The Socrata portal host, e.g. data.cityofnewyork.us, data.cityofchicago.org, data.wa.gov. Scheme/path are stripped automatically." }, "datasetId": { "title": "Dataset ID (4x4)", "type": "string", "description": "The Socrata dataset identifier, e.g. erm2-nwe9. Required for rows and metadata modes." }, "select": { "title": "$select (SoQL)", "type": "string", "description": "Optional SoQL $select clause, e.g. 'unique_key, complaint_type, agency'." }, "where": { "title": "$where (SoQL)", "type": "string", "description": "Optional SoQL $where filter, e.g. \"complaint_type = 'Noise'\"." }, "order": { "title": "$order (SoQL)", "type": "string", "description": "Optional SoQL $order clause, e.g. 'created_date DESC'." }, "q": { "title": "Full-text search", "type": "string", "description": "Optional full-text search. In rows mode maps to SoQL $q; in catalog mode filters datasets by keyword." }, "category": { "title": "Category (catalog mode)", "type": "string", "description": "Optional category filter for catalog mode, e.g. 'Public Safety'." }, "maxRecords": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Stop after this many records (0 = no limit, fetch all).", "default": 1000 }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Records per SODA request (max 50000). Lower it if a host rate-limits.", "default": 1000 }, "appToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional Socrata X-App-Token for higher rate limits. Never required, never logged." } } }, "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 } } } } } } } } } }