Get event available filters

curl --request GET \
  --url https://events.newscatcherapi.xyz/api/events_info/get_event_fields \
  --header 'x-api-token: <api-key>'

{
  "message": "Success",
  "count": 12,
  "fields": {
    "company_name": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "event_date": {
      "type": "<string>",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "extraction_date": {
      "type": "<string>",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "data_breach.data": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.data_type": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.impacted": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.summary": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.title": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    }
  }
}

GET

api

events_info

get_event_fields

Get event available filters

curl --request GET \
  --url https://events.newscatcherapi.xyz/api/events_info/get_event_fields \
  --header 'x-api-token: <api-key>'

{
  "message": "Success",
  "count": 12,
  "fields": {
    "company_name": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "event_date": {
      "type": "<string>",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "extraction_date": {
      "type": "<string>",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "data_breach.data": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.data_type": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.impacted": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.summary": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.title": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    }
  }
}

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.

Query Parameters

event_type

string

required

Type of event to discover available filters for

Response

Available filters for the specified event type

Data Breach Available Filters
Fundraising Available Filters
Layoff Available Filters
Supply Chain Disruption Available Filters
Tariffs Available Filters

message

string

required

Status message indicating success or providing additional context

Example:

"Success"

count

integer

required

Total number of available filters returned

Example:

12

fields

object

required

Map of field names to their type definitions and usage examples

Show child attributes

fields.company_name

object

required

Name of the company affected by the data breach.

Show child attributes

fields.company_name.type

string

required

Indicates this field accepts string values

fields.company_name.usage_example

object

required

Shows how to use this field in search queries

Show child attributes

fields.company_name.usage_example.{key}

string

Example:

{ "company_name": "Tesla" }

fields.event_date

object

required

Date when the data breach occurred.

Show child attributes

fields.event_date.type

string

required

Indicates this field accepts date values

fields.event_date.usage_example

object

required

Shows how to use date ranges in search queries. Supports both absolute (YYYY-MM-DD) and relative (now-30d) date formats.

Show child attributes

fields.event_date.usage_example.{key}

object

Show child attributes

fields.event_date.usage_example.{key}.lte

string

Less than or equal to date

fields.event_date.usage_example.{key}.gte

string

Greater than or equal to date

Example:

{
  "event_date": { "lte": "now", "gte": "now-30d" }
}

fields.extraction_date

object

required

Date when the event was extracted from news sources.

Show child attributes

fields.extraction_date.type

string

required

Indicates this field accepts date values

fields.extraction_date.usage_example

object

required

Shows how to use date ranges in search queries. Supports both absolute (YYYY-MM-DD) and relative (now-30d) date formats.

Show child attributes

fields.extraction_date.usage_example.{key}

object

Show child attributes

fields.extraction_date.usage_example.{key}.lte

string

Less than or equal to date

fields.extraction_date.usage_example.{key}.gte

string

Greater than or equal to date

Example:

{
  "event_date": { "lte": "now", "gte": "now-30d" }
}

fields.data_breach.data

object

Type of data that was compromised.

Show child attributes

fields.data_breach.data.type

string

required

Indicates this field accepts string values

fields.data_breach.data.usage_example

object

required

Shows how to use this field in search queries

Show child attributes

fields.data_breach.data.usage_example.{key}

string

Example:

{ "company_name": "Tesla" }

fields.data_breach.data_type

object

Classification of compromised data.

Show child attributes

fields.data_breach.data_type.type

string

required

Indicates this field accepts string values

fields.data_breach.data_type.usage_example

object

required

Shows how to use this field in search queries

Show child attributes

fields.data_breach.data_type.usage_example.{key}

string

Example:

{ "company_name": "Tesla" }

fields.data_breach.impacted

object

Type of entities affected by the breach.

Show child attributes

fields.data_breach.impacted.type

string

required

Indicates this field accepts string values

fields.data_breach.impacted.usage_example

object

required

Shows how to use this field in search queries

Show child attributes

fields.data_breach.impacted.usage_example.{key}

string

Example:

{ "company_name": "Tesla" }

fields.data_breach.summary

object

Summary text of the data breach event.

Show child attributes

fields.data_breach.summary.type

string

required

Indicates this field accepts string values

fields.data_breach.summary.usage_example

object

required

Shows how to use this field in search queries

Show child attributes

fields.data_breach.summary.usage_example.{key}

string

Example:

{ "company_name": "Tesla" }

fields.data_breach.title

object

Title of the data breach event.

Show child attributes

fields.data_breach.title.type

string

required

Indicates this field accepts string values

fields.data_breach.title.usage_example

object

required

Shows how to use this field in search queries

Show child attributes

fields.data_breach.title.usage_example.{key}

string

Example:

{ "company_name": "Tesla" }

Tariffs Search for events

⌘I

Overview

Event types

Endpoints

Get event available filters

Authorizations

Query Parameters

Response