POST
/
api
/
events_search
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.

The body is of type object.

Response

200
application/json
Search results containing matched events.

The response is of type object.