v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-05-072674388.0 KB
v1

All Articles

Search and filter all news articles available via the Perigon API. The result includes a list of individual articles that were matched to your specific criteria.

get/v1/articles/all

Query parameters

qstring

String. Primary search query for filtering articles based on their title, description, and content. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.

titlestring

String. Search specifically within article headlines/titles. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations.

descstring

String. Search within article description fields. Supports Boolean expressions, exact phrase matching with quotes, and wildcards for flexible pattern matching.

contentstring

String. Search within the full article body content. Supports Boolean logic, exact phrase matching with quotes, and wildcards for comprehensive content searching.

summarystring

String. Search within article summary fields. Supports Boolean expressions, exact phrase matching with quotes, and wildcards for flexible pattern matching.

urlstring

String. Search query on the url field. Semantic similar to q parameter. E.g. could be used for querying certain website sections, e.g. source=cnn.com&url=travel.

articleIdstring[]

String Array. Retrieve specific news articles by their unique article identifiers. Multiple IDs can be provided to return a collection of specific articles.

clusterIdstring[]

String Array. Filter results to only show content within a specific related content cluster. Returns articles grouped together as part of Perigon Stories based on topic relevance.

sortBy'relevance' | 'date' | 'reverseDate' | 'reverseAddDate' | 'addDate' | 'pubDate' | 'refreshDate'

String. Determines the article sorting order. Options include relevance (default), date/pubDate (newest publication date first), reverseDate (oldest publication date first), addDate (newest ingestion date first), reverseAddDate (oldest ingestion date first), and refreshDate (most recently updated in system first, often identical to addDate).

pageinteger

Integer. The specific page of results to retrieve in the paginated response. Starts at 0.

sizeinteger

Integer. The number of articles to return per page in the paginated response.

fromstring date-time

Date. Filter for articles published after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.

tostring date-time

Date. Filter for articles published before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.

addDateFromstring date-time

Date. Filter for articles added to Perigon's system after this date. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.

addDateTostring date-time

Date. Filter for articles added to Perigon's system before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.

refreshDateFromstring date-time

Date. Filter for articles refreshed/updated in Perigon's system after this date. In most cases yields similar results to addDateFrom but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.

refreshDateTostring date-time

Date. Filter for articles refreshed/updated in Perigon's system before this date. In most cases yields similar results to addDateTo but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.

mediumstring[]

String Array. Filter articles by their primary medium type. Accepts Article for written content or Video for video-based stories. Multiple values create an OR filter.

sourcestring[]

String Array. Filter articles by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter.

sourceGroupstring[]

String Array. Filter articles using Perigon's curated publisher bundles (e.g., top100, top25crypto). Multiple values create an OR filter to include articles from any of the specified bundles.

excludeSourceGroupstring[]

String Array. Exclude articles from specified Perigon source groups. Multiple values create an AND-exclude filter, removing content from publishers in any of the specified bundles (e.g., top10, top100).

excludeSourcestring[]

String Array. Exclude articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an AND-exclude filter.

watchliststring[]

String Array. Filter articles using watchlists of people and companies. Multiple values create an OR filter to include articles mentioning any entity from the specified watchlists.

excludeWatchliststring[]

String Array. Exclude articles mentioning entities from specified watchlists. Multiple values create an AND-exclude filter, removing content mentioning any entity from the specified watchlists.

paywallboolean

Boolean. Filter to show only results where the source has a paywall (true) or does not have a paywall (false).

bylinestring[]

String Array. Filter articles by author bylines. Works as an exact match for each author name provided. Multiple values create an OR filter to find articles by any of the specified authors.

authorstring[]

String Array. Filter articles by specific author names. Works as an exact match for each name. Multiple values create an OR filter to find articles by any of the specified authors.

excludeAuthorstring[]

String Array. Exclude articles written by specific authors. Any article with an author name matching an entry in this list will be omitted from results. Multiple values create an AND-exclude filter.

journalistIdstring[]

String Array. Filter by unique journalist identifiers which can be found through the Journalist API or in the matchedAuthors field. Multiple values create an OR filter.

excludeJournalistIdstring[]

String Array. Exclude articles written by specific journalists identified by their unique IDs. Multiple values create an AND-exclude filter.

languagestring[]

String Array. Filter articles by their language using ISO-639 two-letter codes (e.g., en, es, fr). Multiple values create an OR filter.

excludeLanguagestring[]

String Array. Exclude articles in specific languages using ISO-639 two-letter codes. Multiple values create an AND-exclude filter.

searchTranslationboolean

Boolean. Expand search to include translated content fields for non-English articles. When true, searches translated title, description, and content fields.

labelstring[]

String Array. Filter articles by editorial labels such as Opinion, Paid-news, Non-news, Fact Check, or Press Release. Multiple values create an OR filter.

excludeLabelstring[]

String Array. Exclude articles with specific editorial labels. Multiple values create an AND-exclude filter, removing all content with any of these labels.

categorystring[]

String Array. Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations. Use 'none' to search uncategorized articles.

excludeCategorystring[]

String Array. Exclude articles with specific categories. Multiple values create an AND-exclude filter, removing all content with any of these categories.

topicstring[]

String Array. Filter by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and articles can have multiple topics. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter.

excludeTopicstring[]

String Array. Exclude articles with specific topics. Multiple values create an AND-exclude filter, removing all content with any of these topics.

linkTostring

String. Returns only articles that contain links to the specified URL pattern. Matches against the 'links' field in article responses.

showReprintsboolean

Boolean. Controls whether to include reprinted content in results. When true (default), shows syndicated articles from wire services like AP or Reuters that appear on multiple sites.

reprintGroupIdstring

String. Returns all articles in a specific reprint group, including the original article and all its known reprints. Use when you want to see all versions of the same content.

citystring[]

String Array. Filters articles where a specified city plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the urban area in question. If multiple parameters are passed, they will be applied as OR operations.

excludeCitystring[]

String Array. A list of cities to exclude from the results. Articles that are associated with any of the specified cities will be filtered out.

areastring[]

String Array. Filters articles where a specified area, such as a neighborhood, borough, or district, plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the area in question. If multiple parameters are passed, they will be applied as OR operations.

statestring[]

String Array. Filters articles where a specified state plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the state in question. If multiple parameters are passed, they will be applied as OR operations.

excludeStatestring[]

String Array. A list of states to exclude. Articles that include, or are associated with, any of the states provided here will be filtered out. This is especially useful if you want to ignore news tied to certain geographical areas (e.g., US states).

countystring[]

String Array. A list of counties to include (or specify) in the search results. This field filters the returned articles based on the county associated with the event or news. Only articles tagged with one of these counties will be included.

excludeCountystring[]

String Array. Excludes articles from specific counties or administrative divisions in the search results. Accepts either a single county name or a list of county names. County names should match the format used in article metadata (e.g., 'Los Angeles County', 'Cook County'). This parameter allows for more granular geographic filter

locationsCountrystring[]

String Array. Filters articles where a specified country plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the country in question. If multiple parameters are passed, they will be applied as OR operations.

countrystring[]

String Array. Country code to filter by country. If multiple parameters are passed, they will be applied as OR operations.

excludeLocationsCountrystring[]

String Array. Excludes articles where a specified country plays a central role in the content, ensuring results are not deeply relevant to the country in question. If multiple parameters are passed, they will be applied as AND operations, excluding articles relevant to any of the specified countries.

locationstring[]

String Array. Return all articles that have the specified location. Location attributes are delimited by ':' between key and value, and '::' between attributes. Example: 'city:New York::state:NY'.

latnumber double

Float. Latitude of the center point to search places

lonnumber double

Float. Longitude of the center point to search places

maxDistancenumber double

Float. Maximum distance (in km) from starting point to search articles by tagged places

sourceCitystring[]

String Array. Find articles published by sources that are located within a given city.

excludeSourceCitystring[]

String Array. Excludes articles published by sources that are located within the specified cities.

sourceCountystring[]

String Array. Find articles published by sources that are located within a given county.

excludeSourceCountystring[]

String Array. Excludes articles published by sources that are located within the specified counties.

sourceCountrystring[]

String Array. Find articles published by sources that are located within a given country. Must be 2 character country code (i.e. us, gb, etc).

excludeSourceCountrystring[]

String Array. Excludes articles published by sources that are located within the specified countries. Must be 2 character country codes (e.g., us, gb).

sourceStatestring[]

String Array. Find articles published by sources that are located within a given state.

excludeSourceStatestring[]

String Array. Excludes articles published by sources that are located within the specified states.

sourceLatnumber double

Float. Latitude of the center point to search articles created by local publications.

sourceLonnumber double

