Skip to main content

Getting Started

General​

How it Works​

The API is designed to provide a seamless way to interact with our system. It's built on REST principles, and uses standard HTTP protocols. The API accepts JSON formatted requests and also responds in JSON.

Authentication​

Authentication is handled using JWT (JSON Web Tokens). Every request to the API should be accompanied by a JWT which the server will use to verify your identity and ensure you have the necessary permissions to perform the operation. The JWT should be included in the Authorization header with the Bearer schema. The header should look like this:

Authorization: Bearer {your_token}

You can obtain a JWT by contacting the Yukka team under info@yukkalab.com

Entities​

Entites are a core part of all Yukka API's. They are the masterkey to get data for a certain company. For Example is company:apple the entity for the Company Apple Inc. It consists of the entity_type company and the alpha_id apple. This YUKKA ID can then be used to retrieve the News Analytics, metadata or trading signal, as described in the various Endpoint descriptions. This YUKKA ID can be mapped via the ISIN or the Name, via the Metadata API.

Available API's​

  • News Analytics API: surfaces the News analytics data, such as Sentiment, News Volume, Events and Score like Risk or ESG Scores.
  • Metadata API: surfaces the Metadata of entities, such as related companies, C-levels, Location and industry information.
  • Quant API: surfaces quantitative finance data, like Stockprice and market cap as well as trading signals derived from the News Analytics data.

Data Versioning​

The News Analytics API offers multiple versions, each with a unique API URL, tailored datasets, and NLP models to cater to different analytical needs. Selection between versions should be based on analytical needs, type of analysis, and required data detail. Please Note that when we have a new NLP release, we process our historic articles using this Model. Our NLP Models are entirely decoupled from historic stock prices and only focus on the Language, Events and Sentiment expressed in these articles.

Versions Overview​

  • Cockpit-release: For detailed news analytics, with extensive datasets and advanced NLP models. Shorter History with all available News Sources. Access via https://data.api.yukkalab.com/9-3-5/2023-12-13-0.
  • Quant-release: Tailored for quantitative analysis in finance, focusing on efficiency and relevant data points. Longer History but less News considered. Access via https://data.api.yukkalab.com/9-4-0/2023-12-13-0.

Errors​

The API uses conventional HTTP response codes to indicate success or failure of an API request. Codes in the 2xx range indicate success, 4xx codes indicate an error that resulted from the provided information (like missing a required parameter, etc.), and 5xx codes indicate an error with our servers.