Source: https://eventregistry.org/documentation?tab=breakingEvents

# Get list of breaking events

Retrieve the list of breaking events.

Use this API endpoint to obtain a list of breaking events and their breaking score. The breaking events are events (a) that occured very recently, (b) for which we have collected many articles about them in a short time span and (c) for which the intensity of reporting is increasing.

**Endpoint:** GET | POST `https://eventregistry.org/api/v1/event/getBreakingEvents`

**Headers:** Content-Type: application/json

#### `Parameters`

#### `apiKey`

string (required)

Your API key

#### `breakingEventsCount`

integer

Number of breaking events to return (at most 100)

Default value: `100`

#### `breakingEventsPage`

integer

Page of the results to return

Default value: `1`

#### `breakingEventsMinBreakingScore`

double

Score of how much should event at least be "breaking" in order to return it. Minimum value is 0.

Default value: `0.2`

#### `Returned Details`

The API call can return more or less meta-data information about the events, articles, concepts, categories, sources and locations. Click to see the available properties that can be specified to determine the amount of returned information.

#### `includeEventTitle`

boolean

Set this parameter to true to include the event title in the response.

Default value: `true`

#### `includeEventSummary`

boolean

Set this parameter to true to include the event title in the response.

Default value: `false`

#### `includeEventSocialScore`

boolean

Set this parameter to true to include the event social score in the response.

Default value: `false`

#### `includeEventSentiment`

boolean

Set this parameter to true to include the event sentiment in the response.

Default value: `true`

#### `includeEventLocation`

boolean

Set this parameter to true to include the event location in the response.

Default value: `true`

#### `includeEventDate`

boolean

Set this parameter to true to include the event date in the response.

Default value: `true`

#### `includeEventArticleCounts`

boolean

Set this parameter to true to include the article counts for events in the response.

Default value: `true`

#### `includeEventConcepts`

boolean

Set this parameter to true to include the event concepts in the response.

Default value: `true`

#### `includeEventCategories`

boolean

Set this parameter to true to include the event categories in the response.

Default value: `true`

#### `includeEventCommonDates`

boolean

Set this parameter to true to include the event commmon dates in the response.

Default value: `false`

#### `includeEventStories`

boolean

Set this parameter to true to include the event stories in the response.

Default value: `false`

#### `eventImageCount`

integer

Define how many images you would like to have in the response.

Default value: `0`

#### `includeConceptLabel`

boolean

Set this parameter to true to include the concept label in the response.

Default value: `true`

#### `includeConceptImage`

boolean

Set this parameter to true to include the concept image in the response.

Default value: `false`

#### `includeConceptSynonyms`

boolean

Set this parameter to true to include the concept synonyms in the response.

Default value: `false`

#### `conceptLang`

string

Define the language of the concept label.

Default value: `eng`

#### `includeStoryBasicStats`

boolean

Set this parameter to true to include story basic stats in the response.

Default value: `false`

#### `includeStoryTitle`

boolean

Set this parameter to true to include the story title in the response.

Default value: `false`

#### `includeStoryLocation`

boolean

Set this parameter to true to include the story location in the response.

Default value: `false`

#### `includeStoryDate`

boolean

Set this parameter to true to include the story date in the response.

Default value: `false`

#### `includeStoryConcepts`

boolean

Set this parameter to true to include the story concepts in the response.

Default value: `false`

#### `includeStoryCategories`

boolean

Set this parameter to true to include the story categories in the response.

Default value: `false`

#### `includeStoryMedoidArticle`

boolean

Set this parameter to true to include story medoid article in the response.

Default value: `false`

#### `includeStoryCommonDates`

boolean

Set this parameter to true to include story common dates in the response.

Default value: `false`

#### `storyImageCount`

integer

Define how many images you would like to have in the response.

Default value: `0`

#### `includeCategoryParentUri`

boolean

Set this parameter to true to include category parent uri in the response.

Default value: `false`

#### `includeLocationPopulation`

boolean

Set to true to include the population size of the location.

Default value: `false`

#### `includeLocationGeoNamesId`

boolean

Set to true to include the GeoNames id of the location.

Default value: `false`

#### `includeLocationCountryArea`

boolean

Set to true to include the are of the location in squared km.

Default value: `false`

#### `includeLocationCountryContinent`

boolean

Set to true to get the continent of the country for location objects.

