Skip to content

Connecting to DonorSearch#

First Steps with DonorSearch#

Reach out to DonorSearch for information on how to get an account.

Cost

Reach out to DonorSearch for cost information.

Rate Limits

Reach out to DonorSearch for rate limit information.

How to Connect DataDistillr to DonorSearch#

To set up a data source connection for DonorSearch, you will need to have:

  • A unique name for your data source connection to be used in queries
  • The API Key generated by your DonorSearch account

Data Source Form#

To locate the DonorSearch form, follow the steps in Connecting Your Data to DataDistillr. When you get to the window to choose the data source type, select API as shown below.

Data Source Wizard

On the API screen, select DonorSearch from the list of API forms.

List of APIs

The following form will appear. Instructions can be found below on how to find the information required to fill each field on the DonorSearch API form.

Once you have filled out all the fields, press the green 'Save' button, and your API will be connected!

DonorSearch Form

Name#

Enter any name that will help you recognize this data source from within your query window.

Acceptable Characters Include

  • lowercase alphanumeric characters
  • underscores

API Key#

You can find your unique DonorSearch API Key your DonorSearch account profile when you log in. Go to Account Settings, then navigate to API Key view/edit.

Endpoints#

The table below shows a list of endpoints available to connect within the DataDistillr application. If you need to connect to an endpoint not listed below, please use the Custom API Form.

Endpoint Required Optional Description
donor_search firstName
lastName
homeState		 middleName
homeStreetAddress
homeCity
homeZip
Employer
Age
Telephone		 Obtain information about donors

The endpoints above will display as follows in the nav tree once your API has successfully connected.

DonorSearch Endpoints

Sample Queries#

The following query is intended to help you get started, and make life simpler querying within your API.

For the following example, suppose that my DonorSearch API data source was called mydonorsearchapi and I want to query an endpoint. The endpoint goes after the DonorSearch data source name:

FROM Clause

FROM `mydonorsearchapi`.`<ENDPOINT>`

Get Donor Info#

After filling in sampleFirstName, sampleLastName, sampleState, and replacing 1234567890 with a valid telephone number, this sample query will return information on donors.

SELECT * FROM donor_search.ds
WHERE firstName = 'sampleFirstName' and
lastName = 'sampleLastName' and
homeState = 'sampleState' and
Telephone = '1234567890'
LIMIT 1000