search

Events

hashtag
Retrieve Events Feed

GET https://api.main.finalle.ai/events

Get an AI generated, real-time feed of financial events along with their resources (descending ordered by timestamp).

hashtag
Headers

Include the X-API-Keyheader in order to authenticate:

{  
    "X-API-Key": "YOUR_API_KEY"
}

hashtag
Path Parameters

Name
Type
Description

symbols

String

A comma separated list of symbols to query, maximum is 10 symbols. Defaults to all available symbols. If provided, only events relating these (system's supported) symbols will be returned. If non of the provided symbols is supported, an empty events list will be returned.

limit

Integer

Limit the number of results returned. Defaults to 10, max is 100.

from

Date

The start date to retrieve events from, in ISO format (YYYY-MM-DDTHH:MM:SS). Defaults to 1 week ago, minimum date is 1 month ago.

to

Date

The end date of the data to retrieve, in ISO format (YYYY-MM-DDTHH:MM:SS). Defaults to current time.

significancy

Integer

A threshold that filters events based on their level of significance. It will only return events with a significance greater than or equal to the specified value. Defaults to 1, max is 10.

extract_by_last_update

String

A "yes"/"no" binary parameter. Determines whether to extract events based on their 'last_update_timestamp' or by their 'timestamp'. Defaults to "no".

On success, returns an events feed (list of JSON objects), where each item is a an event object along with sources related to the event (structured as in the /feed endpoint above).

In addition, the output returns a non_supported_input_symbols list (of strings), which contains all of the input symbols which are not supported in the system. The output follows the following structure:

{
  "data": {
      "events": [
        {
          "event_id": "string", // Event id
          "event_time_price": "float", // Stock's price at the event detection time
          "mentioned_peers": "string", // Comma separated list of related peers
          "review": "string", // Event review
          "sentiment": "integer", // Event sentiment, on a scale of 1-5 (inclusive), where 1 = very negative, 2 = negative, 3 = neutral, 4 = positive, 5 = very positive.
          "significancy": "integer", // Event significany, on a scale of 1-10 (inclusive), where 1 = least significant and 10 = most significant.
          "symbol": "string", // Event's main symbol
          "timestamp": "string", // Event detection timestamp (in YYYY-MM-DDTHH:MM:SS format)
          "last_update_timestamp": "string", // Event last update timestamp (in YYYY-MM-DDTHH:MM:SS format)
          "title": "string", // Event title
          "related_sources": "list", // A list of resources related to the event. Each source is a json with structure as in the /feed endpoint above.
          "category": "list[string]", // A list of up to 3 event categories. Options include: earnings, analyst review, product update, mergers and acquisitions, insider trading, partnerships, financials, trading, legal, exceptional incident, dividend, investor sentiment, personnel, and other.
          "sector": "string", // The sector associated with the main ticker of the event. Possible values include: Financial Services, Industrials, Technology, Healthcare, Consumer Cyclical, Communication Services, Real Estate, Energy, Basic Materials, Consumer Defensive, and Utilities.
        }
      ],
      "non_supported_input_symbols": [] // Input symbols which are not supported
    },
    "request_id": "YOUR_REQUEST_ID",
    "result": "success"
}

Example

For the request:

https://api.main.finalle.ai/events?limit=10

The output is:

PreviousNewsNextSymbols Brief

Last updated