Skip to main content
Requires core scope A config defines a set of charity beneficiaries and how donations are split between them. Use the Partner API to create and list configs. Use this Core API page to inspect and delete an existing config by ID. Config IDs are returned as { "hex": string, "base58": string }. The hex form is the on-chain bytes32; the base58 form is a Solana-friendly encoding of the same value.

​
Get a config by ID

GET /configs/{configId} Returns a single config with its beneficiaries and aggregate donation stats. 
curl https://www.donate.gg/api/v1/configs/0x1234...abcd \
  -H "donate-api-key: YOUR_API_KEY"
Path parameters
ParameterDescription
configIdThe config ID (hex string or base58 encoding)
Response 
{
  "id": { "hex": "0x1234...abcd", "base58": "3xYz..." },
  "charities": [
    {
      "id": "charity_abc",
      "slug": "red-cross",
      "name": "American Red Cross",
      "weight": "60",
      "...": "other charity fields"
    }
  ],
  "users": [],
  "stats": {
    "channels": {
      "1": { "0xA0b8...": "1000000000000000000" },
      "900": { "So11...": "500000000" }
    },
    "usdDonatedE6": "150000000",
    "donationCount": "42",
    "firstDonationDate": "2025-01-15T12:00:00.000Z",
    "lastDonationDate": "2026-04-20T18:30:00.000Z"
  }
}
The stats object includes:
FieldTypeDescription
channelsobject{ [chainId]: { [tokenAddress]: totalGrossAtomicVolume } }
usdDonatedE6stringTotal USD donated × 10^6
donationCountstringTotal number of donations
firstDonationDatestring | nullISO 8601 timestamp of first donation, or null
lastDonationDatestring | nullISO 8601 timestamp of most recent donation, or null
Error responses
StatusCodeDescription
400VALIDATION_ERRORInvalid config ID format
404NOT_FOUNDNo config found with the given ID

​
Delete a config

DELETE /configs/{configId} Deletes a config. Returns 204 No Content on success with an empty body. 
curl -X DELETE https://www.donate.gg/api/v1/configs/0x1234...abcd \
  -H "donate-api-key: YOUR_API_KEY"
Path parameters
ParameterDescription
configIdThe config ID (hex string or base58 encoding)
Configs that have existing donations or linked entities (e.g. partner contracts) cannot be deleted.
Error responses
StatusCodeDescription
400VALIDATION_ERRORInvalid config ID format
403FORBIDDENYou do not own this config
404NOT_FOUNDConfig not found
409HAS_DONATIONSConfig has existing donations and cannot be deleted
409HAS_LINKED_ENTITIESConfig has linked entities and cannot be deleted

​
Partner API operations for configs

Config creation and project-wide listing are available in the Partner API: