Default

Similarity Index

Changed on

Calculate the textual difference between a company's 10-K / 10-Q reports and the same type of report in the previous year using Cosine Similarity. For example, this endpoint compares 2019's 10-K with 2018's 10-K. Companies breaking from its routines in disclosure of financial condition and risk analysis section can signal a significant change in the company's stock price in the upcoming 4 quarters.

get/stock/similarity-index

Request

  • Base URL
    https://finnhub.io/api/v1
  • URL
    https://finnhub.io/api/v1/stock/similarity-index
  • Auth
    API key in query parameter token

Query parameters

symbolstring

Symbol. Required if cik is empty

cikstring

CIK. Required if symbol is empty

freqstring

<code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>

Response

successful operation

symbolstring

Symbol.

cikstring

CIK.

Example response

{
  "symbol": "symbol",
  "cik": "cik",
  "similarity": [
    {
      "item2": 1.4658129,
      "item7a": 5.637377,
      "item1": 0.8008282,
      "cik": "cik",
      "form": "form",
      "accessNumber": "accessNumber",
      "item7": 5.962134,
      "reportUrl": "reportUrl",
      "item1a": 6.0274563,
      "filedDate": "filedDate",
      "acceptedDate": "acceptedDate",
      "filingUrl": "filingUrl"
    },
    {
      "item2": 1.4658129,
      "item7a": 5.637377,
      "item1": 0.8008282,
      "cik": "cik",
      "form": "form",
      "accessNumber": "accessNumber",
      "item7": 5.962134,
      "reportUrl": "reportUrl",
      "item1a": 6.0274563,
      "filedDate": "filedDate",
      "acceptedDate": "acceptedDate",
      "filingUrl": "filingUrl"
    }
  ]
}

Changes

  • f522c50644cdRevision changes
    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 0f755a71e903Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status