{ "openapi": "3.0.1", "info": { "title": "UK Charity Commission Scraper: Trustees, Emails & Finances", "description": "Scrape the UK register of charities: charity name and number, email, phone, website and address, every trustee with role and other trusteeships, five years of exact income, expenditure, assets and liabilities, staff and volunteer counts, salary bands and accounts. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "LjaQtf1f96lc5EAwu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~uk-charity-commission-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-uk-charity-commission-scraper", "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/scrapers_lat~uk-charity-commission-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-uk-charity-commission-scraper", "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/scrapers_lat~uk-charity-commission-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-uk-charity-commission-scraper", "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": { "searchTerm": { "title": "Search Term", "type": "string", "description": "Free-text search across the register — charity name, number, area of operation, classification and charitable objects. Leave empty to sweep every charity that matches the filters below. Several words are matched as 'any word', so 'cancer support' returns charities mentioning either." }, "searchIn": { "title": "Search The Term In", "type": "array", "description": "Narrow where the search term is matched. Leave empty to search everything (the register's default). Choosing 'Charity name' alone is the way to run a clean name search without objects and classifications dragging in unrelated charities.", "items": { "type": "string", "enum": [ "charityNumber", "charityName", "whereItOperates", "classifications", "objectsAndActivities" ], "enumTitles": [ "Charity number", "Charity name", "Where the charity operates", "Classifications", "Objects and activities" ] } }, "charityNumbers": { "title": "Charity Numbers", "type": "array", "description": "Optional. Look up exact registered charity numbers (for example '1089464'). When given, these are fetched directly and every search filter below is ignored.", "items": { "type": "string" } }, "status": { "title": "Register Status", "enum": [ "registered", "removed", "all" ], "type": "string", "description": "Registered charities only, charities removed from the register (dissolved, merged or ceased), or both. Removed charities carry the removal date and reason.", "default": "registered" }, "incomeMin": { "title": "Minimum Annual Income (£)", "minimum": 0, "type": "integer", "description": "Only charities whose latest reported gross income is at least this. Use it to skip dormant micro-charities — for example 100000 for charities with real budgets." }, "incomeMax": { "title": "Maximum Annual Income (£)", "minimum": 0, "type": "integer", "description": "Only charities whose latest reported gross income is at most this." }, "expenditureMin": { "title": "Minimum Annual Spending (£)", "minimum": 0, "type": "integer", "description": "Only charities whose latest reported total expenditure is at least this." }, "expenditureMax": { "title": "Maximum Annual Spending (£)", "minimum": 0, "type": "integer", "description": "Only charities whose latest reported total expenditure is at most this." }, "localAuthorities": { "title": "Local Authority Areas", "type": "array", "description": "Council areas the charity works in, for example 'Camden', 'Birmingham City', 'Cardiff'. London boroughs and Welsh councils are routed automatically. Combine with an income filter to build a local funding or partnership list.", "items": { "type": "string" } }, "operatesNationally": { "title": "Operates Nationally", "type": "array", "description": "Charities that declare they work across a whole nation rather than one council area.", "items": { "type": "string", "enum": [ "Throughout England And Wales", "Throughout England", "Throughout London", "Throughout Wales" ], "enumTitles": [ "Throughout England and Wales", "Throughout England", "Throughout London", "Throughout Wales" ] } }, "countriesOfOperation": { "title": "Countries Of Operation", "type": "array", "description": "Overseas countries the charity works in, for example 'Kenya', 'Ukraine', 'India'. The register records these per charity, so this isolates charities operating in a given country.", "items": { "type": "string" } }, "whatCharityDoes": { "title": "What The Charity Does", "type": "array", "description": "The register's own purpose classification.", "items": { "type": "string", "enum": [ "101:General Charitable Purposes", "102:Education/training", "103:The Advancement Of Health Or Saving Of Lives", "104:Disability", "105:The Prevention Or Relief Of Poverty", "106:Overseas Aid/famine Relief", "107:Accommodation/housing", "108:Religious Activities", "109:Arts/culture/heritage/science", "110:Amateur Sport", "111:Animals", "112:Environment/conservation/heritage", "113:Economic/community Development/employment", "114:Armed Forces/emergency Service Efficiency", "115:Human Rights/religious Or Racial Harmony/equality Or Diversity", "116:Recreation", "117:Other Charitable Purposes" ], "enumTitles": [ "General charitable purposes", "Education / training", "Health / saving lives", "Disability", "Prevention or relief of poverty", "Overseas aid / famine relief", "Accommodation / housing", "Religious activities", "Arts / culture / heritage / science", "Amateur sport", "Animals", "Environment / conservation / heritage", "Economic / community development / employment", "Armed forces / emergency service efficiency", "Human rights / equality / diversity", "Recreation", "Other charitable purposes" ] } }, "whoCharityHelps": { "title": "Who The Charity Helps", "type": "array", "description": "The beneficiary group the charity declares.", "items": { "type": "string", "enum": [ "201:Children/young People", "202:Elderly/old People", "203:People With Disabilities", "204:People Of A Particular Ethnic Or Racial Origin", "205:Other Charities Or Voluntary Bodies", "206:Other Defined Groups", "207:The General Public/mankind" ], "enumTitles": [ "Children / young people", "Elderly people", "People with disabilities", "A particular ethnic or racial origin", "Other charities or voluntary bodies", "Other defined groups", "The general public" ] } }, "howCharityHelps": { "title": "How The Charity Helps", "type": "array", "description": "How the charity delivers its purposes — grant makers, service providers, research funders and so on.", "items": { "type": "string", "enum": [ "301:Makes Grants To Individuals", "302:Makes Grants To Organisations", "303:Provides Other Finance", "304:Provides Human Resources", "305:Provides Buildings/facilities/open Space", "306:Provides Services", "307:Provides Advocacy/advice/information", "308:Sponsors Or Undertakes Research", "309:Acts As An Umbrella Or Resource Body", "310:Other Charitable Activities" ], "enumTitles": [ "Makes grants to individuals", "Makes grants to organisations", "Provides other finance", "Provides human resources", "Provides buildings / facilities / open space", "Provides services", "Provides advocacy / advice / information", "Sponsors or undertakes research", "Acts as an umbrella or resource body", "Other charitable activities" ] } }, "grantMakersOnly": { "title": "Grant Makers Only", "type": "boolean", "description": "Only charities whose main way of carrying out their purposes is grant making — the funder list, straight from the register.", "default": false }, "employeeBenefitBands": { "title": "Has Staff Paid Over £60k In Band", "type": "array", "description": "Only charities reporting at least one employee in the chosen total-benefits band. A quick filter for charities big enough to employ senior paid staff.", "items": { "type": "string", "enum": [ "band_60001_70000", "band_70001_80000", "band_80001_90000", "band_90001_100000", "band_100001_110000", "band_110001_120000", "band_120001_130000", "band_130001_140000", "band_140001_150000", "band_150001_200000", "band_200001_250000", "band_250001_300000", "band_300001_350000", "band_350001_400000", "band_400001_450000", "band_450001_500000", "band_over_500000" ], "enumTitles": [ "£60k–£70k", "£70k–£80k", "£80k–£90k", "£90k–£100k", "£100k–£110k", "£110k–£120k", "£120k–£130k", "£130k–£140k", "£140k–£150k", "£150k–£200k", "£200k–£250k", "£250k–£300k", "£300k–£350k", "£350k–£400k", "£400k–£450k", "£450k–£500k", "Over £500k" ] } }, "registeredFrom": { "title": "Registered From", "type": "string", "description": "Earliest registration date, DD/MM/YYYY or YYYY-MM-DD. Newly registered charities are the freshest leads on the register." }, "registeredTo": { "title": "Registered To", "type": "string", "description": "Latest registration date, DD/MM/YYYY or YYYY-MM-DD." }, "removedFrom": { "title": "Removed From", "type": "string", "description": "Earliest removal date, DD/MM/YYYY or YYYY-MM-DD. Only applies when removed charities are included." }, "removedTo": { "title": "Removed To", "type": "string", "description": "Latest removal date, DD/MM/YYYY or YYYY-MM-DD." }, "documentsOverdueOnly": { "title": "Overdue Filings Only", "type": "boolean", "description": "Only charities whose annual return or accounts are overdue — the compliance-risk slice of the register.", "default": false }, "includeLinkedCharities": { "title": "Include Linked Charities", "type": "boolean", "description": "Include subsidiary charities linked to a main registration (for example endowment funds run under a parent charity's number).", "default": false }, "withEmailOnly": { "title": "Only Charities With An Email", "type": "boolean", "description": "Skip charities that publish no email address. Records without an email are never returned or charged for.", "default": false }, "withPhoneOnly": { "title": "Only Charities With A Phone Number", "type": "boolean", "description": "Skip charities that publish no phone number.", "default": false }, "withWebsiteOnly": { "title": "Only Charities With A Website", "type": "boolean", "description": "Skip charities that publish no website.", "default": false }, "fullDetails": { "title": "Full Charity Records", "type": "boolean", "description": "On (recommended): every field — contacts, trustees, finances, accounts, governance. Off: only the result-list summary (name, number, status, headline income), which is much faster for very large sweeps.", "default": true }, "maxResults": { "title": "Maximum Charities", "minimum": 1, "type": "integer", "description": "How many charity records to return. Searches returning more than 10,000 matches are split into registration-date windows automatically so large pulls stay complete.", "default": 50 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional. The register is reachable without a proxy; use one only if your account requires it.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }