{ "components": { "schemas": { "Accept-Encoding": { "default": "gzip, deflate, br", "type": "string" }, "BadRequestError": { "properties": { "code": { "example": 400, "type": "integer" }, "message": { "example": "Invalid input data", "type": "string" } }, "type": "object" }, "CompanyDatapointResponse": { "properties": { "data": { "properties": { "comment": { "nullable": true, "title": "comment", "type": "string" }, "comment_refs": { "items": { "properties": { "doc": { "title": "doc", "type": "string" }, "label": { "title": "label", "type": "string" }, "page": { "title": "page", "type": "integer" } }, "required": [ "doc", "label", "page" ], "type": "object" }, "nullable": true, "title": "comment_refs", "type": "array" }, "company_id": { "title": "company_id", "type": "string" }, "display_label": { "nullable": true, "title": "display_label", "type": "string" }, "document_id": { "readOnly": true, "title": "source_doc", "type": "string" }, "generated_at": { "format": "date-time", "title": "generated_at", "type": "string" }, "id": { "title": "id", "type": "string" }, "not_meaningful": { "nullable": true, "title": "not_meaningful", "type": "boolean" }, "page_number": { "nullable": true, "title": "page_number", "type": "integer" }, "parts": { "items": { "properties": { "id": { "title": "id", "type": "string" }, "op": { "nullable": true, "title": "op", "type": "string" } }, "required": [ "id", "op" ], "type": "object" }, "title": "parts", "type": "array" }, "period": { "title": "period", "type": "string" }, "sheet_type": { "nullable": true, "title": "sheet_type", "type": "string" }, "source_doc": { "nullable": true, "title": "source_doc", "type": "string" }, "source_type": { "nullable": true, "title": "source_type", "type": "string" }, "tag": { "title": "tag", "type": "string" }, "updated_at": { "format": "date-time", "title": "updated_at", "type": "string" }, "value": { "title": "value", "type": "string" } }, "required": [ "comment", "comment_refs", "company_id", "display_label", "generated_at", "id", "not_meaningful", "page_number", "parts", "period", "source_doc", "source_type", "tag", "updated_at", "value" ], "type": "object" } }, "type": "object" }, "CompanyDatapointsResponse": { "properties": { "data": { "items": { "properties": { "comment": { "nullable": true, "title": "comment", "type": "string" }, "comment_refs": { "items": { "properties": { "doc": { "title": "doc", "type": "string" }, "label": { "title": "label", "type": "string" }, "page": { "title": "page", "type": "integer" } }, "required": [ "doc", "label", "page" ], "type": "object" }, "nullable": true, "title": "comment_refs", "type": "array" }, "company_id": { "title": "company_id", "type": "string" }, "display_label": { "nullable": true, "title": "display_label", "type": "string" }, "document_id": { "nullable": true, "title": "document_id", "type": "string" }, "id": { "title": "id", "type": "string" }, "not_meaningful": { "nullable": true, "title": "not_meaningful", "type": "boolean" }, "page_number": { "nullable": true, "title": "page_number", "type": "integer" }, "parts": { "items": { "properties": { "id": { "title": "id", "type": "string" }, "op": { "nullable": true, "title": "op", "type": "string" } }, "required": [ "id", "op" ], "type": "object" }, "title": "parts", "type": "array" }, "period": { "title": "period", "type": "string" }, "sheet_type": { "nullable": true, "title": "sheet_type", "type": "string" }, "source_type": { "nullable": true, "title": "source_type", "type": "string" }, "tag": { "title": "tag", "type": "string" }, "updated_at": { "title": "generated_at", "type": "string" }, "value": { "title": "value", "type": "string" } }, "required": [ "comment", "comment_refs", "company_id", "display_label", "document_id", "id", "not_meaningful", "page_number", "parts", "period", "source_type", "tag", "updated_at", "value" ], "type": "object" }, "title": "data", "type": "array" } }, "type": "object" }, "CompanyDescriptionResponse": { "properties": { "data": { "items": { "properties": { "accounting_standard": { "title": "accounting_standard", "type": "string" }, "country_code": { "title": "country_code", "type": "string" }, "created_at": { "format": "date-time", "title": "created_at", "type": "string" }, "currency": { "title": "currency", "type": "string" }, "description": { "nullable": true, "title": "description", "type": "string" }, "frequency": { "title": "frequency", "type": "string" }, "generated_at": { "format": "date-time", "title": "generated_at", "type": "string" }, "gics_code": { "title": "gics_code", "type": "string" }, "id": { "title": "company_id", "type": "string" }, "last_reported_date": { "format": "date-time", "title": "last_reported_date", "type": "string" }, "last_reported_document_type": { "title": "last_reported_document_type", "type": "string" }, "last_reported_period": { "title": "last_reported_period", "type": "string" }, "multiplier": { "enum": [ "Units", "Thousands", "Millions", "Billions" ], "nullable": true, "title": "multiplier", "type": "string" }, "name": { "title": "name", "type": "string" }, "next_reporting_date": { "nullable": true, "title": "next_reporting_date", "type": "string" }, "next_reporting_period": { "nullable": true, "title": "next_reporting_period", "type": "string" }, "ownership": { "title": "ownership", "type": "string" }, "retired": { "title": "retired", "type": "boolean" }, "retired_date": { "format": "date", "nullable": true, "title": "retired_date", "type": "string" }, "stale": { "title": "stale", "type": "boolean" }, "ticker": { "title": "ticker", "type": "string" }, "updated_at": { "format": "date-time", "title": "updated_at", "type": "string" }, "url_investors_relations": { "nullable": true, "title": "url_investors_relations", "type": "string" }, "year_end": { "title": "year_end", "type": "string" } }, "required": [ "accounting_standard", "id", "country_code", "currency", "description", "frequency", "generated_at", "gics_code", "last_reported_date", "last_reported_document_type", "last_reported_period", "multiplier", "name", "ownership", "retired", "ticker", "updated_at", "year_end" ], "type": "object" }, "title": "data", "type": "array" }, "meta": { "properties": { "next": { "nullable": true, "title": "next", "type": "string" } }, "type": "object" } }, "type": "object" }, "CompanyDocumentsResponse": { "properties": { "data": { "properties": { "company_id": { "title": "company_id", "type": "string" }, "created_at": { "format": "date-time", "title": "created_at", "type": "string" }, "documents": { "items": { "properties": { "document_id": { "title": "document_id", "type": "string" }, "document_period": { "nullable": true, "title": "document_period", "type": "string" }, "document_type": { "title": "document_type", "type": "string" } }, "required": [ "document_id", "document_type" ], "type": "object" }, "title": "documents", "type": "array" }, "generated_at": { "format": "date-time", "title": "generated_at", "type": "string" }, "updated_at": { "format": "date-time", "title": "updated_at", "type": "string" } }, "required": [ "company_id", "documents", "generated_at", "updated_at" ], "type": "object" } }, "type": "object" }, "CompanyFinancialsResponse": { "properties": { "data": { "properties": { "company_id": { "title": "company_id", "type": "string" }, "financials": { "items": { "properties": { "data": { "items": { "properties": { "ids": { "items": { "title": "ids", "type": "string" }, "title": "ids", "type": "array" }, "period": { "title": "period", "type": "string" }, "value": { "nullable": true, "title": "value", "type": "string" } }, "required": [ "ids", "period" ], "type": "object" }, "title": "data", "type": "array" }, "label": { "title": "label", "type": "string" }, "sheet_type": { "title": "sheet_type", "type": "string" }, "tag": { "title": "tag", "type": "string" } }, "type": "object" }, "title": "financials", "type": "array" }, "generated_at": { "format": "date-time", "title": "generated_at", "type": "string" }, "updated_at": { "format": "date-time", "title": "updated_at", "type": "string" } }, "required": [ "company_id", "generated_at", "updated_at" ], "type": "object" } }, "type": "object" }, "CompanyPeriodDatesResponse": { "properties": { "data": { "properties": { "company_id": { "title": "company_id", "type": "string" }, "generated_at": { "format": "date-time", "title": "generated_at", "type": "string" }, "period_dates": { "items": { "properties": { "date": { "format": "date", "title": "date", "type": "string" }, "period": { "title": "period", "type": "string" } }, "required": [ "date", "period" ], "type": "object" }, "title": "period_dates", "type": "array" }, "updated_at": { "format": "date-time", "title": "updated_at", "type": "string" } }, "required": [ "company_id", "generated_at", "updated_at" ], "type": "object" } }, "type": "object" }, "CompanyReportingDatesResponse": { "properties": { "data": { "properties": { "company_id": { "title": "company_id", "type": "string" }, "created_at": { "format": "date-time", "title": "created_at", "type": "string" }, "document_periods": { "items": { "properties": { "document_period": { "title": "document_period", "type": "string" }, "document_type": { "title": "document_type", "type": "string" }, "reporting_date": { "title": "reporting_date", "type": "string" } }, "required": [ "document_period", "document_type", "reporting_date" ], "type": "object" }, "nullable": true, "title": "document_periods", "type": "array" }, "generated_at": { "format": "date-time", "title": "generated_at", "type": "string" }, "updated_at": { "format": "date-time", "title": "updated_at", "type": "string" } }, "required": [ "company_id", "document_periods", "generated_at", "updated_at" ], "type": "object" } }, "type": "object" }, "CompanyTimeSeriesResponse": { "properties": { "data": { "properties": { "company_id": { "title": "company_id", "type": "string" }, "generated_at": { "format": "date-time", "title": "generated_at", "type": "string" }, "interval": { "title": "interval", "type": "string" }, "tag": { "title": "tag", "type": "string" }, "time_series": { "items": { "properties": { "id": { "title": "id", "type": "string" }, "period": { "title": "period", "type": "string" }, "value": { "title": "value", "type": "string" } }, "required": [ "id", "period", "value" ], "type": "object" }, "title": "time_series", "type": "array" }, "updated_at": { "format": "date-time", "title": "updated_at", "type": "string" } }, "required": [ "company_id", "generated_at", "interval", "tag", "time_series", "updated_at" ], "type": "object" } }, "type": "object" }, "ComparablesResponse": { "properties": { "data": { "items": { "properties": { "company_id": { "title": "company_id", "type": "string" }, "comparables": { "items": { "properties": { "id": { "title": "id", "type": "string" }, "label": { "title": "label", "type": "string" }, "period": { "title": "period", "type": "string" }, "tag": { "title": "tag", "type": "string" }, "value": { "title": "value", "type": "string" } }, "required": [ "id", "period", "tag" ], "type": "object" }, "title": "comparables", "type": "array" }, "generated_at": { "format": "date-time", "title": "generated_at", "type": "string" }, "id": { "title": "id", "type": "integer" }, "interval": { "title": "interval", "type": "string" }, "report_period": { "title": "report_period", "type": "string" }, "updated_at": { "format": "date-time", "title": "updated_at", "type": "string" } }, "required": [ "company_id", "generated_at", "interval", "report_period", "updated_at" ], "type": "object" }, "title": "data", "type": "array" }, "meta": { "properties": { "next": { "nullable": true, "title": "next", "type": "string" } }, "type": "object" } }, "type": "object" }, "ForbiddenError": { "properties": { "code": { "example": 403, "type": "integer" }, "message": { "example": "You are not authorized to access this resource", "type": "string" } }, "type": "object" }, "InternalServerError": { "properties": { "code": { "example": 500, "type": "integer" }, "message": { "example": "An unexpected error occurred", "type": "string" } }, "type": "object" }, "NotFoundError": { "properties": { "code": { "example": 404, "type": "integer" }, "message": { "example": "The requested resource was not found", "type": "string" } }, "type": "object" }, "TagListResponse": { "properties": { "data": { "items": { "properties": { "comparables_label": { "nullable": true, "title": "comparables_label", "type": "string" }, "description": { "nullable": true, "title": "description", "type": "string" }, "formulae": { "items": { "properties": { "formula_name": { "title": "formula_name", "type": "string" }, "parts": { "items": { "properties": { "mandatory": { "nullable": true, "title": "mandatory", "type": "boolean" }, "op": { "nullable": true, "title": "op", "type": "string" }, "period": { "nullable": true, "title": "period", "type": "string" }, "tag": { "title": "tag", "type": "string" } }, "required": [ "tag" ], "type": "object" }, "title": "parts", "type": "array" } }, "required": [ "formula_name", "parts" ], "type": "object" }, "title": "formulae", "type": "array" }, "sheet_type": { "title": "sheet_type", "type": "string" }, "tag": { "title": "tag", "type": "string" }, "units": { "nullable": true, "title": "units", "type": "string" } }, "required": [ "formulae", "sheet_type", "tag" ], "type": "object" }, "title": "data", "type": "array" } }, "type": "object" }, "at_timestamp": { "format": "date-time", "type": "string" }, "companyId": { "example": "fibercop", "type": "string" }, "companyId-23227a0e-de82-4ffb-ac6d-26907473945e": { "example": "edf", "type": "string" }, "companyId-6398d03a-272e-44ac-9246-fc8c707ae171": { "example": "edf", "type": "string" }, "companyId-9c093236-7cd7-47d5-92ae-6dc4697204e8": { "example": "edf", "type": "string" }, "companyId-e678188a-3136-4d22-9ff6-578f1db04234": { "example": "edf", "type": "string" }, "company_ids": { "example": "ineos,edf", "pattern": "^[a-z0-9,]+$", "type": "string" }, "company_ids-6a939614-06dd-4225-a11a-34e170c1d5c1": { "example": "edf", "pattern": "^[a-z0-9,]+$", "type": "string" }, "continuation_token": { "type": "string" }, "datapointId": { "example": "ZWRmK2NodWJiaWVyLWJhcm9zYXVydXMrMTIyNzAwNDQ1OQ==", "type": "string" }, "end_timestamp": { "format": "date-time", "type": "string" }, "interval": { "enum": [ "ltm", "annual", "interim" ], "example": "annual", "type": "string" }, "interval-5704baf2-d005-4af7-8742-a8b3fb8967e2": { "enum": [ "ltm", "annual", "interim" ], "example": "ltm", "type": "string" }, "is_retired": { "type": "string" }, "last_reported_date_after": { "format": "date-time", "type": "string" }, "last_reported_date_before": { "format": "date-time", "type": "string" }, "limit": { "minimum": 1, "type": "integer" }, "limit-55856b4b-abac-4b4a-be3a-ae232edb4ba1": { "example": 5, "minimum": 1, "type": "integer" }, "setType": { "enum": [ "financials", "timeseries" ], "example": "timeseries", "type": "string" }, "start_timestamp": { "example": "2025-01-01T00:00:00Z", "format": "date-time", "type": "string" }, "tag": { "example": "Revenue", "type": "string" }, "tickers": { "pattern": "^[A-Z0-9,]+$", "type": "string" }, "updated_after": { "format": "date-time", "type": "string" }, "updated_before": { "format": "date-time", "type": "string" } }, "securitySchemes": { "authorizeClient": { "in": "header", "name": "x-api-key", "type": "apiKey" } } }, "info": { "description": "Cognitive Credit Company Data API", "title": "Data API", "version": "1" }, "openapi": "3.0.3", "paths": { "/companies": { "get": { "description": "Returns a list of company description objects.", "operationId": "get_company_listings", "parameters": [ { "description": "ISO-8601 Timestamp to return companies snapshot for", "in": "query", "name": "at_timestamp", "required": false, "schema": { "$ref": "#/components/schemas/at_timestamp" } }, { "description": "filter by 'retired' status - (true|false)", "in": "query", "name": "is_retired", "required": false, "schema": { "$ref": "#/components/schemas/is_retired" } }, { "description": "filter by supplied company ids - comma separated list", "in": "query", "name": "company_ids", "required": false, "schema": { "$ref": "#/components/schemas/company_ids" } }, { "description": "filter by supplied company tickers", "in": "query", "name": "tickers", "required": false, "schema": { "$ref": "#/components/schemas/tickers" } }, { "description": "maximum number of results to return - typically used when paging", "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/limit" } }, { "description": "Only return company descriptions added or updated on or after this ISO-8601 timestamp", "in": "query", "name": "updated_after", "required": false, "schema": { "$ref": "#/components/schemas/updated_after" } }, { "description": "Only return company descriptions added or updated before this ISO-8601 timestamp", "in": "query", "name": "updated_before", "required": false, "schema": { "$ref": "#/components/schemas/updated_before" } }, { "description": "Only return company descriptions for companies with reports on or after this ISO-8601 timestamp", "in": "query", "name": "last_reported_date_after", "required": false, "schema": { "$ref": "#/components/schemas/last_reported_date_after" } }, { "description": "Only return company descriptions for companies with reports before this ISO-8601 timestamp", "in": "query", "name": "last_reported_date_before", "required": false, "schema": { "$ref": "#/components/schemas/last_reported_date_before" } }, { "description": "identifier of last result in previous result set - allows continuation of paged results", "in": "query", "name": "continuation_token", "required": false, "schema": { "$ref": "#/components/schemas/continuation_token" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDescriptionResponse" } } }, "description": "A list of companies, each containing company information" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get company descriptions", "tags": [] } }, "/companies/{companyId}/datapoints/bulk/{setType}": { "get": { "description": "Returns object with full set of datapoints", "operationId": "get_company_bulk_datapoints", "parameters": [ { "description": "identifier for the company to fetch datapoints for", "in": "path", "name": "companyId", "required": true, "schema": { "$ref": "#/components/schemas/companyId" } }, { "description": "Type of datapoints set (must be 'financials' or 'timeseries')", "in": "path", "name": "setType", "required": true, "schema": { "$ref": "#/components/schemas/setType" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDatapointsResponse" } } }, "description": "All company datapoints." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get a company datapoints list", "tags": [] } }, "/companies/{companyId}/documents": { "get": { "description": "Returns list of company documents with type and period", "operationId": "get_company_documents", "parameters": [ { "description": "identifier for the company to fetch document list for", "in": "path", "name": "companyId", "required": true, "schema": { "$ref": "#/components/schemas/companyId-e678188a-3136-4d22-9ff6-578f1db04234" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDocumentsResponse" } } }, "description": "A list of Documents, each containing document id, document type and corresponding period." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get company documents", "tags": [] } }, "/companies/{companyId}/financials": { "get": { "description": "Returns historical financials data for single company", "operationId": "get_company_financials", "parameters": [ { "description": "identifier for the company to fetch financials for", "in": "path", "name": "companyId", "required": true, "schema": { "$ref": "#/components/schemas/companyId" } }, { "description": "ISO-8601 Timestamp to return financials snapshot for", "in": "query", "name": "at_timestamp", "required": false, "schema": { "$ref": "#/components/schemas/at_timestamp" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyFinancialsResponse" } } }, "description": "A list of Financials, each containing a list of historical values." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get company financials", "tags": [] } }, "/companies/{companyId}/periods": { "get": { "description": "Returns end dates of financial reporting periods for given company", "operationId": "get_period_dates", "parameters": [ { "description": "identifier for the company to fetch financials for", "in": "path", "name": "companyId", "required": true, "schema": { "$ref": "#/components/schemas/companyId-23227a0e-de82-4ffb-ac6d-26907473945e" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPeriodDatesResponse" } } }, "description": "A list of Period Dates, each containing a financial period and its corresponding end date." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get company period dates", "tags": [] } }, "/companies/{companyId}/reportingdates": { "get": { "description": "Returns list of reporting dates for company", "operationId": "get_company_reporting_dates", "parameters": [ { "description": "identifier for the company to fetch documents periods for", "in": "path", "name": "companyId", "required": true, "schema": { "$ref": "#/components/schemas/companyId-9c093236-7cd7-47d5-92ae-6dc4697204e8" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyReportingDatesResponse" } } }, "description": "A list of reporting dates, with a document type and its period." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get company reporting dates", "tags": [] } }, "/companies/{companyId}/timeseries/{tag}/{interval}": { "get": { "description": "Returns all historical values of a specific comparable for a given company and interval", "operationId": "get_company_time_series", "parameters": [ { "description": "identifier for the company to fetch time series data for", "in": "path", "name": "companyId", "required": true, "schema": { "$ref": "#/components/schemas/companyId-6398d03a-272e-44ac-9246-fc8c707ae171" } }, { "description": "identifier for the comparable tag to fetch time series data for", "in": "path", "name": "tag", "required": true, "schema": { "$ref": "#/components/schemas/tag" } }, { "description": "identifier for the interval to fetch time series data for", "in": "path", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/interval-5704baf2-d005-4af7-8742-a8b3fb8967e2" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyTimeSeriesResponse" } } }, "description": "A list of values for a particular comparable, over the reporting history of a particular company for a specific interval." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get company time series", "tags": [] } }, "/comparables/updates": { "get": { "description": "Returns comparables data from companies' revisions available to user, from a given start timestamp and optional end timestamp", "operationId": "get_comparables_updates_since", "parameters": [ { "description": "ISO-8601 Timestamp to return comparables updates since (all updates greater than or equal to the timestamp)", "in": "query", "name": "start_timestamp", "required": false, "schema": { "$ref": "#/components/schemas/start_timestamp" } }, { "description": "ISO-8601 Timestamp to return comparables updates until (all updates less than, but not equal to, the timestamp)", "in": "query", "name": "end_timestamp", "required": false, "schema": { "$ref": "#/components/schemas/end_timestamp" } }, { "description": "filter by supplied company ids", "in": "query", "name": "company_ids", "required": false, "schema": { "$ref": "#/components/schemas/company_ids-6a939614-06dd-4225-a11a-34e170c1d5c1" } }, { "description": "maximum number of results to return - typically used when paging", "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/limit-55856b4b-abac-4b4a-be3a-ae232edb4ba1" } }, { "description": "identifier of last result in previous result set - allows continuation of paged results", "in": "query", "name": "continuation_token", "required": false, "schema": { "$ref": "#/components/schemas/continuation_token" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparablesResponse" } } }, "description": "A list of company-comparables, each with a company id and list of comparable objects." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get company comparables updates for a given time period", "tags": [] } }, "/comparables/{interval}": { "get": { "description": "Returns comparables data from companies' revisions available to user", "operationId": "get_company_comparables_subtypes", "parameters": [ { "description": "identifier for the interval of comparables data to fetch", "in": "path", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/interval" } }, { "description": "ISO-8601 Timestamp to return comparables snapshot for", "in": "query", "name": "at_timestamp", "required": false, "schema": { "$ref": "#/components/schemas/at_timestamp" } }, { "description": "filter by supplied company ids", "in": "query", "name": "company_ids", "required": false, "schema": { "$ref": "#/components/schemas/company_ids" } }, { "description": "maximum number of results to return - typically used when paging", "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/limit" } }, { "description": "identifier of last result in previous result set - allows continuation of paged results", "in": "query", "name": "continuation_token", "required": false, "schema": { "$ref": "#/components/schemas/continuation_token" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparablesResponse" } } }, "description": "A list of company-comparables, each with a company id and list of comparable objects." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get company comparables", "tags": [] } }, "/datapoints/{datapointId}": { "get": { "description": "Returns details of an individual datapoint for a company", "operationId": "get_company_datapoint", "parameters": [ { "description": "identifier for the datapoint", "in": "path", "name": "datapointId", "required": true, "schema": { "$ref": "#/components/schemas/datapointId" } }, { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDatapointResponse" } } }, "description": "A single datapoint, including details about its calculation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get a company datapoint", "tags": [] } }, "/tags": { "get": { "description": "Returns object with list of tags", "operationId": "get_tag_list", "parameters": [ { "description": "client supported encodings (gzip, deflate, br)", "in": "header", "name": "Accept-Encoding", "required": false, "schema": { "$ref": "#/components/schemas/Accept-Encoding" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagListResponse" } } }, "description": "List of tags." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } }, "description": "Internal Server Error" } }, "security": [ { "authorizeClient": [] } ], "summary": "Get list of tags with definitions", "tags": [] } } }, "security": [ { "authorizeClient": [] } ], "servers": [ { "url": "https://cognitivecreditapi.com/{version}", "variables": { "version": { "default": "v1" } } } ] }