Sign in

v1

latestOpenAPI 3.0.12026-07-2427125325.2 KB
List

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

get/recipients

Query parameters

querystring
Example:Leadership in Energy and Environmental Design

The keyword to search for.

locationinteger
Example:4990729

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

geo_id_type'geonameid'

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

location_type'funder' | 'recipient' | 'area_served'

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.

yearinteger[]

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).

[
  2015
]
subjectstring[]

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.

[
  "SN020103"
]
populationstring[]

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.

[
  "PE03"
]
supportstring[]

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.

[
  "UF04"
]
transactionstring[]

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.

[
  "TA"
]
recip_idstring[]

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.

[
  "279278"
]
funder_idstring[]

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.

[
  "KRES002"
]
id_type'ein'

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.

include_gov'yes' | 'no'

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

min_amtinteger

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

max_amtinteger
Example:1000000

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

sort_by'recip_name' | 'recip_city' | 'recip_state' | 'recip_country' | 'amount' | 'count'

Value by which to sort the list results

last_updatedstring date
Example:2021-01-01

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).

sort_order'asc' | 'desc'

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

pageinteger
Example:1

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

format'json' | 'xml'

Defines the format of the response.

profile_levelsstring
Example:gold

Comma separated list of GS seal levels to search for.

Response

Array of the recipients' profile, grant amount, and grant counts that match the criteria searched.

Example response

{
  "meta": {
    "code": 200,
    "status": "OK",
    "elapsed_time": "0:00:00.126063",
    "time": "2021-01-01T01:01:01.000Z"
  },
  "data": {
    "total_hits": 150000,
    "num_pages": 5000,
    "rows": [
      {
        "recipient_key": "279943",
        "recip_name": "Candid",
        "recip_city": "New York City",
        "recip_state": "NY",
        "recip_country": "United States",
        "recip_gs_profile_link": "https://www.guidestar.org/Profile/13-1837418",
        "recip_gs_profile_update_level": "Platinum 2021",
        "ein": "13-1837418",
        "last_updated": "2020-06-03 09:16:08.367",
        "amount_usd": 23808328,
        "grant_count": 209
      }
    ]
  }
}