GET
/
datasets
/
companies
/
{companyId}
/
financial-reports
curl --request GET \
  --url https://api.tic.io/datasets/companies/{companyId}/financial-reports \
  --header 'x-api-key: <api-key>'
{
  "resultSheets": [
    {
      "row": 123,
      "column": 123,
      "order": 123,
      "localizedFieldName": "<string>",
      "enFieldName": "<string>",
      "displayFormat": "<string>",
      "type": "<string>",
      "value": "<any>",
      "notes": "<string>",
      "highlight": "green"
    }
  ],
  "balanceSheets": [
    {
      "row": 123,
      "column": 123,
      "order": 123,
      "localizedFieldName": "<string>",
      "enFieldName": "<string>",
      "displayFormat": "<string>",
      "type": "<string>",
      "value": "<any>",
      "notes": "<string>",
      "highlight": "green"
    }
  ],
  "footnotes": [
    {
      "row": 123,
      "column": 123,
      "order": 123,
      "localizedFieldName": "<string>",
      "enFieldName": "<string>",
      "displayFormat": "<string>",
      "type": "<string>",
      "value": "<any>",
      "notes": "<string>",
      "highlight": "green"
    }
  ],
  "keyMetrics": [
    {
      "row": 123,
      "column": 123,
      "order": 123,
      "localizedFieldName": "<string>",
      "enFieldName": "<string>",
      "displayFormat": "<string>",
      "type": "<string>",
      "value": "<any>",
      "notes": "<string>",
      "highlight": "green"
    }
  ],
  "additionalInformation": [
    {
      "row": 123,
      "column": 123,
      "order": 123,
      "localizedFieldName": "<string>",
      "enFieldName": "<string>",
      "displayFormat": "<string>",
      "type": "<string>",
      "value": "<any>",
      "notes": "<string>",
      "highlight": "green"
    }
  ]
}

Details

This will return all financial reports available or an specific annual reports based on the query.

Authorizations

x-api-key
string
header
required

Path Parameters

companyId
integer
required

The company id

Query Parameters

iso639_2_LanguageCode
string

The language code of the annual report

annualReportPeriod
integer

Supply if you want to receive only a specific period as entered as YYYYMM

Response

200
application/json
OK
resultSheets
object[] | null
balanceSheets
object[] | null
footnotes
object[] | null
keyMetrics
object[] | null
additionalInformation
object[] | null