LeanVal Research Logo

LeanVal resAPI

resAPI is a simple RESTful API built with Flask for LeanVal Research.

Token: 'TEST_LEANVAL_RESAPI'
Valid ISINs: 'NL0011794037 (ABN)', 'NL0011540547 (Ahold)', 'DE0008404005 (Allianz)'
Output Format: JSON (or XML: &format=xml)

Get stock metadata

Returns static metadata for a given stock.

/api/v1/stock/static/meta?isin=NL0011794037&token=TEST_LEANVAL_RESAPI

Parameters:
isin = The ISIN of the stock.
token = Authentication token.

Get static description

Returns German and English descriptions and logo url for a given stock.

/api/v1/stock/static/description?isin=NL0011794037&token=TEST_LEANVAL_RESAPI

Parameters:
isin = The ISIN of the stock.
token = Authentication token.

Get current ratios

Returns the main ratios for a stock for the current month.

/api/v1/stock/ratios/year_table?isin=NL0011794037&token=TEST_LEANVAL_RESAPI

Parameters:
isin = The ISIN of the stock.
token = Authentication token.

Get historical ratios for specific month

Returns historical monthly ratios for a given stock for a specific month.

/api/v1/stock/ratios/monthly?isin=NL0011794037&month=202312&token=TEST_LEANVAL_RESAPI

Parameters:
isin = The ISIN of the stock.
startmonth = The month from which to start the data (format: YYYYMM).
token = Authentication token.

Get historical ratios on companies' repot dates

Returns ratios on annual basis for a given stock over a specific number of years.

/api/v1/stock/ratios/year_table?isin=NL0011794037&years=5&token=TEST_LEANVAL_RESAPI

Parameters:
isin = The ISIN of the stock.
years = The number of financial years to return data for.
token = Authentication token.


OPEN AI

Get latest news based on quarterly results from the company page

Returns a summary of current news.

/api/v1/coanalyst/comments?isin=NL0011794037&type=txt_news&token=TEST_LEANVAL_RESAPI

Parameters:
isin = The ISIN of the stock.
type = The type of news to return (default: news).
- news: Returns a text summary of latest news.
- performance: Description current performance and voting.
- lars: Description LARS-Results
- metrics: Long description of LeanVal metrics.
token = Authentication token.


LeanVal Analytic Rating System (LARS)

Get current data for LARS

Returns a table with all necessary data.

/api/v1/stock/lars/current_data?isin=NL0011794037&token=TEST_LEANVAL_RESAPI

Parameters:
isin = The ISIN of the stock.
token = Authentication token.


Exception Codes

2xx Status Codes (Success):
200 OK: Indicates that the request has succeeded.
204 No Content for ISIN: The server has fulfilled the request but could not return data in a response body.

4xx Status Codes (Client Error):
400 Bad Request. Missing / incomplete ISIN: The server could not understand the request due to incorrect syntax. The client should NOT repeat the request without modifications.
401 Unauthorized: The client must authenticate itself to get the requested response.
404 ISIN Not Found: The server can not find the requested ISIN.

5xx Status Codes (Server Error):
500 Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request.

Quelle: https://restfulapi.net/http-status-codes/

Backlog

Daten:
price_loc(isin, dt_start, dt_end)
total_return(isin, dt_start, dt_end, idx_1, idx_2)
fundamentals(isin, year_table)
lars(isin)

News:
company_headline(isin, text_size)
market_news(isin, text_size)
quarterely_results(isin, text_size)

Kommentare:
lars(isin, text_size)
ratios(isin, isin, text_size)
valuation(isin, isin, text_sizee)

Sonstige:
Portfolios
Markets