{ "openapi": "3.0.1", "info": { "title": "UK Charity Register - England, Wales, Scotland & NI", "description": "All three UK charity registers in one dataset (429,806 rows, OGL v3): England & Wales (Charity Commission, with latest annual-return financials joined), Scotland (OSCR) and Northern Ireland (CCNI). Name, number, status, type, address, purposes, income and expenditure. Search, look up or aggregate.", "version": "0.0", "x-build-id": "IjpYIHSzYkED6PaTS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~uk-charity-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-uk-charity-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/j0401~uk-charity-register/runs": { "post": { "operationId": "runs-sync-j0401-uk-charity-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/j0401~uk-charity-register/run-sync": { "post": { "operationId": "run-sync-j0401-uk-charity-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": { "mode": { "title": "Mode", "enum": [ "", "search", "lookup", "aggregate" ], "type": "string", "description": "search = filter the registers. lookup = one exact charity number in full. aggregate = one row per group. Leave blank to auto-route: filters -> search, a bare charityNumber -> lookup, no filters -> aggregate." }, "corpus": { "title": "Register", "enum": [ "", "england-wales", "scotland", "northern-ireland", "all" ], "type": "string", "description": "Which register to search. Blank = all three." }, "charityNumber": { "title": "Charity number", "type": "string", "description": "Exact registered charity number: England & Wales e.g. \"200027\", Scotland e.g. \"SC000001\", Northern Ireland e.g. \"100002\"." }, "name": { "title": "Charity name", "type": "string", "description": "Name substring, case-insensitive (e.g. \"CANCER\" or \"NHS\")." }, "status": { "title": "Registration status", "enum": [ "", "Registered", "Removed" ], "type": "string", "description": "Registered (on the register) or Removed (no longer registered). Blank = both." }, "type": { "title": "Charity type", "type": "string", "description": "Exact type/legal form, e.g. \"CIO\", \"Charitable company\", \"Trust\", \"Unincorporated association\", \"Other\"." }, "companyNumber": { "title": "Company number", "type": "string", "description": "Exact Companies House company number where the charity is also a company (e.g. \"01759471\")." }, "postcode": { "title": "Postcode prefix", "type": "string", "description": "Registered-address postcode prefix (must contain at least one digit), e.g. \"SW1\" or \"EH47\"." }, "registeredFrom": { "title": "Registered from", "type": "string", "description": "Earliest registration date (YYYY-MM-DD), inclusive." }, "registeredTo": { "title": "Registered to", "type": "string", "description": "Latest registration date (YYYY-MM-DD), inclusive." }, "incomeMin": { "title": "Latest income at least", "type": "number", "description": "Minimum latest reported income in GBP, e.g. 1000000. Charities with no reported income are excluded by this filter." }, "incomeMax": { "title": "Latest income at most", "type": "number", "description": "Maximum latest reported income in GBP." }, "aggregate": { "title": "Aggregate instead of records", "type": "boolean", "description": "When on, returns one summary record per group with count, instead of individual charities.", "default": false }, "groupBy": { "title": "Aggregate by", "enum": [ "", "corpus", "status", "type", "registrationYear", "incomeBand" ], "type": "string", "description": "corpus -> register; status -> Registered vs Removed; type -> legal form; registrationYear -> registrations by year; incomeBand -> latest income band. Blank defaults to corpus." }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of search records pushed (0 = the default ceiling of 50, maximum 5000). Aggregate 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 } } } } } } } } } }