ballerinax/candid Ballerina library

Overview

Candid provides a comprehensive database of information about nonprofits, foundations, grantmakers, and philanthropists. Its mission is to connect people who want to change the world to the resources they need.

The Candid connector is designed to interface with Candid.org's API, enabling developers to access Candid's resources programmatically. It supports searching for nonprofit organizations, accessing grant data, and retrieving philanthropic trends and insights.

Key Features

• Access comprehensive nonprofit and philanthropy data
• Support for Charity Check PDF API for compliance reports
• Lightweight access to basic nonprofit information via Essentials API
• Detailed financial, staffing, and DEI data via Premier API
• Streamlined integration with Candid.org's resource database

Setup guide

To use the Candid.org Connector in Ballerina, you must first obtain an API key from Candid.org.

Step 1: Visit Candid's developer API access page

1. Visit Candid's Developer API Access page.
2. Review the documentation to understand the type of access suits your need.

Step 2: Request API access

• For a Trial Account: If you're looking for trial access to explore Candid's API, complete the form to request trial access. Candid.org will review your request and get in touch with you regarding your trial API key.

  

• For a Production Account: If you require access for production use, fill out the form to initiate the process. Candid.org will contact you to discuss your needs and provide you with a production API key.

  

Quickstart

To use the Candid connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the connector

Import the relevent Candid module into your Ballerina project.

Charity Check PDF API

import ballerinax/candid.charitycheckpdf;

Essentials API

import ballerinax/candid.essentials;

Premier API

import ballerinax/candid.premier;

Step 2: Instantiate a new connector

Create an instance of ApiKeysConfig with the obtained Subscription Key and initialize the connector with it.

Charity Check PDF API

charitycheckpdf:ApiKeysConfig apiKeyConfig = {
    subscriptionKey: "ENTER-THE-SUBSCRIPTION-KEY"
};
charitycheckpdf:Client charitycheckpdf = check new (apiKeyConfig);

Essentials API

essentials:ApiKeysConfig apiKeyConfig = {
    subscriptionKey: "ENTER-THE-SUBSCRIPTION-KEY"
};
essentials:Client essentials = check new (apiKeyConfig);

Premier API

premier:ApiKeysConfig apiKeyConfig = {
    subscriptionKey: "ENTER-THE-SUBSCRIPTION-KEY"
};
premier:Client premier = check new (apiKeyConfig);

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

Charity Check PDF API

The following Ballerina program generates a PDF report to validate nonprofit status and eligibility with a 100% IRS-compliant charity check.

http:Response|error result = charitycheckpdf->/v1/pdf/["EMP-ID-NUM"];

Essentials API

The following Ballerina program finds nonprofits using search criterias and explore essential information.

essentials:V3Query query = {
    search_terms: "candid"
};
essentials:V3EssentialsResponse|error result = essentials->/v3.post(query);

Premier API

The following Ballerina program retrieves data on a nonprofit's financials, people, DEI, and IRS compliance validation for the given employer id number.

premier:V3PublicProfile|error result = check premier->/v3/["EMP-ID-NUM"];

Step 4: Run the Ballerina application

bal run

Examples

The Candid connector provides practical examples illustrating usage in various scenarios. Explore these examples to understand how to interact with the Candid.org API for tasks such as generating compliance reports, searching for essential nonprofit information, and retrieving detailed employer data.

1. Generate Charity Check PDF - Generate a detailed Charity Check PDF for a specified nonprofit organization using Candid.org's API.

2. Search Essential Information - Search for and retrieve essential information about nonprofit organizations through the Candid.org Essentials API.

3. Get Employer Information - Obtain comprehensive employer information for nonprofit organizations using the Candid.org Premier API.