Skip to main content
POST
/
api
/
events_search
Search for events
curl --request POST \
  --url https://events.newscatcherapi.xyz/api/events_search \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "event_type": "data_breach",
  "attach_articles_data": false,
  "additional_filters": {
    "company_name": "<string>",
    "event_date": {
      "gte": "<string>",
      "lte": "<string>"
    },
    "extraction_date": {
      "gte": "<string>",
      "lte": "<string>"
    },
    "data_breach.data": "<string>",
    "data_breach.data_type": "<string>",
    "data_breach.impacted": "<string>",
    "data_breach.summary": "<string>",
    "data_breach.title": "<string>"
  },
  "additional_article_fields": [
    "description",
    "published_date",
    "nlp.summary"
  ]
}
'
{
  "message": "Success",
  "count": 25,
  "events": [
    {
      "id": "n1jk-pQBvyT_ytpRpzBn",
      "event_type": "data_breach",
      "global_event_type": "DataMonitoring",
      "associated_article_ids": [
        "<string>"
      ],
      "extraction_date": "2023-11-07T05:31:56Z",
      "event_date": "2023-11-07T05:31:56Z",
      "company_name": "<string>",
      "data_breach": {
        "summary": "<string>",
        "impacted": [
          "<string>"
        ],
        "data": "<string>",
        "data_type": "<string>",
        "title": "<string>"
      }
    }
  ],
  "articles": [
    {
      "id": "<string>",
      "title": "<string>",
      "link": "<string>",
      "media": "<string>"
    }
  ]
}

Authorizations

​
x-api-token
string
header
required

API Key to authenticate requests.

To access the API, include your API key in the x-api-token header. To obtain your API key, complete the form or contact us directly.

Body

application/json

Parameters for searching events.

​
event_type
enum<string>
required

The specific type of business event.

Available options:
data_breach,
fundraising,
layoff,
supply_chain_disruption,
tariffs_v2
​
attach_articles_data
boolean
default:false

If true, includes source article data in the response. If false, returns only event data.

​
additional_filters
Data Breach · object

The event-specific filtering parameters. Required structure depends on the event_type value.

  • Data Breach
  • Fundraising
  • Layoff
  • Supply Chain Disruption
  • Tariffs
​
additional_article_fields
enum<string>[]

Additional article filters to include in the response. Only applicable when attach_articles_data is true.

Available options:
description,
content,
published_date,
published_date_precision,
author,
authors,
journalists,
domain_url,
full_domain_url,
name_source,
extraction_data.parent_url,
is_headline,
paid_content,
rights,
rank,
is_opinion,
language,
word_count,
twitter_account,
all_links,
all_domain_links,
nlp.theme,
nlp.summary,
nlp.sentiment,
nlp.ner_PER,
nlp.ner_ORG,
nlp.ner_MISC,
nlp.ner_LOC
Example:
[
  "description",
  "published_date",
  "nlp.summary"
]

Response

Search results containing matched events.

​
message
string
required

The status message of the search operation.

Example:

"Success"

​
count
integer
required

The total number of events returned.

Example:

25

​
events
(Data Breach · object | Fundraising · object | Layoff · object | Supply Chain Disruption · object | Tariffs · object)[]
required

The list of matched events.

  • Data Breach
  • Fundraising
  • Layoff
  • Supply Chain Disruption
  • Tariffs
​
articles
(Default Article Object · object | Complete Article Object · object)[]

Array of source articles. Only present when attach_articles_data is true in the request. Access individual articles using array index, e.g.:

  • First article: events.articles[0]
  • Second article: events.articles[1]

By default, only returns id, title, link, and media fields. To request more fields, add them to the additional_article_fields array in the search request.

The default article fields returned when attach_articles_data is true.

  • Default Article Object
  • Complete Article Object