{ "openapi": "3.0.1", "info": { "title": "New Zealand Charities Register with Financials", "description": "Every registered New Zealand charity from the official Charities Register, with the latest annual return: income by source, expenditure, assets, staff, and volunteers. Filter by sector, activity, beneficiaries, city, or income.", "version": "0.1", "x-build-id": "8JVE5EoAyjrHS4oce" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tapedawn~nz-charities-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tapedawn-nz-charities-register", "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/tapedawn~nz-charities-register/runs": { "post": { "operationId": "runs-sync-tapedawn-nz-charities-register", "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/tapedawn~nz-charities-register/run-sync": { "post": { "operationId": "run-sync-tapedawn-nz-charities-register", "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": { "maxItems": { "title": "Maximum charities", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many charities have been saved.", "default": 1000 }, "status": { "title": "Registration status", "enum": [ "Registered", "Deregistered", "All" ], "type": "string", "description": "Registered charities only (default), deregistered only, or all.", "default": "Registered" }, "registrationNumbers": { "title": "Registration numbers", "type": "array", "description": "Look up specific charities, for example CC21316.", "items": { "type": "string" } }, "nameContains": { "title": "Name contains", "type": "string", "description": "Keep charities whose name or other names contain this text." }, "sectors": { "title": "Sectors", "type": "array", "description": "Keep charities whose main or other sectors include any of these, for example Health, Education / training / research, Sport / recreation.", "items": { "type": "string" } }, "activities": { "title": "Activities", "type": "array", "description": "Keep charities with any of these activities, for example 'Makes grants to organisations (including schools or other charities)'.", "items": { "type": "string" } }, "beneficiaries": { "title": "Beneficiaries", "type": "array", "description": "Keep charities serving any of these groups, for example Children / young people, Older people, General public.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Keep charities whose street or postal address is in these cities, for example Auckland or Christchurch.", "items": { "type": "string" } }, "minIncome": { "title": "Minimum total gross income (NZD)", "type": "integer", "description": "Keep charities whose latest annual return shows at least this income." }, "maxIncome": { "title": "Maximum total gross income (NZD)", "type": "integer", "description": "Keep charities whose latest annual return shows at most this income." }, "minFullTimeEmployees": { "title": "Minimum full-time employees", "type": "integer", "description": "Keep charities with at least this many full-time employees in the latest return." }, "latestReturnYearFrom": { "title": "Latest return from year", "type": "integer", "description": "Keep charities whose latest annual return ended in this year or later, for example 2024, to skip charities that now report only as part of a group or stopped filing." } } }, "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 } } } } } } } } } }