Events

Retrieve events

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

Get an AI generated, real-time list of stocks events resources (descending ordered by timestamp).

Path Parameters

Name
Type
Description

api_key*

String

Your API key

tickers

String

A comma separated list of tickers to query, maximum is 100 tickers. Defaults to all available tickers. If provided, only events relating these (system's supported) tickers will be returned. If non of the provided tickers 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".

mentioned_peers_amount

Integer

Determines the maximum number of mentioned peers returned for each event. Defaults to 5.

related_sources_amount

Integer

Determines the maximum number of related sources returned for each event. Defaults to 10.

On success, returns a list of events (jsons), where each item is a an event object along with sources related to that event. In addition, the output contains a non_supported_input_tickers list (of strings), which contains all of the input tickers which are not supported in the system. The output follows the following structure:

{
  "data": {
      "events": [{
          "event_id": "string", // Event id
          "event_time_price": "float", // Ticker's price at the event detection time
          "mentioned_peers": "string", // Comma seperated list of related peers
          "review": "string", // Event review
          "sentiment": "integer", // Event sentiment, in a scale of 1-5 (inclusive). This is calculated as an (rounded) average of the related resources sentiment
          "significancy": "integer", // Event significany, in a scale of 1-10 (inclusive). This is calculated as an (rounded) average of the related resources significancy
          "ticker": "string", // Event's main ticker
          "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.
      }],
      "non_supported_input_tickers": [] // Input tickers which are not supported
    },
    "request_id": "YOUR_REQUEST_ID",
    "result": "success"
}

Example

For the request:

https://api.finalle.ai/events?limit=10&tickers=TSLA,AAPL,NVDA,MSFT&api_key=*

The output is:

PreviousGetting StartedNextTickers Review

Last updated