APIsDatasetsUser guidesChangelog
APIs
Log inFree trial

/recipients

get
https://api.candid.org/grants/v1/recipients

Search for recipient grant activity based on the criteria specified. Returns a maximum of 25 results.

Query Params
string

The keyword to search for.

integer

The Geoname ID for the location to search. For example, the Geonameid '4990729' searches for 'Detroit'.

string
enum

Select the geo ID type for the location parameter to search on. The only supported geo ID type is geonameid.

Allowed:
string
enum

Select how the location parameter is applied for search results. "funder" represents the location of the funder, "recipient" represents the location of the recipient, and "area_served" represents the location where the funding was used.

Allowed:
year
array of integers

The year a grant was awarded to search on. Multiple years can be selected by passing a comma separated list. Values are in YYYY format (e.g. 2021).

year
subject
array of strings

The subject code to search on. For example, the subject code 'SN020103' searches for 'Green building'. Multiple subject codes can be selected by passing a comma separated list without spaces. Remove any trailing zeros from the end of the PCS code.

subject
population
array of strings

The population code to search on. For example, the population code 'PE03' searches for 'People of African descent'. Multiple population codes can be selected by passing a comma separated list without spaces. Remove any trailing zeros from the end of the PCS code.

population
support
array of strings

The support stragey code to search on. For example, the support strategy code 'UF04' searches for 'Building and renovations'. Multiple support strategy codes can be selected by passing a comma separated list without spaces. Remove any trailing zeros from the end of the PCS code.

support
transaction
array of strings

The transaction code to search on. For example, the transaction code 'TA' searches for 'Cash grants'. Multiple transaction codes can be selected by passing a comma separated list without spaces. Remove any trailing zeros from the end of the PCS code.

transaction
recip_id
array of strings

The recipient key to search on. For example, the recip ID '279278' searches for "Focus:HOPE". Multiple recipient keys can be selected by passing a comma separated list. This parameter also accepts EIN, but only in conjunction with the id_type parameter.

recip_id
funder_id
array of strings

The funder key to search on. Multiple funder keys can be selected by passing a comma separated list. For example, the funder ID 'KRES002' searches for 'Kresge Foundation'. This parameter also accepts EIN, but only in conjunction with the id_type parameter.

funder_id
string
enum

Select the id_type when looking up the recipient or funder by their EIN; accepts 'EIN' in 123456789 format. Do not specify this parameter when using the recipient or funder key.

Allowed:
string
enum

Select if U.S. Government grantmakers should be listed in the search results.

Allowed:
integer

Minimum dollar amount (in USD) of grants to consider for search results

integer

Maximum dollar amount (in USD) of grants to consider for search results

string
enum

Value by which to sort the list results

Allowed:
date

Select the records for search results by the added or updated date. The list will include everything on or after the date specified (format yyyy-mm-dd, e.g. 2020-01-01).

string
enum

The order to sort the search results one of “asc” or “desc”.

Allowed:
integer
1 to 100

Select the page number for search results. If page is not specified, it defaults to 1. The maximum page value is 100.

string
enum

Defines the format of the response.

Allowed:
string

Comma separated list of GS seal levels to search for.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 2 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json

Updated over 2 years ago