Skip to main content

Documentation Index

Fetch the complete documentation index at: https://newscatcherinc-docs.mintlify.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Events API provides access to source articles from which events are extracted. These source articles help verify extracted event data and provide additional context. The API returns articles in an array and filters them based on the event search criteria.

​
Requesting article data

To include article data in your request, set attach_articles_data: true: 
{
  "event_type": "layoff",
  "attach_articles_data": true,
  "additional_filters": {
    // filters
  }
}

​
Default article fields

By default, when attach_articles_data is set to true, each article object includes four basic fields:
  • id: Unique identifier for the article
  • title: Article title
  • link: URL link to the article
  • media: Media associated with the article

​
Available additional fields

The API supports requesting additional article fields through the additional_article_fields parameter. Available fields include:
  • Author information:
    • author: Primary author of the article
    • authors: List of authors of the article
    • journalists: List of journalists associated with the article
  • Publication details:
    • published_date: Date the article was published
    • published_date_precision: Precision of the published date
    • name_source: Name of the source where the article was published
    • language: Language in which the article is written
    • description: Brief description of the article
    • content: Full content of the article
  • Domain information:
    • domain_url: Domain URL of the article
    • full_domain_url: Full domain URL of the article
  • Article attributes:
    • is_headline: Indicates if the article is a headline
    • paid_content: Indicates if the article is paid content
    • rights: Rights information for the article
    • rank: Rank of the article’s source
    • is_opinion: Indicates if the article is an opinion piece
    • word_count: Word count of the article
    • twitter_account: Twitter account associated with the article
  • Link analysis:
    • all_links: List of all URLs mentioned in the article
    • all_domain_links: List of all domain URLs mentioned in the article
    • extraction_data.parent_url: Parent URL information from extraction metadata
  • Natural language processing:
    • nlp.theme: Article themes or categories
    • nlp.summary: AI-generated article summary
    • nlp.sentiment: Sentiment analysis scores
    • nlp.ner_PER: Named entities (persons)
    • nlp.ner_ORG: Named entities (organizations)
    • nlp.ner_MISC: Named entities (miscellaneous)
    • nlp.ner_LOC: Named entities (locations)

​
Requesting additional fields

Use additional_article_fields to request specific fields beyond the default ones: 
{
  "event_type": "layoff",
  "attach_articles_data": true,
  "additional_article_fields": [
    "description",
    "content",
    "published_date",
    "nlp.summary",
    "nlp.sentiment"
  ]
}
The response will include both the default fields and any additional requested fields.