Get event fields
Returns available fields for specified event type.
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
Query Parameters
Type of event to get fields for
Response
Status message indicating success or providing additional context
"Success"
Total number of available fields returned
12
Map of field names to their type definitions and usage examples
Name of the company that conducted the layoff.
Date when the layoff occurred.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Date when the event was extracted from news sources.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Relevance rating of the layoff event.
Indicates this field accepts string values
String
Indicates if the layoff impacts real estate market.
true
, false
Stated reason for the layoff.
Indicates this field accepts string values
String
Location where the layoff occurred.
The country where the event occurred.
The city where the event occurred.
The unparsed location string from the source.
The county where the event occurred.
The state where the event occurred.
Maximum number of employees affected in a range.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
{
"number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}
Minimum number of employees affected in a range.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
{
"number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}
Exact number of employees affected.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
{
"number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}
Percentage of workforce affected.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
{
"number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}
Summary text of the layoff event.
Status message indicating success or providing additional context
"Success"
Total number of available fields returned
12
Map of field names to their type definitions and usage examples
Name of the company that conducted the layoff.
Date when the layoff occurred.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Date when the event was extracted from news sources.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Relevance rating of the layoff event.
Indicates this field accepts string values
String
Indicates if the layoff impacts real estate market.
true
, false
Stated reason for the layoff.
Indicates this field accepts string values
String
Location where the layoff occurred.
The country where the event occurred.
The city where the event occurred.
The unparsed location string from the source.
The county where the event occurred.
The state where the event occurred.
Maximum number of employees affected in a range.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
{
"number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}
Minimum number of employees affected in a range.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
{
"number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}
Exact number of employees affected.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
{
"number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}
Percentage of workforce affected.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
{
"number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}
Summary text of the layoff event.
Status message indicating success or providing additional context
"Success"
Total number of available fields returned
12
Map of field names to their type definitions and usage examples
Name of the company affected by the data breach.
Date when the data breach occurred.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Date when the event was extracted from news sources.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Type of data that was compromised.
Classification of compromised data.
Indicates this field accepts string values
String
Type of entities affected by the breach.
Indicates this field accepts string values
String
Summary text of the data breach event.
Indicates this field accepts string values
String
Title of the data breach event.
Indicates this field accepts string values
String
Status message indicating success or providing additional context
"Success"
Total number of available fields returned
12
Map of field names to their type definitions and usage examples
Name of the company that received funding.
Date when the fundraising occurred.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Date when the event was extracted from news sources.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Amount of funding raised.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
Description of the funded company.
Indicates this field accepts string values
String
Legal name of the funded company.
Indicates this field accepts string values
String
Currency of the funding amount.
Indicates this field accepts string values
String
Names of company founders.
Indicates this field accepts string values
String
Type of funding round.
Indicates this field accepts string values
String
Industry of the funded company.
Indicates this field accepts string values
String
Names of investors.
Indicates this field accepts string values
String
Company valuation at the time of funding.
Indicates this field accepts string values
String
Status message indicating success or providing additional context
"Success"
Total number of available fields returned
12
Map of field names to their type definitions and usage examples
Name of the company related to the tariff event.
Date when the tariff event occurred.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Date when the event was extracted from news sources.
Indicates this field accepts date values
Date
Shows how to use date ranges in search queries.
Supports both absolute (YYYY-MM-DD) and relative (now-30d
) date formats.
Industries affected by the tariff or trade measure.
Indicates this field accepts string values
String
Specific products affected by the tariff or trade measure.
Indicates this field accepts string values
String
Date when the tariff or trade measure was announced.
Indicates this field accepts string values
String
The estimated value of trade affected by the measure.
Indicates this field accepts string values
String
Harmonized System (HS) sections of products affected by the tariff.
Indicates this field accepts string values
String
Date when the tariff or trade measure will be or was implemented.
Indicates this field accepts string values
String
The ISO 3166-1 alpha-2 code of the country implementing the tariff.
Indicates this field accepts string values
String
The name of the country implementing the tariff.
Indicates this field accepts string values
String
The most significant tariff rate mentioned.
Indicates this field accepts numeric values
Number
Shows how to use numeric ranges in search queries
{
"number_of_people_laid_off": { "gte": 100, "lte": 1000 }
}
Type of trade measure being implemented.
Indicates this field accepts string values
String
Stated policy objective for implementing the tariff.
Indicates this field accepts string values
String
The tariff rates before this change.
Indicates this field accepts string values
String
Rating of how directly the article addresses specific tariff announcements.
Indicates this field accepts string values
String
A comprehensive summary of the tariff announcement or change.
Indicates this field accepts string values
String
ISO 3166-1 alpha-2 codes for countries targeted by the tariff.
Indicates this field accepts string values
String
Names of countries targeted by the tariff.
Indicates this field accepts string values
String
List of tariff rate descriptions.
Indicates this field accepts string values
String
Description of what triggered the retaliatory measure.
Indicates this field accepts string values
String
Was this page helpful?
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"
}
}
}
}