# GitHub FUNDING.yml Sponsorship Config Auditor (`phoenix2810/github-funding-config-auditor`) Actor

Audit a public GitHub repository's .github/FUNDING.yml sponsorship configuration in one API call. Validates every platform key against GitHub's documented syntax, flags unknown keys and oversized lists, and returns a readiness score and grade.

- **URL**: https://apify.com/phoenix2810/github-funding-config-auditor.md
- **Developed by:** [Sanskar Jaiswal](https://apify.com/phoenix2810) (community)
- **Categories:** Developer tools, Open source
- **Security:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## GitHub FUNDING.yml Sponsorship Config Auditor

Fetches and validates a public GitHub repository's `.github/FUNDING.yml` sponsorship configuration against GitHub's documented funding-platform syntax. Returns a readiness score, per-platform validation results, and specific fixes for malformed entries. Uses GitHub's public API and raw content delivery with no authentication required.

### Use cases

- Open source maintainers checking whether their Sponsor button configuration is correctly formatted before a release.
- Developer relations and open source program office (OSPO) teams auditing sponsorship readiness across a portfolio of repositories.
- Platforms and marketplaces (Tidelift, Open Collective, thanks.dev integrators) verifying that listed projects actually declare them in FUNDING.yml.
- CI pipelines that lint `.github/FUNDING.yml` on pull requests before merge.
- Grant and accelerator programs doing due diligence on a project's existing funding channel declarations.

### Input

| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| `repoUrls` | array\<string> | yes | - | Public `github.com/<owner>/<repo>` URLs to audit (max 50 per run) |
| `timeoutSeconds` | integer | no | `10` | Per-request timeout (3-30 seconds) |

#### Example input

```json
{
  "repoUrls": [
    "https://github.com/sveltejs/svelte",
    "https://github.com/apify/crawlee"
  ],
  "timeoutSeconds": 10
}
```

### Output

Each repository produces one dataset item:

| Field | Type | Description |
|---|---|---|
| `inputUrl` | string | The GitHub URL provided |
| `fullName` | string | `owner/repo` identifier |
| `ok` | boolean | Whether the repository was reached |
| `checkedAt` | string | ISO timestamp |
| `defaultBranch` | string | Default branch used to locate FUNDING.yml |
| `fundingFileFound` | boolean | Whether `.github/FUNDING.yml` or `.yaml` exists on the default branch |
| `fundingFilePath` | string | Path of the file found |
| `fundingFileUrl` | string | Raw content URL of the fetched file |
| `parseError` | string | YAML parse error, if any |
| `platforms` | array | Per-platform-key entries with `key`, `value`, `valid` |
| `valid` | boolean | True when the file has zero validation issues |
| `issues` | array | Specific validation problems found |
| `recommendations` | array | Suggested fixes |
| `score` | integer | Readiness score, 0-100 |
| `grade` | string | Letter grade, A-F |
| `error` | string | Error message when `ok` is false |

#### Validated platform syntax

The actor checks every key against GitHub's documented `FUNDING.yml` syntax:

| Key | Expected syntax |
|---|---|
| `github` | Username string or array of up to 4 usernames |
| `patreon`, `open_collective`, `ko_fi`, `liberapay`, `issuehunt`, `polar`, `buy_me_a_coffee` | Single username string |
| `community_bridge` | Project name string |
| `tidelift` | `platform-name/package-name` |
| `thanks_dev` | `u/gh/USERNAME` |
| `custom` | URL string or array of up to 4 URLs |

Any other key is flagged as unknown/unsupported. GitHub silently ignores malformed entries instead of raising an error, so the Sponsor button can be missing funding options without any visible warning on the repository page; this actor surfaces those silent failures.

#### Example output

```json
{
  "inputUrl": "https://github.com/sveltejs/svelte",
  "fullName": "sveltejs/svelte",
  "ok": true,
  "checkedAt": "2026-10-05T12:00:00.000Z",
  "defaultBranch": "main",
  "fundingFileFound": true,
  "fundingFilePath": ".github/FUNDING.yml",
  "fundingFileUrl": "https://raw.githubusercontent.com/sveltejs/svelte/main/.github/FUNDING.yml",
  "parseError": null,
  "platforms": [
    { "key": "open_collective", "value": "svelte", "valid": true }
  ],
  "valid": true,
  "issues": [],
  "recommendations": [],
  "score": 70,
  "grade": "C"
}
```

### Security

- Only `github.com/<owner>/<repo>` URLs are accepted as input.
- URLs with embedded credentials are rejected.
- Uses GitHub's unauthenticated public REST API (`api.github.com`) and public raw content delivery (`raw.githubusercontent.com`) only.
- No tokens, no private repositories, no browser automation, no proxies.
- Does not read local files or environment secrets.
- Fetched file content is capped at 200 KB and parsed as YAML only; no code execution of file contents.

### Pricing

Pay per event:

| Event | Price |
|---|---|
| Actor start | $0.005 |
| Repository audited | $0.01 |

A run auditing 10 repositories costs approximately $0.105.

### FAQ

**Do I need a GitHub token?**
No. The actor uses GitHub's unauthenticated public API and public raw content delivery. For high-volume use, run on Apify infrastructure where IP rotation is automatic.

**What happens if a repository has no FUNDING.yml?**
The actor returns an item with `ok: true`, `fundingFileFound: false`, and a recommendation to add the file. It does not treat a missing file as a run failure.

**What happens if a repository does not exist or is private?**
The actor returns an item with `ok: false` and the GitHub API error/status. It does not crash the run.

**Does this actor render or verify the Sponsor button on the live repository page?**
No. It validates the FUNDING.yml syntax against GitHub's documented rules. Rendering the Sponsor button also depends on GitHub Sponsors account state, which is not publicly queryable per repository.

**Can it check organization-wide default FUNDING.yml files?**
Not in this version. Point it at individual repository URLs; a future version may add org-level `.github` repository fallback lookup.

# Actor input Schema

## `repoUrls` (type: `array`):

Public github.com/<owner>/<repo> URLs to audit. Up to 50 repositories per run.

## `timeoutSeconds` (type: `integer`):

Timeout per HTTP request.

## Actor input object example

```json
{
  "repoUrls": [
    "https://github.com/sveltejs/svelte",
    "https://github.com/apify/crawlee"
  ],
  "timeoutSeconds": 10
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "repoUrls": [
        "https://github.com/sveltejs/svelte",
        "https://github.com/apify/crawlee"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("phoenix2810/github-funding-config-auditor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "repoUrls": [
        "https://github.com/sveltejs/svelte",
        "https://github.com/apify/crawlee",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("phoenix2810/github-funding-config-auditor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "repoUrls": [
    "https://github.com/sveltejs/svelte",
    "https://github.com/apify/crawlee"
  ]
}' |
apify call phoenix2810/github-funding-config-auditor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,phoenix2810/github-funding-config-auditor"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/ycGW4Nqtif7dKRzXX/builds/7f550vM5NNN8XcK8Z/openapi.json