{ "openapi": "3.0.1", "info": { "title": "UK Charity Commission Register Scraper", "description": "Search the official Register of Charities for England and Wales. Filter by name, number, income, expenditure, classification, or area of operation, or fetch a full charity record (trustees, financial history, governance, accounts) by charity number.", "version": "1.0", "x-build-id": "bIy4cXF3YbeLqMfpY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~uk-charity-commission-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-uk-charity-commission-register-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/crawlerbros~uk-charity-commission-register-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-uk-charity-commission-register-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/crawlerbros~uk-charity-commission-register-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-uk-charity-commission-register-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byCharityNumber" ], "type": "string", "description": "What to fetch.", "default": "search" }, "keywords": { "title": "Search keywords", "type": "string", "description": "Charity name, charity number, or words to find in objects, activities, classifications or area of operation (mode=search).", "default": "cancer research" }, "searchIn": { "title": "Search in", "type": "array", "description": "Which fields the keywords are matched against (mode=search). Restricting this narrows results considerably.", "items": { "type": "string", "enum": [ "charityNumber", "charityName", "whereTheCharityOperates", "classifications", "objectsAndActivities" ], "enumTitles": [ "Charity number", "Charity name", "Where the charity operates", "Classifications", "Objects and activities" ] }, "default": [ "charityNumber", "charityName", "whereTheCharityOperates", "classifications", "objectsAndActivities" ] }, "charityNumbers": { "title": "Charity numbers (mode=byCharityNumber)", "type": "array", "description": "Exact registered charity numbers to fetch full records for, e.g. `247558`. Capped at the first 50 numbers per run.", "default": [], "items": { "type": "string" } }, "registrationStatus": { "title": "Registration status", "type": "array", "description": "Registered and/or removed charities (mode=search). Defaults to registered charities only, matching the register's own default.", "items": { "type": "string", "enum": [ "registered", "removed" ], "enumTitles": [ "Registered", "Removed" ] }, "default": [ "registered" ] }, "includeLinkedCharities": { "title": "Include linked charities", "type": "boolean", "description": "Also include charities linked to (grouped with) a matching charity (mode=search).", "default": false }, "registrationDateFrom": { "title": "Registration date from", "type": "string", "description": "Only charities registered on/after this date (mode=search). Format: YYYY-MM-DD, e.g. `2020-01-01`." }, "registrationDateTo": { "title": "Registration date to", "type": "string", "description": "Only charities registered on/before this date (mode=search). Format: YYYY-MM-DD, e.g. `2021-12-31`." }, "removedDateFrom": { "title": "Removed date from", "type": "string", "description": "Only charities removed on/after this date (mode=search, registrationStatus includes removed). Format: YYYY-MM-DD." }, "removedDateTo": { "title": "Removed date to", "type": "string", "description": "Only charities removed on/before this date (mode=search, registrationStatus includes removed). Format: YYYY-MM-DD." }, "incomeMin": { "title": "Income from (GBP)", "minimum": 0, "maximum": 2000000000, "type": "integer", "description": "Only charities with latest annual income greater than or equal to this whole-pound amount (mode=search)." }, "incomeMax": { "title": "Income to (GBP)", "minimum": 0, "maximum": 2000000000, "type": "integer", "description": "Only charities with latest annual income less than or equal to this whole-pound amount (mode=search)." }, "expenditureMin": { "title": "Expenditure from (GBP)", "minimum": 0, "maximum": 2000000000, "type": "integer", "description": "Only charities with latest annual expenditure greater than or equal to this whole-pound amount (mode=search)." }, "expenditureMax": { "title": "Expenditure to (GBP)", "minimum": 0, "maximum": 2000000000, "type": "integer", "description": "Only charities with latest annual expenditure less than or equal to this whole-pound amount (mode=search)." }, "overdueDocumentsOnly": { "title": "Overdue documents only", "type": "boolean", "description": "Only charities with latest annual return/accounts overdue (mode=search).", "default": false }, "employeeBenefitBands": { "title": "Employee benefit bands", "type": "array", "description": "Only charities with at least one employee whose total benefits fall in one of these bands (mode=search).", "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": [ "GBP 60,001 to GBP 70,000", "GBP 70,001 to GBP 80,000", "GBP 80,001 to GBP 90,000", "GBP 90,001 to GBP 100,000", "GBP 100,001 to GBP 110,000", "GBP 110,001 to GBP 120,000", "GBP 120,001 to GBP 130,000", "GBP 130,001 to GBP 140,000", "GBP 140,001 to GBP 150,000", "GBP 150,001 to GBP 200,000", "GBP 200,001 to GBP 250,000", "GBP 250,001 to GBP 300,000", "GBP 300,001 to GBP 350,000", "GBP 350,001 to GBP 400,000", "GBP 400,001 to GBP 450,000", "GBP 450,001 to GBP 500,000", "Over GBP 500,000" ] }, "default": [] }, "grantMakingOnly": { "title": "Grant-making charities only", "type": "boolean", "description": "Only charities that make grants to individuals or organisations (mode=search).", "default": false }, "whatCharityDoes": { "title": "What the charity does", "type": "array", "description": "Filter by classification of charitable purpose (mode=search).", "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", "The Advancement Of Health Or Saving Of Lives", "Disability", "The 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/religious Or Racial Harmony/equality Or Diversity", "Recreation", "Other Charitable Purposes" ] }, "default": [] }, "whoCharityHelps": { "title": "Who the charity helps", "type": "array", "description": "Filter by classification of beneficiary group (mode=search).", "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/old People", "People With Disabilities", "People Of A Particular Ethnic Or Racial Origin", "Other Charities Or Voluntary Bodies", "Other Defined Groups", "The General Public/mankind" ] }, "default": [] }, "howCharityHelps": { "title": "How the charity helps", "type": "array", "description": "Filter by classification of the method used to deliver charitable purposes (mode=search).", "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" ] }, "default": [] }, "areaOfOperationNational": { "title": "Area of operation - national", "type": "array", "description": "Filter to charities working nationally in England and/or Wales (mode=search).", "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" ] }, "default": [] }, "localAuthorityEngland": { "title": "Area of operation - England local authority", "type": "array", "description": "Filter to charities working in specific English local authorities (mode=search). Excludes London boroughs — use `londonBorough` for those.", "items": { "type": "string", "enum": [ "Barnsley", "Bath And North East Somerset", "Bedford", "Birmingham City", "Blackburn With Darwen", "Blackpool", "Bolton", "Bournemouth", "Bracknell Forest", "Bradford City", "Brighton And Hove", "Bristol City", "Buckinghamshire", "Bury", "Calderdale", "Cambridgeshire", "Central Bedfordshire", "Cheshire East", "Cheshire West & Chester", "City Of Wakefield", "City Of York", "Cornwall", "Coventry City", "Cumbria", "Darlington", "Derby City", "Derbyshire", "Devon", "Doncaster", "Dorset", "Dudley", "Durham", "East Riding Of Yorkshire", "East Sussex", "Essex", "Gateshead", "Gloucestershire", "Halton", "Hampshire", "Hartlepool", "Herefordshire", "Hertfordshire", "Isle Of Wight", "Isles Of Scilly", "Kent", "Kingston Upon Hull City", "Kirklees", "Knowsley", "Lancashire", "Leeds City", "Leicester City", "Leicestershire", "Lincolnshire", "Liverpool City", "Luton", "Manchester City", "Medway", "Middlesbrough", "Milton Keynes", "Newcastle Upon Tyne City", "Norfolk", "North East Lincolnshire", "North Lincolnshire", "North Somerset", "North Tyneside", "North Yorkshire", "Northamptonshire", "Northumberland", "Nottingham City", "Nottinghamshire", "Oldham", "Oxfordshire", "Peterborough City", "Plymouth City", "Poole", "Portsmouth City", "Reading", "Redcar And Cleveland", "Rochdale", "Rotherham", "Rutland", "Salford City", "Sandwell", "Sefton", "Sheffield City", "Shropshire", "Slough", "Solihull", "Somerset", "South Gloucestershire", "South Tyneside", "Southampton City", "Southend-on-sea", "St Helens", "Staffordshire", "Stockport", "Stockton-on-tees", "Stoke-on-trent City", "Suffolk", "Sunderland", "Surrey", "Swindon", "Tameside", "Telford & Wrekin", "Thurrock", "Torbay", "Trafford", "Walsall", "Warrington", "Warwickshire", "West Berkshire", "West Sussex", "Wigan", "Wiltshire", "Windsor And Maidenhead", "Wirral", "Wokingham", "Wolverhampton", "Worcestershire" ], "enumTitles": [ "Barnsley", "Bath And North East Somerset", "Bedford", "Birmingham City", "Blackburn With Darwen", "Blackpool", "Bolton", "Bournemouth", "Bracknell Forest", "Bradford City", "Brighton And Hove", "Bristol City", "Buckinghamshire", "Bury", "Calderdale", "Cambridgeshire", "Central Bedfordshire", "Cheshire East", "Cheshire West & Chester", "City Of Wakefield", "City Of York", "Cornwall", "Coventry City", "Cumbria", "Darlington", "Derby City", "Derbyshire", "Devon", "Doncaster", "Dorset", "Dudley", "Durham", "East Riding Of Yorkshire", "East Sussex", "Essex", "Gateshead", "Gloucestershire", "Halton", "Hampshire", "Hartlepool", "Herefordshire", "Hertfordshire", "Isle Of Wight", "Isles Of Scilly", "Kent", "Kingston Upon Hull City", "Kirklees", "Knowsley", "Lancashire", "Leeds City", "Leicester City", "Leicestershire", "Lincolnshire", "Liverpool City", "Luton", "Manchester City", "Medway", "Middlesbrough", "Milton Keynes", "Newcastle Upon Tyne City", "Norfolk", "North East Lincolnshire", "North Lincolnshire", "North Somerset", "North Tyneside", "North Yorkshire", "Northamptonshire", "Northumberland", "Nottingham City", "Nottinghamshire", "Oldham", "Oxfordshire", "Peterborough City", "Plymouth City", "Poole", "Portsmouth City", "Reading", "Redcar And Cleveland", "Rochdale", "Rotherham", "Rutland", "Salford City", "Sandwell", "Sefton", "Sheffield City", "Shropshire", "Slough", "Solihull", "Somerset", "South Gloucestershire", "South Tyneside", "Southampton City", "Southend-on-sea", "St Helens", "Staffordshire", "Stockport", "Stockton-on-tees", "Stoke-on-trent City", "Suffolk", "Sunderland", "Surrey", "Swindon", "Tameside", "Telford & Wrekin", "Thurrock", "Torbay", "Trafford", "Walsall", "Warrington", "Warwickshire", "West Berkshire", "West Sussex", "Wigan", "Wiltshire", "Windsor And Maidenhead", "Wirral", "Wokingham", "Wolverhampton", "Worcestershire" ] }, "default": [] }, "londonBorough": { "title": "Area of operation - London borough", "type": "array", "description": "Filter to charities working in specific London boroughs (mode=search).", "items": { "type": "string", "enum": [ "Barking And Dagenham", "Barnet", "Bexley", "Brent", "Bromley", "Camden", "City Of London", "City Of Westminster", "Croydon", "Ealing", "Enfield", "Greenwich", "Hackney", "Hammersmith And Fulham", "Haringey", "Harrow", "Havering", "Hillingdon", "Hounslow", "Islington", "Kensington And Chelsea", "Kingston Upon Thames", "Lambeth", "Lewisham", "Merton", "Newham", "Redbridge", "Richmond Upon Thames", "Southwark", "Sutton", "Tower Hamlets", "Waltham Forest", "Wandsworth" ], "enumTitles": [ "Barking And Dagenham", "Barnet", "Bexley", "Brent", "Bromley", "Camden", "City Of London", "City Of Westminster", "Croydon", "Ealing", "Enfield", "Greenwich", "Hackney", "Hammersmith And Fulham", "Haringey", "Harrow", "Havering", "Hillingdon", "Hounslow", "Islington", "Kensington And Chelsea", "Kingston Upon Thames", "Lambeth", "Lewisham", "Merton", "Newham", "Redbridge", "Richmond Upon Thames", "Southwark", "Sutton", "Tower Hamlets", "Waltham Forest", "Wandsworth" ] }, "default": [] }, "localAuthorityWales": { "title": "Area of operation - Wales local authority", "type": "array", "description": "Filter to charities working in specific Welsh local authorities (mode=search).", "items": { "type": "string", "enum": [ "Blaenau Gwent", "Bridgend", "Caerphilly", "Cardiff", "Carmarthenshire", "Ceredigion", "City Of Swansea", "Conwy", "Denbighshire", "Flintshire", "Gwynedd", "Isle Of Anglesey", "Merthyr Tydfil", "Monmouthshire", "Neath Port Talbot", "Newport City", "Pembrokeshire", "Powys", "Rhondda Cynon Taff", "Torfaen", "Vale Of Glamorgan", "Wrexham" ], "enumTitles": [ "Blaenau Gwent", "Bridgend", "Caerphilly", "Cardiff", "Carmarthenshire", "Ceredigion", "City Of Swansea", "Conwy", "Denbighshire", "Flintshire", "Gwynedd", "Isle Of Anglesey", "Merthyr Tydfil", "Monmouthshire", "Neath Port Talbot", "Newport City", "Pembrokeshire", "Powys", "Rhondda Cynon Taff", "Torfaen", "Vale Of Glamorgan", "Wrexham" ] }, "default": [] }, "overseasCountry": { "title": "Area of operation - overseas country", "type": "array", "description": "Filter to charities working in specific countries outside England and Wales, including Scotland and Northern Ireland (mode=search).", "items": { "type": "string", "enum": [ "Abu Dhabi", "Afghanistan", "Ajman", "Akrotiri", "Aland Islands", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua And Barbuda", "Argentina", "Armenia", "Aruba", "Ascension", "Australia", "Austria", "Azerbaijan", "Bahrain", "Baker Island", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bonaire", "Bosnia And Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Antarctic Territory", "British Indian Ocean Territory", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burma", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Cayman Islands", "Central African Republic", "Ceuta", "Chad", "Chile", "China", "Christmas Island", "Cocos (KEELING) ISLANDS", "Colombia", "Comoros", "Congo", "Congo (Democratic Republic)", "Cook Islands", "Costa Rica", "Croatia", "Cuba", "Cyprus", "Czech Republic", "Denmark", "Dhekelia", "Djibouti", "Dominica", "Dominican Republic", "Dubai", "East Timor", "Easter Island", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Eswatini", "Ethiopia", "Falkland Islands", "Faroe Islands", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Fujairah", "Gabon", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-bissau", "Guyana", "Haiti", "Heard Island And Mcdonald Islands", "Honduras", "Hong Kong", "Howland Island", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Isle Of Man", "Israel", "Italy", "Ivory Coast", "Jamaica", "Japan", "Jarvis Island", "Jersey", "Johnston Atoll", "Jordan", "Kazakhstan", "Kenya", "Kingman Reef", "Kiribati", "Kosovo", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Macedonia", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Melilla", "Mexico", "Micronesia", "Midway Islands", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Namibia", "Nauru", "Navassa Island", "Nepal", "Netherlands", "Netherlands Antilles", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "North Korea", "Northern Ireland", "Northern Mariana Islands", "Norway", "Occupied Palestinian Territories", "Oman", "Pakistan", "Palau", "Palmyra Atoll", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn, Henderson, Ducie And Oeno Islands", "Poland", "Portugal", "Puerto Rico", "Qatar", "Ras Al-khaimah", "Romania", "Russia", "Rwanda", "Réunion", "Saba", "Saint Barthélemy", "Saint Helena", "Saint Pierre And Miquelon", "Saint Vincent", "Saint-Martin", "Samoa", "San Marino", "Saudi Arabia", "Scotland", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Eustatius", "Sint Maarten", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia And South Sandwich Islands", "South Korea", "South Sudan", "Spain", "Sri Lanka", "St Kitts And Nevis", "St Lucia", "Sudan", "Suriname", "Svalbard And Jan Mayen", "Sweden", "Switzerland", "Syria", "São Tomé And Principe", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "The Bahamas", "The Gambia", "Togo", "Tokelau", "Tonga", "Trinidad And Tobago", "Tristan Da Cunha", "Tunisia", "Turkey", "Turkmenistan", "Turks And Caicos Islands", "Tuvalu", "Uganda", "Ukraine", "Umm Al-quwain", "United Arab Emirates", "United States", "United States Virgin Islands", "Uruguay", "Uzbekistan", "Vanuatu", "Vatican City", "Venezuela", "Vietnam", "Wake Island", "Wallis And Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe" ], "enumTitles": [ "Abu Dhabi", "Afghanistan", "Ajman", "Akrotiri", "Aland Islands", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua And Barbuda", "Argentina", "Armenia", "Aruba", "Ascension", "Australia", "Austria", "Azerbaijan", "Bahrain", "Baker Island", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bonaire", "Bosnia And Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Antarctic Territory", "British Indian Ocean Territory", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burma", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Cayman Islands", "Central African Republic", "Ceuta", "Chad", "Chile", "China", "Christmas Island", "Cocos (KEELING) ISLANDS", "Colombia", "Comoros", "Congo", "Congo (Democratic Republic)", "Cook Islands", "Costa Rica", "Croatia", "Cuba", "Cyprus", "Czech Republic", "Denmark", "Dhekelia", "Djibouti", "Dominica", "Dominican Republic", "Dubai", "East Timor", "Easter Island", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Eswatini", "Ethiopia", "Falkland Islands", "Faroe Islands", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Fujairah", "Gabon", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-bissau", "Guyana", "Haiti", "Heard Island And Mcdonald Islands", "Honduras", "Hong Kong", "Howland Island", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Isle Of Man", "Israel", "Italy", "Ivory Coast", "Jamaica", "Japan", "Jarvis Island", "Jersey", "Johnston Atoll", "Jordan", "Kazakhstan", "Kenya", "Kingman Reef", "Kiribati", "Kosovo", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Macedonia", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Melilla", "Mexico", "Micronesia", "Midway Islands", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Namibia", "Nauru", "Navassa Island", "Nepal", "Netherlands", "Netherlands Antilles", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "North Korea", "Northern Ireland", "Northern Mariana Islands", "Norway", "Occupied Palestinian Territories", "Oman", "Pakistan", "Palau", "Palmyra Atoll", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn, Henderson, Ducie And Oeno Islands", "Poland", "Portugal", "Puerto Rico", "Qatar", "Ras Al-khaimah", "Romania", "Russia", "Rwanda", "Réunion", "Saba", "Saint Barthélemy", "Saint Helena", "Saint Pierre And Miquelon", "Saint Vincent", "Saint-Martin", "Samoa", "San Marino", "Saudi Arabia", "Scotland", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Eustatius", "Sint Maarten", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia And South Sandwich Islands", "South Korea", "South Sudan", "Spain", "Sri Lanka", "St Kitts And Nevis", "St Lucia", "Sudan", "Suriname", "Svalbard And Jan Mayen", "Sweden", "Switzerland", "Syria", "São Tomé And Principe", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "The Bahamas", "The Gambia", "Togo", "Tokelau", "Tonga", "Trinidad And Tobago", "Tristan Da Cunha", "Tunisia", "Turkey", "Turkmenistan", "Turks And Caicos Islands", "Tuvalu", "Uganda", "Ukraine", "Umm Al-quwain", "United Arab Emirates", "United States", "United States Virgin Islands", "Uruguay", "Uzbekistan", "Vanuatu", "Vatican City", "Venezuela", "Vietnam", "Wake Island", "Wallis And Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe" ] }, "default": [] }, "sortBy": { "title": "Sort results by", "enum": [ "relevance", "charityNumber", "charityName", "registrationStatus", "income", "reportingStatus" ], "type": "string", "description": "Column to sort search results by (mode=search). Defaults to the register's own relevance ranking.", "default": "relevance" }, "sortDirection": { "title": "Sort direction", "enum": [ "asc", "desc" ], "type": "string", "description": "Ascending or descending order (mode=search). Ignored when `sortBy` is `relevance`.", "default": "asc" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on emitted records (mode=search).", "default": 20 } } }, "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 } } } } } } } } } }