Global Event Detection Dataset

Returns the global event detection dataset for a list of stocks.

Dataset Factsheet and Sample

View Factsheet (.pdf)

Download Sample Data and Schema (.xlsx)

Examples

Curl

Note: If you are using Windows, adjust the syntax:

• Replace line breaks (\) with caret (^).
• Use double quotes (") instead of single quotes (').

curl -X 'POST' \
  'https://quant.api.yukkalab.com/company_data/events?date_from=2023-01-01&date_to=2023-01-05' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $YUKKA_TOKEN" \
  -d '["company:apple", "company:sap"]'

Python

import requests

headers = {
    'accept': 'application/json',
    # Already added when you pass json=
    # 'Content-Type': 'application/json',
    'Authorization': f'Bearer {token}',
}

params = {
    'date_from': '2023-01-01',
    'date_to': '2023-01-05',
}

json_data = [
    'company:apple',
    'company:sap',
]

response = requests.post(
    'https://quant.api.yukkalab.com/company_data/events',
    params=params,
    headers=headers,
    json=json_data,
)

Example Response

{"entries":[{"news_publish_time":"2023-01-01T12:02:00","ISIN":"DE0006231004","yukka_id":"company:infineon","company":"Infineon Technologies AG","event_name":"Supply Chain Problems","role":"Company","factuality":"fact","temporality":"past","country":"Germany","city":"Neubiberg","industry":"Industrials","supersector":"Technology","sector":"Electronic & Electrical Equipment","subsector":"Semiconductors"}], "copyright":{"contact_email":"info@yukkalab.com","copyright_info":"\n© 2024 Yukka AG. All Rights Reserved.\n\nThis data and any related API are the property of Yukka AG and are protected by copyright and other intellectual property laws. Unauthorized use, reproduction, distribution, or disclosure of this data, in whole or in part, is strictly prohibited.\n\nPermissible Use\n\nAuthorized users may access and use the data provided solely for the purposes expressly authorized by Yukka AG. Any other use of the data, including but not limited to, duplication, reproduction, transmission, or distribution, without the prior written consent of Yukka AG is prohibited.\n\nRestrictions\n\n- You shall not modify, rent, lease, loan, sell, distribute, or create derivative works based on the data provided or through any related API, in whole or in part.\n- You shall not reverse engineer, decompile, or disassemble any portion of the API or data.\n- You shall not use the data for any unlawful or fraudulent purpose.\n\nDisclaimer\n\nYukka AG provides this data \"as is\" without warranties of any kind, either express or implied, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall Yukka AG be liable for any damages whatsoever (including, without limitation, damages for loss of profits, business interruption, loss of information) arising out of the use of or inability to use the data, even if Yukka AG has been advised of the possibility of such damages.\nContact Information\n\nFor inquiries regarding usage rights or permissions, please contact:\n\nYukka AG\nBudapester Strasse 46\nBerlin, Germany, 10787\ninfo@yukkalab.com\n(+49)30 610818690\n"}}

Return type

EventsModel

Parameters

Name	Type	Description	Notes
request_body	List[str]	List with yukka_ids
date_from	date	Date to start from when using time ranges. Format is YYYY-mm-dd.	[optional]
date_to	date	Date to end from (exclusively) when using time ranges. Format is YYYY-mm-dd.	[optional]
default_time_back	str	Default period of time that is used when no end date is supplied	[optional][default to 1w]
event_ids	List[str]	Which events to filter for. One or more of ['E9_A', 'E9_B', 'E2_A', 'E2_B', 'E2_C', 'E3_A', 'E10_A', 'E10_B', 'E15_A', 'E8_A', 'E8_B', 'E8_C', 'E13_A', 'E13_B', 'E1_A', 'E1_B', 'E1_C', 'E11_A', 'E12_A', 'E12_B', 'E18_A', 'E18_B', 'E18_C', 'E18_G', 'E20_A', 'E21_A', 'E21_B', 'E42_A', 'E42_B', 'E45_A', 'E45_C', 'E54_A', 'E6_A', 'E6_B', 'E6_C', 'E6_D', 'E6_E', 'E6_F', 'E19_A', 'E19_B', 'E5_A', 'E7_A', 'E7_B', 'E7_C', 'E17_A', 'E17_B', 'E17_C', 'E17_D', 'E16_A', 'E16_B', 'E14_B', 'E14_A', 'E22_A', 'E22_B', 'E22_C', 'E23_A', 'E23_B', 'E23_C', 'E23_D', 'E45_B', 'E47_A', 'E35_A', 'E35_B', 'E35_C', 'E53_A', 'E53_B', 'E55_A', 'E24_A', 'E24_B', 'E24_C', 'E26_A', 'E26_B', 'E27_A', 'E27_B', 'E27_C', 'E27_D', 'E28_A', 'E29_A', 'E29_B', 'E30_A', 'E31_A', 'E31_B', 'E36_A', 'E36_B', 'E32_A', 'E32_C', 'E32_D', 'E33_A', 'E33_B', 'E33_C', 'E33_D', 'E33_E', 'E33_F', 'E33_G', 'E33_H', 'E33_I', 'E33_J', 'E33_K', 'E34_A', 'E34_B', 'E25_A', 'E25_B', 'E25_C', 'E25_D', 'E25_E', 'E34_C', 'E34_D', 'E33_L', 'E34_E', 'E34_F', 'E37_A', 'E37_B', 'E37_C', 'E38_A', 'E38_B', 'E38_C', 'E38_D', 'E38_E', 'E39_A', 'E39_B', 'E41_A', 'E41_B', 'E41_C', 'E56_A', 'E46_A', 'E46_B', 'E46_C', 'E48_A', 'E48_B', 'E48_C', 'E48_D', 'E48_E', 'E48_F', 'E48_G', 'E48_H', 'E48_I', 'E49_A', 'E49_B', 'E49_C', 'E50_A', 'E50_B', 'E51_A', 'E52_A', 'E52_B', 'E51_B', 'E51_C', 'E51_D', 'E51_E']. Leave empty for all events	[optional]default to []]

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-