v1

latestOpenAPI 3.0.12026-07-2427125325.2 KB
News Search

/news/v1/search

Access the only API on the market delivering real-time, actionable news on nonprofits, philanthropy, and the social sector, curated by Candid from over 65,000 sources.

get/v1/search

Query parameters

search_termsstring
Example:Tree planting

Term(s) to search in Candid’s news sources.

start_datestring date
Example:2021-09-01

The oldest article publication date to search from in the format yyyy-MM-dd. Default is one month before today's date, and the earliest possible value is 2018-09-24. The start_date and end_date can be at most one year apart.

end_datestring date
Example:2021-10-01

The most recent article publication date to search to in the format yyyy-MM-dd. Default is today's date. The start_date and end_date can be at most one year apart.

added_start_datestring date-time
Example:2021-09-01T17:32:18.1169712Z

A filter, along with added_end_date, based on the date an article was added to the Candid News database, in the format yyyy-MM-ddTHH:mm:ss.fffffffZ. Default is one month before today's date. The added_start_date and added_end_date fields can be at most one year apart. The earliest added_start_date to search from is 2018-09-24

added_end_datestring date-time
Example:2021-10-02T17:32:18.1169712Z

A filter, along with added_start_date, based on the date an article was added to the Candid News database in the format yyyy-MM-ddTHH:mm:ss.fffffffZ. Default is today's date. The added_start_date and added_end_date fields can be at most one year apart.

einsstring[]

A list of up to 25 organization EINs each of which formatted with or without a dash. Multiple values should be joined using OR.

organizationsstring[]

A list of up to 25 organization names. Multiple values should be joined using OR.

locationsinteger[]

A list of up to 25 geoName IDs for locations. Multiple values should be joined using OR. Contact Candid for a JSON file of all Candid-supported GeoName IDs.

subjectsstring[]

A list of up to 25 Candid Philanthropy Classification System (PCS) Subject Facet codes (eg. ST000000, SR040000, SA010200, etc). Top-level PCS codes will include searches for all related child codes. Multiple values should be joined using OR.

populationsstring[]

A list of up to 25 Candid Philanthropy Classification System (PCS) Population Facet codes (eg. PC000000, PG010000, PE050000, etc). Top-level PCS codes will include searches for all related child codes. Multiple values should be joined using OR.

peoplestring[]

A list of up to 25 names of people by which to filter news articles. Multiple values should be joined using OR.

sources_includestring[]

A list of up to 25 names of news source to include. Accepts up to 25, multiple values should be joined using OR.

sources_excludestring[]

A list of up to 25 names of news sources to exclude. Accepts up to 25, multiple values should be joined using OR.

staff_change_mentionedboolean

Indicates whether to return articles containing mentions of staff changes. If true, only articles that mention staff changes will be returned. If false, only articles that do not mention staff changes will be returned. If null, articles will be returned regardless of staff changes mentioned.

rfp_mentionedboolean

Indicates whether to return articles containing mentions of rfp. If true, only articles containing mentions of RFPs will be returned. If false, only articles not containing mentions of RFPs will be returned. If null, articles will be returned regardless of RFPs mentioned.

grant_mentionedboolean

Indicates whether to return articles containing mentions of grants. If true, only articles containing mentions of grants will be returned. If false, only articles not containing mentions of grants will be returned. If null, articles will be returned regardless of grants mentioned.

filter_operator'AND' | 'OR'

Determines the union type for searches for the following parameters Subjects, Populations, Locations, People, and Organizations. Default is AND. Note that inter-array parameter values are not affected by the filter operator.

advisory_contentboolean

Advisory content is flagged for organizations or people in the social sector that may or may not require due diligence. True = Only return articles flagged as advisory content. False = Do not return articles flagged as advisory content. Null = Return articles regardless of advisory content.

sort_order'desc' | 'asc'

The direction to sort the results by publication date, either "asc" (ascending) or "desc" (descending). Default is 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 the total number of results divided by 25.

Response

OK

Example response

{
  "meta": {
    "code": 200,
    "status": "OK",
    "time": "2021-01-01T01:01:01.000Z",
    "article_count": 1621,
    "page_count": 67,
    "parameters": {
      "search_terms": "Tree planting",
      "start_date": "2020-01-01",
      "end_date": "2020-12-31",
      "added_start_date": "2021-08-01T17:32:18.1169712Z",
      "added_end_date": "2021-08-02T17:32:18.1169712Z",
      "filter_operator": "AND",
      "staff_change_mentioned": true,
      "rfp_mentioned": true,
      "grant_mentioned": true,
      "advisory_content": true,
      "sort_order": "desc",
      "page": 1
    }
  },
  "data": [
    {
      "data_id": 5419718,
      "title": "Candid Announces Three New Appointments to Board of Trustees",
      "content": "Candid announced the appointment this month of...",
      "publication_date": "2020-03-31T00:14:11.647Z",
      "added_date": "2021-08-01T17:32:18.1169712",
      "author": "Candid",
      "link": "https://www.prweb.com/releases/candid_announces_three_new_appointments_to_board_of_trustees/prweb17831736.htm",
      "image": "https://ww1.prweb.com/prfiles/2021/03/29/17831736/gI_145751_NewsImage_vcsPRAsset_3781265_145751_e773fde5-b617-4001-8b99-ae767b935333_0.png",
      "site_name": "PRWeb",
      "base_url": "https://www.prweb.com",
      "icon_url": "https://www.prnewswire.com/content/dam/prnewswire/icons/2019-Q4-PRN-Icon-32-32.png",
      "philanthropy_classification_system": [
        {
          "subjects": [
            {
              "taxonomy_code": "SP030000",
              "taxonomy_code_description": "Universal Design"
            }
          ],
          "populations": [
            {
              "taxonomy_code": "PE000000",
              "taxonomy_code_description": "Ethnic and Racial Groups"
            }
          ]
        }
      ],
      "most_relevant_organizations": [
        {
          "name": "Michigan Nonprofit Association",
          "org_type": "recipient",
          "profile_link": "https://www.guidestar.org/profile/38-2959692",
          "profile_link_type": "guidestar",
          "ein": "38-2959692",
          "org_salience_score": 0.9595482
        }
      ],
      "locations_mentioned": [
        {
          "location_name": "Detroit, MI"
        }
      ],
      "grant_mentioned": true,
      "advisory_content": true,
      "scores": {
        "article_score": 0.8396587,
        "grant_mentioned_confidence": 0.6595482,
        "rfp_mentioned_confidence": 0.4394065,
        "advisory_content_confidence": 0.9355742,
        "staff_change_mentioned_confidence": 0.5034921
      }
    }
  ]
}