{ "openapi": "3.0.1", "info": { "title": "New Orleans Permits - Building & Trade Register", "description": "City of New Orleans building and trade permits (public open data, 348,207 permits, 2006-today): type, status and its date, owner, applicant and contractor, construction value and fees, parcel PIN, address and zoning. Filter by type, status, contractor, value or date.", "version": "0.0", "x-build-id": "EC5uKBiqMge9hS3Pj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~nola-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-nola-permits", "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~nola-permits/runs": { "post": { "operationId": "runs-sync-j0401-nola-permits", "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~nola-permits/run-sync": { "post": { "operationId": "run-sync-j0401-nola-permits", "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": { "mode": { "title": "Mode", "enum": [ "", "rows", "aggregate" ], "type": "string", "description": "rows = records matching your filters (default). aggregate = one count row per group.", "default": "rows" }, "groupBy": { "title": "Group by", "enum": [ "", "type", "landUse", "councilDistrict", "leadAgency", "exitReason", "zoning" ], "type": "string", "description": "Aggregate dimension, only used when mode=aggregate.", "default": "type" }, "permitNumber": { "title": "Permit number", "type": "string", "description": "Exact permit number, e.g. '26-27777-FGAS'. Blank = any.", "default": "" }, "type": { "title": "Permit type", "type": "string", "description": "Permit-type substring, e.g. 'Electrical', 'Renovation', 'Mechanical'. Blank = any. 68 types in total.", "default": "" }, "status": { "title": "Current status", "type": "string", "description": "Current-status substring, e.g. 'Permit Issued', 'Finaled', 'Permit Expired'. Blank = any.", "default": "" }, "isClosed": { "title": "Closed", "enum": [ "", "true", "false" ], "type": "string", "description": "true = closed, false = open. Blank = both.", "default": "" }, "description": { "title": "Description", "type": "string", "description": "Project-description substring. Blank = any.", "default": "" }, "owner": { "title": "Owner", "type": "string", "description": "Owner-name substring. Blank = any. NOTE: owner is recorded on about 74% of rows.", "default": "" }, "applicant": { "title": "Applicant", "type": "string", "description": "Applicant-name substring. Blank = any. Present on 99% of rows.", "default": "" }, "contractor": { "title": "Contractor", "type": "string", "description": "Contractor-name substring. Blank = any. NOTE: recorded on about 72% of rows.", "default": "" }, "address": { "title": "Site address", "type": "string", "description": "Site-address substring, e.g. 'Banks St'. Blank = any.", "default": "" }, "zip": { "title": "ZIP in address", "type": "string", "description": "ZIP digits appearing in the site address. Blank = any.", "default": "" }, "pin": { "title": "Parcel PIN", "type": "string", "description": "Exact parcel PIN. Blank = any.", "default": "" }, "councilDistrict": { "title": "Council district", "type": "string", "description": "Council district code, e.g. 'B'. Blank = any.", "default": "" }, "landUse": { "title": "Land use", "type": "string", "description": "Land-use substring. Blank = any.", "default": "" }, "leadAgency": { "title": "Lead agency", "type": "string", "description": "Lead-agency substring. Blank = any.", "default": "" }, "zoning": { "title": "Zoning", "type": "string", "description": "Zoning substring, e.g. 'HU-RD2', 'S-RS'. Blank = any.", "default": "" }, "minConstructionValue": { "title": "Min construction value", "type": "integer", "description": "Only permits with a declared construction value at least this, e.g. 100000. Blank = any. ~43% of rows declare no value and will not match." }, "issuedFrom": { "title": "Issued on or after", "type": "string", "description": "YYYY-MM-DD. True date range. Blank = any.", "default": "" }, "issuedTo": { "title": "Issued on or before", "type": "string", "description": "YYYY-MM-DD. Blank = any.", "default": "" }, "filedFrom": { "title": "Filed on or after", "type": "string", "description": "YYYY-MM-DD. Blank = any.", "default": "" }, "filedTo": { "title": "Filed on or before", "type": "string", "description": "YYYY-MM-DD. Blank = any.", "default": "" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap records returned for this run. Default 50 keeps the daily auto-test fast. 0 = no cap (the full matching slice, up to 10,000).", "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 } } } } } } } } } }