Reports - Borsdata-Sweden/API GitHub Wiki
Sample API calls
Get all reports for a list of instruments (max 50 instruments)
[URL]/v1/instruments/reports?authKey={{KEY}}&instList=2,3,6&original=1
https://github.com/Borsdata-Sweden/API/wiki/API-Array-calls
instList is a comma separated list. Max 50 instruments is allowed.
Try use this to keep down number of Api calls
Get all reports for a one instrument as original report values
[URL]/v1/instruments/750/reports?authKey={{KEY}}&maxcount=20&original=1
Get all reports for a one instrument as converted report values to Stockprice currency
[URL]/v1/instruments/750/reports?authKey={{KEY}}&maxcount=20&original=0
Get all YEAR reports for a one instrument as original report values
[URL]/v1/instruments/750/reports/year?authKey={{KEY}}&maxcount=20&original=1
Get all R12 reports for a one instrument as original report values
[URL]/v1/instruments/750/reports/r12?authKey={{KEY}}&maxcount=20&original=1
Get all QUARTER reports for a one instrument as original report values.
[URL]/v1/instruments/750/reports/quarter?authKey={{KEY}}&maxcount=20&original=1
[URL] is https://apiservice.borsdata.se/
Overview Reports
From API you have aceess to 3 different reports.
You find more code details in swagger docs.
| Report | Api Model | Desc |
|---|---|---|
| R12 | ReportR12V1 | The report is calculated from the last 4 Quarter reports. (R12=Rolling 12 month) |
| Year | ReportR12V1 | Only get the Full year Reports (The latest report is R12). |
| Quarter | ReportQuarterV1 | Quarter reports. Normaly the result from 3 month. |
Report Periods
Most companies release 5 reports every year.
4 Quarter reports and one full year report.
We name the reports with a Period 1 to 5.
| Period (p) | Desc |
|---|---|
| 1 - 4 | Data is based on Quarter reports. Q1, Q2, Q3, Q4 |
| 5 | Data is based on Full Year Report |
There is exceptions of companies with half year reports.
They only give three reports with period 2,4,5.
Report count
Default you get max 10 reports.
You can use querystring &maxCount to get up to 20 year reports and 40 R12&Quarter reports.
Ex &maxcount=20.
You can also use maxcount to limit number of reports.
Report Currency
Report data has two states.
Converted or Original.
Converted is default, and means that all reportdata is converted to stockprice currency.
Original means that reportdata is returned in same currency as the Pdf Report.
Use the &original flag (0,1) to get Converted or Original report data.
Why?
More than 280 instruments in Nordic has different Report-currency than Stockprice-currency.
Sometimes when we calculate Kpis we need the same Report-currency as Stockprice-currency.
In report data you have two important values. [currency] and [currency_Ratio].
currency
[currency] is the Original report currency and is never changed in API call.
This will always show Original report currency even if the reportdata is converted to Stockprice currency.
Currency Ratio
[currency_Ratio] is the ratio to convert original Report-currency than Stockprice-currency.
If Instrument has same Report-currency and Stockprice-currency then this is 1.
Broken fiscal year
Many companies has broken report year. They don't follow the normal calender year.
If a company start the reportperiod in August. Then Report Period=1 starts in August.
Report Period=1 means the First Quarter report for this reportperiod (Not first calender period)
Check Report [broken_Fiscal_Year=1].
Report Data Model
This table describe Report data Model.
We translate to Swedish for most of our customers.
| English | Swedish | Convert |
|---|---|---|
| Revenues | Totala intäkter | Million |
| Gross Income | Bruttoresultat | Million |
| Operating Income | Rorelseresultat | Million |
| Profit Before Tax | Resultat före skatt | Million |
| Profit to Equity Holders | Resultat före aktieagare | Million |
| Earnings Per Share | Vinst före aktie | Million |
| Number of shares | Antal aktier | Million |
| Dividend | Utdelning | Million |
| Intangible assets | Immateriella tillgångar | Million |
| Tangible assets | Materiella tillgångar | Million |
| Financial assets | Finansiella tillgångar | Million |
| Non-current assets | Summa anläggningstillgångar | Million |
| Cash and equivalents | Kassa Bank | Million |
| Current assets | Summa omsättnings tillgangar | Million |
| Total Assets | Summa Tillgångar | Million |
| Total Equity | Summa eget kapital | Million |
| Non-current liabilities | Långfristiga skulder | Million |
| Current liabilities | Kortfristiga skulder | Million |
| Total Equity | Summa skulder och eget kapital | Million |
| Net Debt | Netto skuld | Million |
| Cash flow from operating activities | Kassaflöde löpande verksamhet | Million |
| Cash flow from investing activities | Kassaflöde investerings verksamhet | Million |
| Cash flow from financing activities | Kassaflöde finansierings verksamhet | Million |
| Cash flow for the year | Årets kassaflöde | Million |
| Free Cash Flow | Fritt kassaflöde | Million |
| Stock Price Average | Aktiekurs högsta | Share |
| Stock Price High | Aktiekurs lägsta | Share |
| Stock Price Low | Aktiekurs snitt | Share |
| Report Start Date | Rapport start datum | Date |
| Report End Date | Rapport slut datum | Date |
| Report End Date | Rapport slut datum | Date |
| Currency | Valuta | |
| Currency Ratio | Valuta konvertering | |
| Net Sales | Omsättning | Million |
| Report Date | Rapportdatum | Date |