Sign in

v1

latestOpenAPI 3.0.12026-07-2427125325.2 KB
summary

Search for total grant summaries that match the criteria specified.

get/summary

Query parameters

querystring
Example:Equitable Development

Keyword to search for.

locationinteger
Example:6252001

Geoname ID for the location to search. (e.g. Geonameid '6252001' searches for 'United States').

geo_id_type'geonameid'

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 through a comma separated list. Values are in YYYY format (e.g. 2019).

[
  2019
]
subjectstring[]

The subject code to search on. For example, the subject code 'SN0201' searches for 'Urban development'. 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.

[
  "SN0201"
]
populationstring[]

The population code to search on. For example, the population code 'PG0302' searches for 'Low-income people'. 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.

[
  "PG0302"
]
supportstring[]

Select the support strategy code to search on. For example, the support strategy code 'UA' searches for 'General support'. 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.

[
  "UA"
]
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 recipient ID '321486' searches for 'Bedford Stuyvesant Restoration Corportaion'. 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.

[
  "321486"
]
funder_idstring[]

The funder key to search on. For example, the funder ID 'KRES002' searches for 'Kresge Foundation'. Multiple funder keys can be selected through a comma separated list. 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. 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

format'json' | 'xml'

Defines the format of the response.

profile_levelsstring
Example:platinum

Comma separated list of GS seal levels to search for.

Response

Response includes number of grants, value of grants, number of foundations, and number of recipients that match the criteria searched.

Example response

{
  "meta": {
    "code": 200,
    "status": "OK",
    "time": "2021-01-01T01:01:01.000Z"
  },
  "data": {
    "number_of_grants": 57,
    "value_of_grants": 74949700,
    "number_of_foundations": 39,
    "number_of_recipients": 25
  }
}