{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Charity Commission Leads Scraper (Charities & Trustees)",
    "description": "Scrape the official UK Charity Commission register (England & Wales): every registered charity with name, type, latest income & expenditure, phone, email, website, address, company number, activities & trustees + lead score. Filter by income, region, type & cause. Keyless. Monitor mode.",
    "version": "0.1",
    "x-build-id": "HeSMb635bHkUAOJFY"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~uk-charity-commission-leads/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-uk-charity-commission-leads",
        "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/scrapesage~uk-charity-commission-leads/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-uk-charity-commission-leads",
        "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/scrapesage~uk-charity-commission-leads/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-uk-charity-commission-leads",
        "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": {
          "statuses": {
            "title": "Registration statuses",
            "uniqueItems": true,
            "type": "array",
            "description": "Keep only charities with these registration statuses (e.g. [\"Registered\"], or add \"Removed\" for historical charities). Leave empty to default to Registered (active) only.",
            "items": {
              "type": "string"
            }
          },
          "mainCharitiesOnly": {
            "title": "Main charities only",
            "type": "boolean",
            "description": "Keep only main charity records (drop linked subsidiary records that share a charity number). Recommended.",
            "default": true
          },
          "minIncome": {
            "title": "Minimum latest income (£)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only charities whose latest reported annual income is at least this many GBP (e.g. 100000 for £100k+). Great for targeting larger charities."
          },
          "maxIncome": {
            "title": "Maximum latest income (£)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only charities whose latest reported annual income is at most this many GBP."
          },
          "incomeBands": {
            "title": "Income bands",
            "uniqueItems": true,
            "type": "array",
            "description": "Keep only charities in these income bands. Allowed: \"Under £10k\", \"£10k–£100k\", \"£100k–£500k\", \"£500k–£1M\", \"£1M–£10M\", \"Over £10M\".",
            "items": {
              "type": "string"
            }
          },
          "charityTypes": {
            "title": "Charity types",
            "uniqueItems": true,
            "type": "array",
            "description": "Keep only these charity types (case-insensitive), e.g. [\"Charitable company\", \"CIO\", \"Trust\", \"Other\"]. Leave empty for all.",
            "items": {
              "type": "string"
            }
          },
          "postcodePrefixes": {
            "title": "Postcode prefixes (region)",
            "uniqueItems": true,
            "type": "array",
            "description": "Keep only charities whose contact postcode starts with one of these (postcode area/district), e.g. [\"SW\", \"M\", \"B\", \"LS\"] for London SW, Manchester, Birmingham, Leeds.",
            "items": {
              "type": "string"
            }
          },
          "addressContains": {
            "title": "Address contains",
            "type": "string",
            "description": "Keep only charities whose address contains this text (case-insensitive), e.g. a town or county."
          },
          "nameQuery": {
            "title": "Charity name contains",
            "type": "string",
            "description": "Keep only charities whose name contains this text (case-insensitive)."
          },
          "activitiesKeyword": {
            "title": "Activities / cause keyword",
            "type": "string",
            "description": "Keep only charities whose activities description (what the charity does) or name contains this text — use it to target a cause, e.g. \"education\", \"homeless\", \"mental health\", \"animal\"."
          },
          "withEmailOnly": {
            "title": "With email only",
            "type": "boolean",
            "description": "Keep only charities that publish a contact email.",
            "default": false
          },
          "withPhoneOnly": {
            "title": "With phone only",
            "type": "boolean",
            "description": "Keep only charities that publish a contact phone number.",
            "default": false
          },
          "withWebsiteOnly": {
            "title": "With website only",
            "type": "boolean",
            "description": "Keep only charities that publish a website.",
            "default": false
          },
          "registeredCompaniesOnly": {
            "title": "Registered companies only",
            "type": "boolean",
            "description": "Keep only charities that are also registered companies (have a Companies House number) — charitable companies & most CIOs.",
            "default": false
          },
          "cioOnly": {
            "title": "CIOs only",
            "type": "boolean",
            "description": "Keep only Charitable Incorporated Organisations (CIOs).",
            "default": false
          },
          "giftAidOnly": {
            "title": "Gift Aid registered only",
            "type": "boolean",
            "description": "Keep only charities registered for Gift Aid.",
            "default": false
          },
          "registeredAfter": {
            "title": "Registered after",
            "type": "string",
            "description": "Keep only charities registered on or after this date (YYYY-MM-DD) — newly-registered charities as fresh leads."
          },
          "registeredBefore": {
            "title": "Registered before",
            "type": "string",
            "description": "Keep only charities registered on or before this date (YYYY-MM-DD)."
          },
          "minLeadScore": {
            "title": "Minimum lead score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Keep only charities with a lead score at or above this value (0-100)."
          },
          "includeTrustees": {
            "title": "Include trustees",
            "type": "boolean",
            "description": "Attach the trustee list (names, chair flag, individual/organisation) to each selected charity. Downloads an extra register table (slower).",
            "default": false
          },
          "includeClassification": {
            "title": "Include classification",
            "type": "boolean",
            "description": "Attach the charity's classification (What it does / How it works / Who it helps) to each selected charity. Downloads an extra register table (slower).",
            "default": false
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "leadScore",
              "incomeHigh",
              "registeredNewest",
              "name"
            ],
            "type": "string",
            "description": "Order of the output.",
            "default": "leadScore"
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of charities to return.",
            "default": 1000
          },
          "includeRawFields": {
            "title": "Include raw source fields",
            "type": "boolean",
            "description": "Attach the raw register row (all original columns) under sourceFields on each record.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitoring mode (only new / changed)",
            "type": "boolean",
            "description": "Only return charities that are new or whose status, income, financial period or contact changed since the last run with the same monitor key. Ideal on a Schedule to catch newly-registered charities and fresh financial filings as leads.",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor key",
            "type": "string",
            "description": "Namespace for monitoring mode so independent monitors don't collide. Use a distinct key per saved configuration.",
            "default": "default"
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. The Charity Commission register is public open data and usually needs no proxy, so leave this off for the fastest downloads.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}