Float. Latitude of the center point to search articles created by local publications.

sourceMaxDistancenumber double

Float. Maximum distance from starting point to search articles created by local publications.

personWikidataIdstring[]

String Array. Filter articles by Wikidata IDs of mentioned people. Refer to the /people endpoint for a complete list of tracked individuals.

excludePersonWikidataIdstring[]

String Array. Exclude articles mentioning people with specific Wikidata IDs. Creates an AND-exclude filter to remove content about these individuals. Uses precise identifiers to avoid name ambiguity.

personNamestring[]

String Array. Filter articles by exact person name matches. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint.

excludePersonNamestring[]

String Array. Exclude articles mentioning specific people by name. Creates an AND-exclude filter to remove content about these individuals.

companyIdstring[]

String Array. Filter articles by company identifiers. For a complete list of tracked companies, refer to the /companies endpoint.

excludeCompanyIdstring[]

String Array. Exclude articles mentioning companies with specific identifiers. Creates an AND-exclude filter to remove content about these corporate entities.

companyNamestring

String. Filter articles by company name mentions. Performs an exact match on company names.

companyDomainstring[]

String Array. Filter articles by company domains (e.g., apple.com). For available company entities, consult the /companies endpoint.

excludeCompanyDomainstring[]

String Array. Exclude articles related to companies with specific domains. Creates an AND-exclude filter to remove content about these companies.

companySymbolstring[]

String Array. Filter articles by company stock symbols. For available company entities and their symbols, consult the /companies endpoint.

excludeCompanySymbolstring[]

String Array. A list of stock symbols (ticker symbols) that identify companies to be excluded. Articles related to companies using any of these symbols will be omitted, which is useful for targeting or avoiding specific public companies.

showNumResultsboolean

Boolean. Whether to show the total number of all matched articles. Default value is false which makes queries a bit more efficient but also counts up to 10000 articles.

positiveSentimentFromnumber float

Float. Filter articles with a positive sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.

positiveSentimentTonumber float

Float. Filter articles with a positive sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.

neutralSentimentFromnumber float

Float. Filter articles with a neutral sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.

neutralSentimentTonumber float

Float. Filter articles with a neutral sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.

negativeSentimentFromnumber float

Float. Filter articles with a negative sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.

negativeSentimentTonumber float

Float. Filter articles with a negative sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.

taxonomystring[]

String Array. Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy=/Finance/Banking/Other, /Finance/Investing/Funds. Full list

prefixTaxonomystring

String. Filters by Google Content Categories. This field will filter by the category prefix only. Example: prefixTaxonomy=/Finance

showHighlightingboolean

Boolean. When set to true, enables text highlighting in search results.

highlightFragmentSizeinteger

Integer. Specifies the size in characters of each highlighted text fragment. Defaults to 100 if not specified.

highlightNumFragmentsinteger

Integer. Controls the maximum number of highlighted fragments to return per field.

highlightPreTagstring

String. Defines the HTML tag that appears before highlighted text. Defaults to '<em>' if not specified.

highlightPostTagstring

String. Defines the HTML tag that appears after highlighted text. Defaults to '</em>' if not specified.

highlightQstring

String. Specifies a separate query for highlighting, allowing highlights based on terms different from the main search query. Example: main query 'q=climate change' with 'highlightQ=renewable OR solar' will highlight terms 'renewable' and 'solar' in results about climate change.

Response

200 - Success

statusinteger required
numResultsinteger required

Example response

