Get event fields

GET

api

events_info

get_event_fields

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": "Date",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "extraction_date": {
      "type": "Date",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "layoff.how_much_related": {
      "type": "String",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "layoff.is_relevant_for_real_estate": "true",
    "layoff.layoff_reason": {
      "type": "String",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "layoff.location": {
      "country": "<string>",
      "city": "<string>",
      "raw_location": "<string>",
      "county": "<string>",
      "state": "<string>"
    },
    "layoff.max_number_of_people_laid_off": {
      "type": "Number",
      "usage_example": {
        "number_of_people_laid_off": {
          "gte": 100,
          "lte": 1000
        }
      }
    },
    "layoff.min_number_of_people_laid_off": {
      "type": "Number",
      "usage_example": {
        "number_of_people_laid_off": {
          "gte": 100,
          "lte": 1000
        }
      }
    },
    "layoff.number_of_people_laid_off": {
      "type": "Number",
      "usage_example": {
        "number_of_people_laid_off": {
          "gte": 100,
          "lte": 1000
        }
      }
    },
    "layoff.percentage_of_people_laid_off": {
      "type": "Number",
      "usage_example": {
        "number_of_people_laid_off": {
          "gte": 100,
          "lte": 1000
        }
      }
    },
    "layoff.summary": {
      "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 get fields for

Response

200

application/json

Available fields for the specified event type

message

string

required

Status message indicating success or providing additional context

Example:

"Success"

count

integer

required

Total number of available fields returned

Example:

12

fields

object

required

Map of field names to their type definitions and usage examples

fields.company_name

object

required

Name of the company that conducted the layoff.

fields.company_name.type

enum<string>

required

Indicates this field accepts string values

Available options:

String

fields.company_name.usage_example

object

required

Shows how to use this field in search queries

Example:

{ "company_name": "Tesla" }

fields.event_date

object

required

Date when the layoff occurred.

fields.event_date.type

enum<string>

required

Indicates this field accepts date values

Available options:

Date

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.

Example:

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

fields.extraction_date

object

required

Date when the event was extracted from news sources.

fields.extraction_date.type

enum<string>

required

Indicates this field accepts date values

Available options:

Date

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.

Example:

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

Relevance rating of the layoff event.

Indicates this field accepts string values

Available options:

String

Shows how to use this field in search queries

Example:

{ "company_name": "Tesla" }

fields.layoff.is_relevant_for_real_estate

enum<string>

Indicates if the layoff impacts real estate market.

Available options:

true,

false

fields.layoff.layoff_reason

object

Stated reason for the layoff.

fields.layoff.layoff_reason.type

enum<string>

required

Indicates this field accepts string values

Available options:

String

fields.layoff.layoff_reason.usage_example

object

required

Shows how to use this field in search queries

Example:

{ "company_name": "Tesla" }

fields.layoff.location

object

Location where the layoff occurred.

fields.layoff.max_number_of_people_laid_off

object

Maximum number of employees affected in a range.

fields.layoff.max_number_of_people_laid_off.type

enum<string>

required

Indicates this field accepts numeric values

Available options:

Number

fields.layoff.max_number_of_people_laid_off.usage_example

object

required

Shows how to use numeric ranges in search queries

Example:

{
  "number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}

fields.layoff.min_number_of_people_laid_off

object

Minimum number of employees affected in a range.

fields.layoff.min_number_of_people_laid_off.type

enum<string>

required

Indicates this field accepts numeric values

Available options:

Number

fields.layoff.min_number_of_people_laid_off.usage_example

object

required

Shows how to use numeric ranges in search queries

Example:

{
  "number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}

fields.layoff.number_of_people_laid_off

object

Exact number of employees affected.

fields.layoff.number_of_people_laid_off.type

enum<string>

required

Indicates this field accepts numeric values

Available options:

Number

fields.layoff.number_of_people_laid_off.usage_example

object

required

Shows how to use numeric ranges in search queries

Example:

{
  "number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}

fields.layoff.percentage_of_people_laid_off

object

Percentage of workforce affected.

fields.layoff.percentage_of_people_laid_off.type

enum<string>

required

Indicates this field accepts numeric values

Available options:

Number

fields.layoff.percentage_of_people_laid_off.usage_example

object

required

Shows how to use numeric ranges in search queries

Example:

{
  "number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}

fields.layoff.summary

object

Summary text of the layoff event.

fields.layoff.summary.type

enum<string>

required

Indicates this field accepts string values

Available options:

String

fields.layoff.summary.usage_example

object

required

Shows how to use this field in search queries

Example:

{ "company_name": "Tesla" }

Was this page helpful?

Suggest edits Raise issue

Fundraising Search for events

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": "Date",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "extraction_date": {
      "type": "Date",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "layoff.how_much_related": {
      "type": "String",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "layoff.is_relevant_for_real_estate": "true",
    "layoff.layoff_reason": {
      "type": "String",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "layoff.location": {
      "country": "<string>",
      "city": "<string>",
      "raw_location": "<string>",
      "county": "<string>",
      "state": "<string>"
    },
    "layoff.max_number_of_people_laid_off": {
      "type": "Number",
      "usage_example": {
        "number_of_people_laid_off": {
          "gte": 100,
          "lte": 1000
        }
      }
    },
    "layoff.min_number_of_people_laid_off": {
      "type": "Number",
      "usage_example": {
        "number_of_people_laid_off": {
          "gte": 100,
          "lte": 1000
        }
      }
    },
    "layoff.number_of_people_laid_off": {
      "type": "Number",
      "usage_example": {
        "number_of_people_laid_off": {
          "gte": 100,
          "lte": 1000
        }
      }
    },
    "layoff.percentage_of_people_laid_off": {
      "type": "Number",
      "usage_example": {
        "number_of_people_laid_off": {
          "gte": 100,
          "lte": 1000
        }
      }
    },
    "layoff.summary": {
      "type": "String",
      "usage_example": {
        "company_name": "Tesla"
      }
    }
  }
}

Overview

How to

Event types

Endpoints

Authorizations

Query Parameters

Response