Financial summary
curl --request GET \
--url https://api.tic.io/datasets/companies/{companyId}/financial-summary \
--header 'x-api-key: <api-key>'import requests
url = "https://api.tic.io/datasets/companies/{companyId}/financial-summary"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.tic.io/datasets/companies/{companyId}/financial-summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tic.io/datasets/companies/{companyId}/financial-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tic.io/datasets/companies/{companyId}/financial-summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tic.io/datasets/companies/{companyId}/financial-summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tic.io/datasets/companies/{companyId}/financial-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"rs_NetSalesK": 123,
"rs_OtherOperatingIncomeK": 123,
"rs_OperatingProfitOrLossK": 123,
"rs_SumFinancialItemsK": 123,
"rs_ProfitAfterFinancialItemsK": 123,
"bs_TotalAssetsK": 123,
"fn_NumberOfEmployees": 123,
"km_OperatingMargin": 123,
"km_NetProfitMargin": 123,
"km_EquityAssetsRatio": 123,
"km_GrossMargin": 123,
"isAudited": true
}
]Companies
Financial summary
Gets financial summary of the company by it’s id
GET
/
datasets
/
companies
/
{companyId}
/
financial-summary
Financial summary
curl --request GET \
--url https://api.tic.io/datasets/companies/{companyId}/financial-summary \
--header 'x-api-key: <api-key>'import requests
url = "https://api.tic.io/datasets/companies/{companyId}/financial-summary"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.tic.io/datasets/companies/{companyId}/financial-summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tic.io/datasets/companies/{companyId}/financial-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tic.io/datasets/companies/{companyId}/financial-summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tic.io/datasets/companies/{companyId}/financial-summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tic.io/datasets/companies/{companyId}/financial-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"rs_NetSalesK": 123,
"rs_OtherOperatingIncomeK": 123,
"rs_OperatingProfitOrLossK": 123,
"rs_SumFinancialItemsK": 123,
"rs_ProfitAfterFinancialItemsK": 123,
"bs_TotalAssetsK": 123,
"fn_NumberOfEmployees": 123,
"km_OperatingMargin": 123,
"km_NetProfitMargin": 123,
"km_EquityAssetsRatio": 123,
"km_GrossMargin": 123,
"isAudited": true
}
]Details
This endpoint will return a financial summary for the last four years. Properties are prefixed to give a sense where they are placed in the financial report. Table below shows the prefixes and description.| Prefix | Description |
|---|---|
| rs | Resultsheet |
| bs | Balancesheet |
| fn | Footnote |
| km | Key metrics |
Key metrics
The keymetrics are calculated according to the following table.| Prefix | Description |
|---|---|
| km_OperatingMargin | EBIT (Operating profit/loss) divided by net sales |
| km_NetProfitMargin | EBIE (Earnings Before Interest Expense) divided by net sales (NOTE ! if net sales isn’t present but other other operating income is reported we will instead use that for calculation) |
| km_EquityAssetsRatio | Sum equity plus adjusted equity (sum untaxed reserves deducated with the corporate tax) divided by total assets |
| km_GrossMargin | Gross profit/loss divided by net sales |
Go deeper
To access all records of the financial report you should use the endpoint for financial-reports that gives you a ready to use table structure with localized names for the financial report.Authorizations
Path Parameters
The company id
Response
200 - application/json
OK