{
  "status": 200,
  "numResults": 10000,
  "articles": [
    {
      "url": "https://www.breitbart.com/news/south-koreas-lee-trump-to-hold-summit-at-white-house-on-aug-25/",
      "authorsByline": "UPI",
      "articleId": "97dce2f1bdcd441c99360e58d38e811d",
      "clusterId": "87f8c1cdc02f41e0b6fc818f86239c7f",
      "source": {
        "domain": "breitbart.com",
        "paywall": false,
        "location": null
      },
      "imageUrl": "https://media.breitbart.com/media/2025/08/wi/upi/south-koreas-lee-trump-hold-summit-at-white-house-aug-25-south-korea-lee-trump-hold-summit-at-white.jpg",
      "country": "us",
      "language": "en",
      "pubDate": "2025-08-12T02:40:08+00:00",
      "addDate": "2025-08-12T09:50:33.647613+00:00",
      "refreshDate": "2025-08-12T09:50:33.647614+00:00",
      "score": 1,
      "title": "South Korea's Lee, Trump to hold summit at White House on Aug. 25",
      "description": "SEOUL, Aug. 12 (UPI) -- South Korean President Lee Jae Myung will travel to Washington to hold a summit with U.S. President Donald Trump on Aug. 25, Lee's",
      "content": "SEOUL, Aug. 12 (UPI) — South Korean President Lee Jae Myung will travel to Washington to hold a summit with U.S. President Donald Trump on Aug. 25, Lee’s office said Tuesday, with trade and defense issues expected to be at the top of the agenda.\n\nThe three-day visit will be Lee’s first trip to the United States since taking office in June, presidential spokeswoman Kang Yu-jung said at a press briefing.\n\n“The two leaders plan to discuss ways to develop the Korea-U.S. alliance into a future comprehensive strategic alliance in response to the changing international security and economic environment,” Kang said.\n\n“They will also discuss ways to further strengthen the robust South Korea-U.S. combined defense posture and to cooperate to establish peace and achieve denuclearization on the Korean Peninsula,” she added.\n\nThe summit comes weeks after Seoul and Washington struck a trade deal that lowered Trump’s threatened 25% tariffs on South Korean goods to 15%. As part of the package, South Korea pledged to invest $350 billion in the United States and to purchase $100 billion in U.S. energy.\n\nBased on the tariff deal, Trump and Lee will consult on economic cooperation in semiconductors, batteries and shipbuilding, as well as partnerships in advanced technologies and key minerals, Kang said.\n\nThe future of the decades-old South Korea-U.S. military alliance is also expected to be in the spotlight as the two countries prepare to kick off their annual Ulchi Freedom Shield joint exercise on Monday.\n\nDuring his previous term in office, Trump called for massive increases in Seoul’s financial contribution for the 28,500 U.S. forces stationed in Korea.\n\nSeoul signed a new five-year cost-sharing agreement with Washington in October, but Trump has suggested he would look to renegotiate the terms of the deal amid calls for allies to increase their defense spending.\n\n“South Korea is making a lot of money, and they’re very good,” Trump told reporters at a Cabinet meeting in the White House last month. “They’re very good, but, you know, they should be paying for their own military.”\n\nOn Friday, Gen. Xavier Brunson, commander of U.S. Forces Korea, discussed the need to restructure the military alliance in response to an evolving regional security environment.\n\n“Alliance modernization … reflects the recognition that the world’s changed around us,” Brunson told local reporters at a press briefing in Pyeongtaek. “We have a nuclear-armed adversary who’s north of the border. We have increasing involvement of Russia, along with the DPRK, and we also have the Chinese and the threat that they pose to a free and open Indo-Pacific.”\n\nThe Democratic People’s Republic of Korea is the official name of North Korea.\n\nBrunson avoided the question of a potential of U.S. troop reduction on the peninsula, stressing military capabilities and strategic flexibility over numbers ahead of the Lee-Trump summit.\n\n“We’re going to have two chief executives sitting down together to discuss not only the security situation in the region, but the security situation in the world,” he said. “For us, it’s about the capabilities. We want to have the right capabilities resident on the Peninsula.”\n\nLee will be in the United States from Aug. 24-26 for his summit with Trump. In response to local media reports that Lee may also stop in Japan around the time of his U.S. trip, presidential spokeswoman Kang said that nothing had been confirmed.",
      "medium": "Article",
      "links": [],
      "labels": [],
      "matchedAuthors": [],
      "claim": "",
      "verdict": "",
      "keywords": [
        {
          "name": "U.S. Forces Korea",
          "weight": 0.09803479
        },
        {
          "name": "U.S. President Donald Trump",
          "weight": 0.09388354
        },
        {
          "name": "South Korea",
          "weight": 0.08868486
        },
        {
          "name": "U.S.",
          "weight": 0.077976175
        },
        {
          "name": "North Korea",
          "weight": 0.077027455
        },
        {
          "name": "U.S. troop reduction",
          "weight": 0.07701537
        },
        {
          "name": "Korea",
          "weight": 0.076576516
        },
        {
          "name": "U.S. energy",
          "weight": 0.0765642
        },
        {
          "name": "Donald Trump",
          "weight": 0.07466888
        },
        {
          "name": "Trump",
          "weight": 0.07382798
        }
      ],
      "topics": [],
      "categories": [
        {
          "name": "Politics"
        }
      ],
      "taxonomies": [
        {
          "name": "/News/Politics/Other",
          "score": 0.98291015625
        },
        {
          "name": "/Law & Government/Government/Executive Branch",
          "score": 0.96337890625
        },
        {
          "name": "/People & Society/Social Sciences/Political Science",
          "score": 0.8974609375
        }
      ],
      "entities": [
        {
          "data": "South Korea's",
          "type": "GPE",
          "mentions": 7
        },
        {
          "data": "SEOUL",
          "type": "GPE",
          "mentions": 1
        },
        {
          "data": "Washington",
          "type": "GPE",
          "mentions": 3
        },
        {
          "data": "U.S.",
          "type": "GPE",
          "mentions": 7
        },
        {
          "data": "the United States",
          "type": "GPE",
          "mentions": 3
        },
        {
          "data": "Seoul",
          "type": "GPE",
          "mentions": 3
        },
        {
          "data": "Pyeongtaek",
          "type": "GPE",
          "mentions": 1
        },
        {
          "data": "Russia",
          "type": "GPE",
          "mentions": 1
        },
        {
          "data": "DPRK",
          "type": "GPE",
          "mentions": 1
        },
        {
          "data": "The Democratic People’s Republic of Korea",
          "type": "GPE",
          "mentions": 2
        },
        {
          "data": "Japan",
          "type": "GPE",
          "mentions": 1
        },
        {
          "data": "Lee",
          "type": "PERSON",
          "mentions": 8
        },
        {
          "data": "Trump",
          "type": "PERSON",
          "mentions": 8
        },
        {
          "data": "Kang Yu-jung",
          "type": "PERSON",
          "mentions": 4
        },
        {
          "data": "Xavier Brunson",
          "type": "PERSON",
          "mentions": 3
        },
        {
          "data": "White House",
          "type": "ORG",
          "mentions": 1
        },
        {
          "data": "Cabinet",
          "type": "ORG",
          "mentions": 1
        },
        {
          "data": "U.S. Forces Korea",
          "type": "ORG",
          "mentions": 1
        },
        {
          "data": "South Korean",
          "type": "NORP",
          "mentions": 2
        },
        {
          "data": "Chinese",
          "type": "NORP",
          "mentions": 1
        },
        {
          "data": "the Korean Peninsula",
          "type": "LOC",
          "mentions": 2
        },
        {
          "data": "Indo",
          "type": "LOC",
          "mentions": 1
        },
        {
          "data": "-",
          "type": "LOC",
          "mentions": 1
        },
        {
          "data": "Pacific",
          "type": "LOC",
          "mentions": 1
        },
        {
          "data": "Ulchi Freedom Shield",
          "type": "PRODUCT",
          "mentions": 1
        },
        {
          "data": "the White House",
          "type": "FAC",
          "mentions": 1
        }
      ],
      "companies": [],
      "sentiment": {
        "positive": 0.655995,
        "negative": 0.103086375,
        "neutral": 0.24091867
      },
      "summary": "South Korean President Lee Jae Myung is set to meet with U.S. President Donald Trump on Aug. 25, this will be his first trip to the United States since taking office in June. The summit will focus on trade and defense issues, with the two leaders expected to discuss ways to develop the Korea-U.S.-Korea alliance into a future comprehensive strategic alliance. They will also discuss strengthening the robust South Korea-US combined defense posture and cooperating to establish peace and achieve denuclearization on the Korean Peninsula. The future of the decades-old military alliance is also expected to be in the spotlight as the two countries prepare to participate in their annual Ulchi Freedom Shield joint exercise.",
      "shortSummary": "South Korean President Lee Jae Myung will hold a summit with U.S. President Donald Trump in Washington, focusing on strengthening the South Korea-U.S alliance and establishing peace and denuclearization.",
      "translation": "",
      "translatedTitle": "",
      "translatedDescription": "",
      "translatedSummary": "",
      "locations": [
        {
          "country": "kr"
        },
        {
          "country": "kr",
          "state": "11",
          "city": "Seoul"
        }
      ],
      "reprint": true,
      "reprintGroupId": "4e4bf19e89984af1baee7d04776bb9cd",
      "places": [],
      "people": [
        {
          "wikidataId": "Q22686",
          "name": "Donald Trump"
        },
        {
          "wikidataId": "Q12612463",
          "name": "Lee Jae Myung"
        }
      ]
    }
  ]
}