Default value: `false`

## Request examples

### Example 1

Get the list of top current breaking events.

Request body:

```json
{
  "eventImageCount": 3,
  "includeEventLocation": true,
  "includeEventSocialScore": true,
  "includeLocationGeoLocation": true,
  "apiKey": "YOUR_API_KEY"
}
```

## Output schema

```json
{
  "type": "object",
  "properties": {
    "events": {
      "type": "object",
      "properties": {
        "totalResults": {
          "type": "integer"
        },
        "page": {
          "type": "integer"
        },
        "count": {
          "type": "integer"
        },
        "pages": {
          "type": "integer"
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "uri": {
                "type": "string"
              },
              "concepts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "uri": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    },
                    "score": {
                      "type": "integer"
                    },
                    "label": {
                      "type": "object",
                      "properties": {
                        "eng": {
                          "type": "string"
                        }
                      }
                    },
                    "image": {
                      "type": "string"
                    },
                    "synonyms": {
                      "type": "object",
                      "properties": {}
                    },
                    "trendingScore": {
                      "type": "object",
                      "properties": {
                        "news": {
                          "type": "object",
                          "properties": {
                            "score": {
                              "type": "double"
                            },
                            "testPopFq": {
                              "type": "integer"
                            },
                            "nullPopFq": {
                              "type": "integer"
                            }
                          }
                        }
                      }
                    },
                    "location": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "label": {
                          "type": "object",
                          "properties": {
                            "eng": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              },
              "stories": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "uri": {
                      "type": "string"
                    },
                    "articleCount": {
                      "type": "integer"
                    },
                    "lang": {
                      "type": "string"
                    },
                    "avgCos": {
                      "type": "double"
                    },
                    "variance": {
                      "type": "double"
                    },
                    "title": {
                      "type": "string"
                    },
                    "isUserSetTitle": {
                      "type": "boolean"
                    },
                    "concepts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "uri": {
                            "type": "string"
                          },
                          "type": {
                            "type": "string"
                          },
                          "score": {
                            "type": "integer"
                          },
                          "label": {
                            "type": "object",
                            "properties": {
                              "eng": {
                                "type": "string"
                              }
                            }
                          },
                          "image": {
                            "type": "string"
                          },
                          "synonyms": {
                            "type": "object",
                            "properties": {}
                          },
                          "trendingScore": {
                            "type": "object",
                            "properties": {
                              "news": {
                                "type": "object",
                                "properties": {
                                  "score": {
                                    "type": "double"
                                  },
                                  "testPopFq": {
                                    "type": "integer"
                                  },
                                  "nullPopFq": {
                                    "type": "integer"
                                  }
                                }
                              }
                            }
                          },
                          "location": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string"
                              },
                              "label": {
                                "type": "object",
                                "properties": {
                                  "eng": {
                                    "type": "string"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "location": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string"
                          },
                          "label": {
                            "type": "object",
                            "properties": {
                              "eng": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    },
                    "isUserSetLocation": {
                      "type": "boolean"
                    },
                    "categories": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "uri": {
                            "type": "string"
                          },
                          "label": {
                            "type": "string"
                          },
                          "wgt": {
                            "type": "integer"
                          }
                        }
                      }
                    },
                    "medoidArticle": {
                      "type": "object",
                      "properties": {
                        "uri": {
                          "type": "string"
                        },
                        "lang": {
                          "type": "string"
                        },
                        "isDuplicate": {
                          "type": "boolean"
                        },
                        "date": {
                          "type": "string"
                        },
                        "time": {
                          "type": "string"
                        },
                        "dateTime": {
                          "type": "string"
                        },
                        "sim": {
                          "type": "double"
                        },
                        "url": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "body": {
                          "type": "string"
                        },
                        "source": {
                          "type": "object",
                          "properties": {
                            "uri": {
                              "type": "string"
                            },
                            "dataType": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "location": {
                              "type": "object",
                              "properties": {
                                "type": {
                                  "type": "string"
                                },
                                "label": {
                                  "type": "object",
                                  "properties": {
                                    "eng": {
                                      "type": "string"
                                    }
                                  }
                                }
                              }
                            },
                            "locationValidated": {
                              "type": "boolean"
                            },
                            "ranking": {
                              "type": "object",
                              "properties": {
                                "importanceRank": {
                                  "type": "integer"
                                }
                              }
                            }
                          }
                        },
                        "concepts": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "uri": {
                                "type": "string"
                              },
                              "type": {
                                "type": "string"
                              },
                              "score": {
                                "type": "integer"
                              },
                              "label": {
                                "type": "object",
                                "properties": {
                                  "eng": {
                                    "type": "string"
                                  }
                                }
                              },
                              "image": {
                                "type": "string"
                              },
                              "synonyms": {
                                "type": "object",
                                "properties": {}
                              },
                              "trendingScore": {
                                "type": "object",
                                "properties": {
                                  "news": {
                                    "type": "object",
                                    "properties": {
                                      "score": {
                                        "type": "double"
                                      },
                                      "testPopFq": {
                                        "type": "integer"
                                      },
                                      "nullPopFq": {
                                        "type": "integer"
                                      }
                                    }
                                  }
                                }
                              },
                              "location": {
                                "type": "object",
                                "properties": {
                                  "type": {
                                    "type": "string"
                                  },
                                  "label": {
                                    "type": "object",
                                    "properties": {
                                      "eng": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        },
                        "categories": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "uri": {
                                "type": "string"
                              },
                              "label": {
                                "type": "string"
                              },
                              "wgt": {
                                "type": "integer"
                              }
                            }
                          }
                        },
                        "links": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "videos": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "image": {
                          "type": "string"
                        },
                        "duplicateList": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "originalArticle": {
                          "type": "string"
                        },
                        "eventUri": {
                          "type": "string"
                        },
                        "location": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string"
                            },
                            "label": {
                              "type": "object",
                              "properties": {
                                "eng": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        },
                        "extractedDates": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "amb": {
                                "type": "boolean"
                              },
                              "imp": {
                                "type": "boolean"
                              },
                              "date": {
                                "type": "string"
                              },
                              "textStart": {
                                "type": "integer"
                              },
                              "textEnd": {
                                "type": "integer"
                              }
                            }
                          }
                        },
                        "shares": {
                          "type": "object",
                          "properties": {
                            "facebook": {
                              "type": "integer"
                            }
                          }
                        },
                        "wgt": {
                          "type": "integer"
                        }
                      }
                    },
                    "storyDate": {
                      "type": "string"
                    },
                    "isUserSetDate": {
                      "type": "boolean"
                    },
                    "extractedDate": {
                      "type": "string"
                    },
                    "averageDate": {
                      "type": "string"
                    },
                    "images": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "commonDates": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "amb": {
                            "type": "boolean"
                          },
                          "imp": {
                            "type": "boolean"
                          },
                          "date": {
                            "type": "string"
                          },
                          "textStart": {
                            "type": "integer"
                          },
                          "textEnd": {
                            "type": "integer"
                          },
                          "freq": {
                            "type": "integer"
                          }
                        }
                      }
                    },
                    "socialScore": {
                      "type": "double"
                    },
                    "wgt": {
                      "type": "integer"
                    }
                  }
                }
              },
              "eventDate": {
                "type": "string"
              },
              "totalArticleCount": {
                "type": "integer"
              },
              "title": {
                "type": "object",
                "properties": {
                  "eng": {
                    "type": "string"
                  }
                }
              },
              "summary": {
                "type": "object",
                "properties": {
                  "eng": {
                    "type": "string"
                  }
                }
              },
              "location": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string"
                  },
                  "label": {
                    "type": "object",
                    "properties": {
                      "eng": {
                        "type": "string"
                      }
                    }
                  }
                }
              },
              "categories": {
                "type": "object",
                "properties": {
                  "uri": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "wgt": {
                    "type": "integer"
                  }
                }
              },
              "images": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "articleCounts": {
                "type": "object",
                "properties": {
                  "eng": {
                    "type": "integer"
                  }
                }
              },
              "socialScore": {
                "type": "double"
              },
              "commonDates": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "amb": {
                      "type": "boolean"
                    },
                    "imp": {
                      "type": "boolean"
                    },
                    "date": {
                      "type": "string"
                    },
                    "textStart": {
                      "type": "integer"
                    },
                    "textEnd": {
                      "type": "integer"
                    },
                    "freq": {
                      "type": "integer"
                    }
                  }
                }
              },
              "wgt": {
                "type": "integer"
              }
            }
          }
        }
      }
    }
  }
}
```
