{"openapi":"3.0.1","info":{"title":"Grants API","description":"Leverage advanced search and filters to analyze the most comprehensive and accurate data on grants, funders, recipients, and funding activity.","version":"1.0.1"},"servers":[{"url":"https://api.candid.org/grants/v1"}],"paths":{"/summary":{"get":{"tags":["summary"],"description":"Search for total grant summaries that match the criteria specified.","operationId":"grants_summary","parameters":[{"name":"query","in":"query","description":"Keyword to search for.","schema":{"type":"string","example":"Equitable Development","x-global":true},"x-global":true},{"name":"location","in":"query","description":"Geoname ID for the location to search. (e.g. Geonameid '6252001' searches for 'United States').","schema":{"type":"integer","example":6252001,"x-global":true},"x-global":true},{"name":"geo_id_type","in":"query","description":"Geo ID type for the location parameter to search on. The only supported geo ID type is geonameid.","schema":{"type":"string","example":"","enum":["geonameid"],"x-global":true},"x-global":true},{"name":"location_type","in":"query","description":"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.","schema":{"type":"string","example":"","enum":["funder","recipient","area_served"],"x-global":true},"x-global":true},{"name":"year","in":"query","description":"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).","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","example":2019},"x-global":true},"x-global":true},{"name":"subject","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"SN0201"},"x-global":true},"x-global":true},{"name":"population","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"PG0302"},"x-global":true},"x-global":true},{"name":"support","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"UA"},"x-global":true},"x-global":true},{"name":"transaction","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"TA"},"x-global":true},"x-global":true},{"name":"recip_id","in":"query","description":"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.","explode":false,"schema":{"type":"array","items":{"type":"string","example":"321486"},"x-global":true},"x-global":true},{"name":"funder_id","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"KRES002"},"x-global":true},"x-global":true},{"name":"id_type","in":"query","description":"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.","schema":{"type":"string","example":"","enum":["ein"],"x-global":true},"x-global":true},{"name":"include_gov","in":"query","description":"Select if U.S. Government grantmakers should be listed in the search results.","schema":{"type":"string","example":"","enum":["yes","no"],"x-global":true},"x-global":true},{"name":"min_amt","in":"query","description":"Minimum dollar amount (in USD) of grants to consider for search results","schema":{"type":"integer","example":0,"x-global":true},"x-global":true},{"name":"max_amt","in":"query","description":"Maximum dollar amount (in USD) of grants to consider for search results","schema":{"type":"integer","example":1000000,"x-global":true},"x-global":true},{"name":"format","in":"query","description":"Defines the format of the response.","schema":{"type":"string","example":"","enum":["json","xml"],"x-global":true},"x-global":true},{"name":"profile_levels","in":"query","description":"Comma separated list of GS seal levels to search for.","schema":{"type":"string","example":"platinum","x-global":true},"x-global":true}],"responses":{"200":{"description":"Response includes number of grants, value of grants, number of foundations, and number of recipients that match the criteria searched.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":200},"status":{"type":"string","description":"Description of the HTTP response status code.","example":"OK"},"elapsed_time":{"type":"string","description":"Elapsed time of API call in milliseconds.","example":1},"time":{"type":"string","description":"Time of API call.","example":"2021-01-01T01:01:01.000Z"}}},"data":{"type":"object","properties":{"number_of_grants":{"type":"integer","description":"Total number of grants awarded that meet the search criteria","example":57},"value_of_grants":{"type":"number","description":"Total sum of dollar value of grants awarded that meet the search criteria","example":74949700},"number_of_foundations":{"type":"integer","description":"Total number of funders that awarded a grant that meet the search criteria","example":39},"number_of_recipients":{"type":"integer","description":"Total number of recipients that received a grant that meet the search criteria","example":25}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}},"text/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}},"text/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"No Results Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}},"text/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}},"text/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/funders":{"get":{"tags":["List"],"description":"Search for funders' grant activity based on the criteria specified. Returns a maximum of 25 results.","operationId":"grants_funders","parameters":[{"name":"query","in":"query","description":"The keyword to search for.","schema":{"type":"string","example":"Restaurant","x-global":true},"x-global":true},{"name":"location","in":"query","description":"The Geoname ID for the location to search. For example, the Geoname ID '6252001' searches for 'United States'.","schema":{"type":"integer","example":6252001,"x-global":true},"x-global":true},{"name":"geo_id_type","in":"query","description":"The geo ID type for the location parameter to search on. The only supported geo ID type is geonameid.","schema":{"type":"string","example":"","enum":["geonameid"],"x-global":true},"x-global":true},{"name":"location_type","in":"query","description":"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.","schema":{"type":"string","example":"","enum":["funder","recipient","area_served"],"x-global":true},"x-global":true},{"name":"year","in":"query","description":"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. 2020).","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","example":2020},"x-global":true},"x-global":true},{"name":"subject","in":"query","description":"The subject code to search on. For example, the subject code 'SE' searches for 'Health'. 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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"SE"},"x-global":true},"x-global":true},{"name":"population","in":"query","description":"The population code to search on. For example. the population code 'PA' searches for 'Age groups'. 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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"PA"},"x-global":true},"x-global":true},{"name":"support","in":"query","description":"The support strategy code to search on. For example 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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"UA"},"x-global":true},"x-global":true},{"name":"transaction","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"TA"},"x-global":true},"x-global":true},{"name":"recip_id","in":"query","description":"The recipient key to search on. For example, the recip ID '532410' searches for 'Hot Bread Kitchen Ltd'. 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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"532410"},"x-global":true},"x-global":true},{"name":"funder_id","in":"query","description":"The funder key to search on. For example, the funder ID '7190908' searches for 'Restaurant Workers Community Foundation'. Multiple funder keys can be selected by passing a comma separated list. This parameter also accepts EIN, but only in conjunction with the id_type parameter.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"7190908"},"x-global":true},"x-global":true},{"name":"id_type","in":"query","description":"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.","schema":{"type":"string","example":"","enum":["ein"],"x-global":true},"x-global":true},{"name":"include_gov","in":"query","description":"Select if U.S. Government grantmakers should be listed in the search results.","schema":{"type":"string","example":"","enum":["yes","no"],"x-global":true},"x-global":true},{"name":"min_amt","in":"query","description":"Minimum dollar amount (in USD) of grants to consider for search results","schema":{"type":"integer","example":0,"x-global":true},"x-global":true},{"name":"max_amt","in":"query","description":"Maximum dollar amount (in USD) of grants to consider for search results","schema":{"type":"integer","example":987654321,"x-global":true},"x-global":true},{"name":"sort_by","in":"query","description":"Value by which to sort the list of results","schema":{"type":"string","example":"","enum":["funder_name","funder_city","funder_state","funder_country","amount","count"]}},{"name":"last_updated","in":"query","description":"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).","schema":{"type":"string","format":"date","example":"2021-05-06","x-global":true},"x-global":true},{"name":"sort_order","in":"query","description":"The order to sort the search results, one of \"asc\" or \"desc\".","schema":{"type":"string","example":"","enum":["asc","desc"],"x-global":true},"x-global":true},{"name":"page","in":"query","description":"The page number for search results. If page is not specified, it defaults to 1. The maximum page value is 100.","schema":{"maximum":100,"minimum":1,"type":"integer","example":1,"x-global":true},"x-global":true},{"name":"format","in":"query","description":"Defines the format of the response.","schema":{"type":"string","example":"","enum":["json","xml"],"x-global":true},"x-global":true},{"name":"profile_levels","in":"query","description":"Comma seperated list of GS seal levels to search for.","schema":{"type":"string","example":"bronze","x-global":true},"x-global":true}],"responses":{"200":{"description":"Array of the funders' profile, grant amount, and grant counts that match the criteria searched.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":200},"status":{"type":"string","description":"Description of the HTTP response status code.","example":"OK"},"elapsed_time":{"type":"string","description":"Elapsed time of API call in milliseconds.","example":"0:00:00.610852"},"time":{"type":"string","description":"Time of API call.","example":"2021-01-01T01:01:01.000Z"}}},"data":{"type":"object","properties":{"total_hits":{"type":"integer","description":"Total number of results returned","example":150000},"num_pages":{"type":"integer","description":"Total number of pages returned","example":5000},"rows":{"type":"array","items":{"type":"object","properties":{"funder_key":{"type":"string","description":"Unique identifier assigned to each organization awarding a transaction","example":"SANF001"},"funder_profile_url":{"type":"string","description":"Funder or Grantmaker Foundation Directory profile link","example":"https://fconline.foundationcenter.org/fdo-grantmaker-profile?key=SANF001"},"funder_gs_profile_update_level":{"type":"string","description":"Funder or Grantmaker seal level of transparency profile level","example":"Silver 2020"},"funder_name":{"type":"string","description":"Funder or Grantmaker name","example":"The San Francisco Foundation"},"funder_city":{"type":"string","description":"Funder or Grantmaker city","example":"San Francisco"},"funder_state":{"type":"string","description":"Funder or Grantmaker state","example":"CA"},"funder_country":{"type":"string","description":"Funder or Grantmaker country","example":"United States"},"funder_is_federal":{"type":"boolean","description":"Indentifier if funder is a federal grantmaker","example":false},"ein":{"type":"string","description":"Funder or Grantmaker IRS Employer Identification Number","example":"01-0679337"},"last_updated":{"type":"string","description":"Date when the funder record was published or updated by candid","example":"2021-02-08 14:38:17.660"},"amount_usd":{"type":"number","description":"Total sum of dollar value of grants given by the funder that meet the search criteria","example":82000},"grant_count":{"type":"integer","description":"Total number of grants given by the funder that meet the search criteria","example":4}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}},"text/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}},"text/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"No Results Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}},"text/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}},"text/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/recipients":{"get":{"tags":["List"],"description":"Search for recipient grant activity based on the criteria specified. Returns a maximum of 25 results.","operationId":"grants_recipients","parameters":[{"name":"query","in":"query","description":"The keyword to search for.","schema":{"type":"string","example":"Leadership in Energy and Environmental Design","x-global":true},"x-global":true},{"name":"location","in":"query","description":"The Geoname ID for the location to search. For example, the Geonameid '4990729' searches for 'Detroit'.","schema":{"type":"integer","example":4990729,"x-global":true},"x-global":true},{"name":"geo_id_type","in":"query","description":"Select the geo ID type for the location parameter to search on. The only supported geo ID type is geonameid.","schema":{"type":"string","example":"","enum":["geonameid"],"x-global":true},"x-global":true},{"name":"location_type","in":"query","description":"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.","schema":{"type":"string","example":"","enum":["funder","recipient","area_served"],"x-global":true},"x-global":true},{"name":"year","in":"query","description":"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).","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","example":2015},"x-global":true},"x-global":true},{"name":"subject","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"SN020103"},"x-global":true},"x-global":true},{"name":"population","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"PE03"},"x-global":true},"x-global":true},{"name":"support","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"UF04"},"x-global":true},"x-global":true},{"name":"transaction","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"TA"},"x-global":true},"x-global":true},{"name":"recip_id","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"279278"},"x-global":true},"x-global":true},{"name":"funder_id","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"KRES002"},"x-global":true},"x-global":true},{"name":"id_type","in":"query","description":"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.","schema":{"type":"string","example":"","enum":["ein"],"x-global":true},"x-global":true},{"name":"include_gov","in":"query","description":"Select if U.S. Government grantmakers should be listed in the search results.","schema":{"type":"string","example":"","enum":["yes","no"],"x-global":true},"x-global":true},{"name":"min_amt","in":"query","description":"Minimum dollar amount (in USD) of grants to consider for search results","schema":{"type":"integer","example":0,"x-global":true},"x-global":true},{"name":"max_amt","in":"query","description":"Maximum dollar amount (in USD) of grants to consider for search results","schema":{"type":"integer","example":1000000,"x-global":true},"x-global":true},{"name":"sort_by","in":"query","description":"Value by which to sort the list results","schema":{"type":"string","example":"","enum":["recip_name","recip_city","recip_state","recip_country","amount","count"]}},{"name":"last_updated","in":"query","description":"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).","schema":{"type":"string","format":"date","example":"2021-01-01","x-global":true},"x-global":true},{"name":"sort_order","in":"query","description":"The order to sort the search results  one of “asc” or “desc”.","schema":{"type":"string","example":"","enum":["asc","desc"],"x-global":true},"x-global":true},{"name":"page","in":"query","description":"Select the page number for search results. If page is not specified, it defaults to 1. The maximum page value is 100.","schema":{"maximum":100,"minimum":1,"type":"integer","example":1,"x-global":true},"x-global":true},{"name":"format","in":"query","description":"Defines the format of the response.","schema":{"type":"string","example":"","enum":["json","xml"],"x-global":true},"x-global":true},{"name":"profile_levels","in":"query","description":"Comma separated list of GS seal levels to search for.","schema":{"type":"string","example":"gold","x-global":true},"x-global":true}],"responses":{"200":{"description":"Array of the recipients' profile, grant amount, and grant counts that match the criteria searched.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":200},"status":{"type":"string","description":"Description of the HTTP response status code.","example":"OK"},"elapsed_time":{"type":"string","description":"Elapsed time of API call in milliseconds.","example":"0:00:00.126063"},"time":{"type":"string","description":"Time of API call.","example":"2021-01-01T01:01:01.000Z"}}},"data":{"type":"object","properties":{"total_hits":{"type":"integer","description":"Total number of results returned","example":150000},"num_pages":{"type":"integer","description":"Total number of pages returned","example":5000},"rows":{"type":"array","items":{"type":"object","properties":{"recipient_key":{"type":"string","description":"Unique identifier assigned to each organization awarded a transaction","example":"279943"},"recip_name":{"type":"string","description":"Recipient name","example":"Candid"},"recip_city":{"type":"string","description":"Recipient city","example":"New York City"},"recip_state":{"type":"string","description":"Recipient state","example":"NY"},"recip_country":{"type":"string","description":"Recipient country","example":"United States"},"recip_gs_profile_link":{"type":"string","description":"Recipient GuideStar profile link","example":"https://www.guidestar.org/Profile/13-1837418"},"recip_gs_profile_update_level":{"type":"string","description":"Recipient seal level of transparency profile level","example":"Platinum 2021"},"ein":{"type":"string","description":"Recipient IRS Employer Identification Number","example":"13-1837418"},"last_updated":{"type":"string","description":"Date when the grant record was published or updated by candid","example":"2020-06-03 09:16:08.367"},"amount_usd":{"type":"number","description":"Total sum of dollar value of grants awarded to the recipient that meet the search criteria","example":23808328},"grant_count":{"type":"integer","description":"Total number of grants awarded to the recipient that meet the search criteria","example":209}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}},"text/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}},"text/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"No Results Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}},"text/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}},"text/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/transactions":{"get":{"tags":["List"],"description":"Search for grant activity based on the criteria specified. Returns a maximum of 25 results.","operationId":"grants_transactions","parameters":[{"name":"query","in":"query","description":"The keyword to search for.","example":"Bill & Melinda Gates Foundation","schema":{"type":"string","x-global":true},"x-global":true},{"name":"location","in":"query","description":"The Geoname ID for the location to search. For example, the Geonameid '6252001' searches for 'United States'.","example":6252001,"schema":{"type":"integer","x-global":true},"x-global":true},{"name":"geo_id_type","in":"query","description":"The geo ID type for the location parameter to search on. Only supported geo ID type is geonameid.","schema":{"type":"string","example":"","enum":["geonameid"],"x-global":true},"x-global":true},{"name":"location_type","in":"query","description":"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.","schema":{"type":"string","example":"","enum":["funder","recipient","area_served"],"x-global":true},"x-global":true},{"name":"year","in":"query","description":"Select 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. 2006).","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","example":2006},"x-global":true},"x-global":true},{"name":"subject","in":"query","description":"The subject code to search on. For example, the subject code 'SD' searches for 'Philanthropy'. 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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"SD"},"x-global":true},"x-global":true},{"name":"population","in":"query","description":"The population code to search on. For example, the population code 'PA' searches for 'Age groups'. 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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"PA"},"x-global":true},"x-global":true},{"name":"support","in":"query","description":"tThe support stragey code to search on. For example, the support strategy code 'UA' searches for 'Program 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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"UN"},"x-global":true},"x-global":true},{"name":"transaction","in":"query","description":"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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"TA"},"x-global":true},"x-global":true},{"name":"recip_id","in":"query","description":"The recipient key to search on. For example, the recip ID '839229' searches for 'William and Flora Hewlett Foundation'. 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.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":839229},"x-global":true},"x-global":true},{"name":"funder_id","in":"query","description":"The funder key to search on. For example, the funder ID 'GATE023' searches for 'Bill & Melinda Gates Foundation'. Multiple funder keys can be selected by passing a comma separated list. This parameter also accepts EIN, but only in conjunction with the id_type parameter.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","example":"GATE023"},"x-global":true},"x-global":true},{"name":"id_type","in":"query","description":"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.","schema":{"type":"string","example":"","enum":["ein"],"x-global":true},"x-global":true},{"name":"include_gov","in":"query","description":"Select if U.S. Government grantmakers should be listed in the search results.","schema":{"type":"string","example":"","enum":["yes","no"],"x-global":true},"x-global":true},{"name":"min_amt","in":"query","description":"Minimum dollar amount (in USD) of grants to consider for search results","schema":{"type":"integer","example":0,"x-global":true},"x-global":true},{"name":"max_amt","in":"query","description":"Maximum dollar amount (in USD) of grants to consider for search results","schema":{"type":"integer","example":44000000,"x-global":true},"x-global":true},{"name":"sort_by","in":"query","description":"Value by which to sort the list results","schema":{"type":"string","example":"","enum":["funder_name","recip_name","year_issued","amount","count"]}},{"name":"last_updated","in":"query","description":"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).","schema":{"type":"string","format":"date","example":"2016-04-08","x-global":true},"x-global":true},{"name":"sort_order","in":"query","description":"The order to sort the search results one of “asc” or “desc”.","schema":{"type":"string","example":"","enum":["asc","desc"],"x-global":true},"x-global":true},{"name":"page","in":"query","description":"Select the page number for search results. If page is not specified, it defaults to 1. The maximum page value is 100.","schema":{"maximum":100,"minimum":1,"type":"integer","example":1,"x-global":true},"x-global":true},{"name":"format","in":"query","description":"Defines the format of the response.","schema":{"type":"string","example":"","enum":["json","xml"],"x-global":true},"x-global":true},{"name":"profile_levels","in":"query","description":"Comma seperated list of GS seal levels to search for.","schema":{"type":"string","example":"silver","x-global":true},"x-global":true}],"responses":{"200":{"description":"Array of the grants' funder, recipient, grant amount and grant description that match the criteria searched.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":200},"status":{"type":"string","description":"Description of the HTTP response status code.","example":"OK"},"elapsed_time":{"type":"string","description":"Elapsed time of API call in milliseconds.","example":"0:00:00.330293"},"time":{"type":"string","description":"Time of API call.","example":"2021-10-19 19:58:48.322882"}}},"data":{"type":"object","properties":{"total_hits":{"type":"integer","description":"Total number of results returned","example":150000},"num_pages":{"type":"integer","description":"Total number of pages returned","example":5000},"rows":{"type":"array","items":{"type":"object","properties":{"funder_key":{"type":"string","description":"Unique identifier assigned to each organization awarding a transaction","example":"GATE023"},"funder_profile_url":{"type":"string","description":"Funder or Grantmaker Foundation Directory profile link","example":"https://fconline.foundationcenter.org/fdo-grantmaker-profile?key=GATE023"},"funder_name":{"type":"string","description":"Funder or Grantmaker name","example":"Bill & Melinda Gates Foundation"},"funder_city":{"type":"string","description":"Funder or Grantmaker city","example":"Seattle"},"funder_state":{"type":"string","description":"Funder or Grantmaker state","example":"WA"},"funder_country":{"type":"string","description":"Funder or Grantmaker country","example":"United States"},"funder_type":{"type":"string","description":"Funder or Grantmaker type","example":"Family foundation"},"funder_zipcode":{"type":"string","description":"Funder or Grantmaker zip code","example":"98109"},"funder_country_code":{"type":"string","description":"Funder or Grantmaker country ISO2 code","example":"6252001"},"funder_ein":{"type":"string","description":"Funder or Grantmaker IRS Employer Identification Number","example":"56-2618866"},"funder_gs_profile_update_level":{"type":"string","description":"Funder or Grantmaker seal level of transparency profile level","example":"Silver 2021"},"recip_key":{"type":"string","description":"Unique identifier assigned to each organization awarded a transaction","example":"846301"},"recip_name":{"type":"string","description":"Recipient name","example":"Center for Global Development"},"recip_city":{"type":"string","description":"Recipient city","example":"Washington"},"recip_state":{"type":"string","description":"Recipient state","example":"DC"},"recip_country":{"type":"string","description":"Recipient country","example":"United States"},"recip_zipcode":{"type":"string","description":"Recipient zip code","example":"20036"},"recip_country_code":{"type":"string","description":"Recipient country ISO2 code","example":"6252001"},"recip_ein":{"type":"string","description":"Funder or Grantmaker IRS Employer Identification Number","example":"52-2351337"},"recip_seal_level":{"deprecated":true,"type":"string","description":"Deprecated","example":""},"recip_organization_code":{"type":"string","description":"Recipient organization code. Identifies the legal status and/or primary function of the organization.","example":"EA040000"},"recip_organization_tran":{"type":"string","description":"Recipient organization code definition","example":"Public charities"},"recip_gs_profile_link":{"type":"string","description":"Recipient GuideStar profile link","example":"https://www.guidestar.org/Profile/52-2351337"},"recip_gs_profile_update_level":{"type":"string","description":"Recipient seal level of transparency profile level","example":"Platinum 2020"},"grant_key":{"type":"string","description":"Unique identifier assigned to each transaction","example":"10335044"},"amount_usd":{"type":"number","description":"Dollar value of grant awarded or authorized in USD","example":10000000},"grant_subject_code":{"type":"string","description":"Grant subject code. Candid assigns subject codes using the Philanthropy Classification System to represent the core activities and services supported by the grant.","example":"SB030000; SE130000; SN020000; ST040000"},"grant_subject_tran":{"type":"string","description":"Grant subject code description","example":"Elementary and secondary education; Public health; Economic development; International development"},"grant_population_code":{"type":"string","description":"Grant population code. Candid assigns subject codes using the Philanthropy Classification System to reflect the populations intended to be served by the grant.","example":"PA010000; PG030200; PJ050100"},"grant_population_tran":{"type":"string","description":"Grant population code definition","example":"Children and youth; Low-income people; Students"},"grant_strategy_code":{"type":"string","description":"Grant support strategy code.  Candid assigns subject codes using the Philanthropy Classification System to reflect the strategy or implementation approach being supported by the grant.","example":"UK0000; UM0100; UN0000"},"grant_strategy_tran":{"type":"string","description":"Grant support strategy code definition","example":"Policy, advocacy and systems reform; Research; Program support"},"grant_transaction_code":{"type":"string","description":"Grant transaction code. Candid assigns grant transaction codes using the Philanthropy Classification System to represent the type of award received.","example":"TA00"},"grant_transaction_tran":{"type":"string","description":"Grant transaction code definition","example":"Cash grants"},"grant_geo_area_code":{"type":"string","description":"Geonameid of the area served by the grant","example":"7100067"},"grant_geo_area_tran":{"type":"string","description":"Geonameid description of the area served by the grant","example":""},"year_issued":{"type":"string","description":"Year that grant was awarded or authorized (fiscal year end)","example":"2006"},"grant_duration":{"type":"string","description":"Duration of grant period (in months)","example":"5.00"},"grant_description":{"type":"string","description":"Grant description","example":"To amplify impact of CGD's policy research and outreach on key public policy debates affecting health, education, governance and economic outcomes in developing world"},"last_updated":{"type":"string","description":"Date when the grant record was published or updated by candid","example":"2016-04-08 16:58:52.377"}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}},"text/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}},"text/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"No Results Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}},"text/json":{"schema":{"$ref":"#/components/schemas/NotAcceptable"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}},"text/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}},"text/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}}},"components":{"parameters":{"query":{"name":"query","in":"query","description":"Select the keyword to search for.","schema":{"type":"string","x-global":true},"x-global":true},"location":{"name":"location","in":"query","description":"Select the Geoname ID for the location to search. Values are obtained from the /lookup/location endpoint (e.g. Geonameid '5128581' searches for 'New York City').","schema":{"type":"integer","x-global":true},"x-global":true},"geo_id_type":{"name":"geo_id_type","in":"query","description":"Select the geo ID type for the location parameter to search on. Only supported geo ID type is geonameid.","schema":{"type":"string","enum":["geonameid"],"x-global":true},"x-global":true},"location_type":{"name":"location_type","in":"query","description":"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.","schema":{"type":"string","enum":["funder","recipient","area_served"],"x-global":true},"x-global":true},"year":{"name":"year","in":"query","description":"Select 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. 2021).","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"},"x-global":true},"x-global":true},"subject":{"name":"subject","in":"query","description":"Select the subject code to search on. Multiple subject codes can be selected through a comma separated list without spaces. Remove any trailing zeros from the end of the PCS code. Values are obtained from the /lookup/code?type=subject endpoint (e.g. subject code 'SA0708' searches for 'Science museums'.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"x-global":true},"x-global":true},"population":{"name":"population","in":"query","description":"Select the population code to search on. Multiple population codes can be selected through a comma separated list without spaces. Remove any trailing zeros from the end of the PCS code. Values are obtained from the /lookup/code?type=population endpoint (e.g. population code 'PD01' searches for 'Families').","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"x-global":true},"x-global":true},"support":{"name":"support","in":"query","description":"Select the support stragey code to search on. Multiple support strategy codes can be selected through a comma separated list without spaces. Remove any trailing zeros from the end of the PCS code. Values are obtained from the /lookup/code?type=strategy endpoint (e.g. support strategy code 'UA' searches for 'General support').","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"x-global":true},"x-global":true},"transaction":{"name":"transaction","in":"query","description":"Select the transaction code to search on. Multiple transaction codes can be selected through a comma separated list without spaces. Remove any trailing zeros from the end of the PCS code. Values are obtained from the /lookup/code?type=transaction endpoint (e.g. transaction code 'TA' searches for 'Cash grants').","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"x-global":true},"x-global":true},"organization_type":{"name":"organization_type","in":"query","description":"Comma separated organization type PCS codes without spaces, obtained from the /lookup/code endpoint. Remove any trailing zeros from the end of the PCS code.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"x-global":true},"x-global":true},"recip_id":{"name":"recip_id","in":"query","description":"Select the recipient key to search on. Multiple recipient keys can be selected through a comma separated list. Value are obtained from the /lookup/organization endpoint (e.g. recip ID '279943' searches for 'Candid'). This parameter also accepts EIN, but must be used in conjunction with the id_type parameter.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"x-global":true},"x-global":true},"funder_id":{"name":"funder_id","in":"query","description":"Select the funder key to search on. Multiple funder keys can be selected through a comma separated list. Value are obtained from the /lookup/organization endpoint (e.g. funder ID 'GATE023' searches for 'Bill & Melinda Gates Foundation'). This parameter also accepts EIN, but must be used in conjunction with the id_type parameter.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"x-global":true},"x-global":true},"id_type":{"name":"id_type","in":"query","description":"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.","schema":{"type":"string","enum":["ein"],"x-global":true},"x-global":true},"min_amt":{"name":"min_amt","in":"query","description":"Minimum dollar amount (USD) of grants to consider for search results","schema":{"type":"integer","example":0,"x-global":true},"x-global":true},"max_amt":{"name":"max_amt","in":"query","description":"Maximum dollar amount (USD) of grants to consider for search results","schema":{"type":"integer","example":0,"x-global":true},"x-global":true},"grant_key":{"name":"grant_key","in":"query","description":"Single grant key.","schema":{"type":"string","x-global":true},"x-global":true},"include_gov":{"name":"include_gov","in":"query","description":"Select if U.S. Government grantmakers should be listed in the search results.","schema":{"type":"string","enum":["yes","no"],"x-global":true},"x-global":true},"sort_by":{"name":"sort_by","in":"query","description":"Select the value to sort the search results (amount or count)","schema":{"type":"string","enum":["amount","count","last_updated"],"x-global":true},"x-global":true},"sort_order":{"name":"sort_order","in":"query","description":"select the order to sort the search results (asc or desc)","schema":{"type":"string","enum":["asc","desc"],"x-global":true},"x-global":true},"page":{"name":"page","in":"query","description":"Select the page number for search results. If page is not specified, it defaults to 1. The maximum page value is 100.","schema":{"maximum":100,"minimum":1,"type":"integer","example":1,"x-global":true},"x-global":true},"last_updated":{"name":"last_updated","in":"query","description":"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).","schema":{"type":"string","format":"date","example":"2003-01-01T00:00:00.000+0000","x-global":true},"x-global":true},"format":{"name":"format","in":"query","description":"Defines the format of the response.","schema":{"type":"string","enum":["json","xml"],"x-global":true},"x-global":true},"profile_levels":{"name":"profile_levels","in":"query","description":"Comma seperated list of GS seal levels to search for.","schema":{"type":"string","x-global":true},"x-global":true}},"schemas":{"BadRequest":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":400},"message":{"type":"string","example":"The request cannot be fulfilled due to bad syntax."}}},"Unauthorized":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":401},"message":{"type":"string","example":"Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API."}}},"Forbidden":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":403},"message":{"type":"string","example":"Forbidden, we found insufficient permissions to grant access to the resources. Please check the detailed message of the response."}}},"NotFound":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":404},"message":{"type":"string","example":"Request was processed successfully but we could not find the resource ein"}}},"NotAcceptable":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":406},"message":{"type":"string","example":"The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request."}}},"TooManyRequests":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":429},"message":{"type":"string","example":"Rate limit is exceeded. Try again later."}}},"InternalServerError":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP response status code.","example":500},"message":{"type":"string","example":"Oh no!, this is bad, something went wrong... please contact API support!"}}}},"securitySchemes":{"apiKeyHeader":{"type":"apiKey","name":"Subscription-Key","in":"header"},"apiKeyQuery":{"type":"apiKey","name":"Subscription-Key","in":"query"}}},"security":[{"apiKeyHeader":[]},{"apiKeyQuery":[]}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}