Transform news into actionable business intelligence with structured events! This guide helps you make your first API calls to retrieve structured event data from news articles.

Before you start

Before you begin, make sure you meet these prerequisites:

  • An API key (obtain one through our pricing page)
  • Basic understanding of REST APIs
  • Your preferred HTTP client (curl, Postman, etc.)
  • Basic knowledge of JSON data format

Get started

1

Verify your API access

First, let’s verify that your API key works and the service is available:

curl -X GET https://events.newscatcherapi.xyz/api/health \
  -H "x-api-token: YOUR_API_KEY"

You should receive:

{
  "message": "Healthy"
}
2

Check your subscription details

Check what event types are available to you:

curl -X GET https://events.newscatcherapi.xyz/api/subscription \
  -H "x-api-token: YOUR_API_KEY"

This shows your subscription status and available events:

{
  "active": true,
  "calls_per_seconds": 5,
  "plan_name": "events",
  "usage_assigned_calls": 10000,
  "usage_remaining_calls": 9959,
  "additional_info": {
    "available_events": ["layoff", "data_breach", "fundraising"]
  }
}
3

Explore event fields

Before searching, let’s see what fields are available for a specific event type:

curl -X GET "https://events.newscatcherapi.xyz/api/events_info/get_event_fields?event_type=layoff" \
  -H "x-api-token: YOUR_API_KEY"

This returns the fields you can use in your searches:

{
  "message": "Success",
  "count": 12,
  "fields": {
    "company_name": {
      "type": "String",
      "usage_example": {
        "company_name": "String Example"
      }
    },
    "event_date": {
      "type": "Date",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-1d"
        }
      }
    }
    // ... other fields
  }
}
4

Search for events

Now let’s perform your first event search:

curl -X POST https://events.newscatcherapi.xyz/api/events_search \
  -H "x-api-token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "layoff",
    "attach_articles_data": true,
    "additional_filters": {
        "extraction_date": {
            "gte": "now-1d",
            "lte": "now"
        },
        "layoff.number_of_people_laid_off": {
            "gte": 10000
        }
    }
}'

This searches for recent large layoff events, with over 10,000 people affected, from the last 24 hours. The response will include structured event data and associated articles.

What’s next

Now that you’ve made your first API calls, you can:

Need help? Contact our support team at support@newscatcherapi.com