Skip to content
Navigation

Compare companies

GET
https://api.sureshake.com/v2/entities/compare

Query parameters

  • entityIds
    string
    required

    Comma-separated list of 2-5 entity UUIDs to compare

Returns

200

Default Response

JSON
  • data
    object
    required
    • disclosureNote
      string
      required
    • companies
      array of
      object
      required
      • entityId
        string
        required
        format: uuid
      • name
        string
        required
      • slug
        string
        required
      • cik
        string
        or null
        required
      • primaryExchange
        string
        or null
        required
      • primaryTicker
        string
        or null
        required
      • sureshakeTicker
        string
        or null
        required
      • latestPeriod
        object
        or null
        required
        • fiscalYear
          integer
          or null
          required
        • fiscalPeriod
          string
          required
        • periodStart
          string
          or null
          required
        • periodEnd
          string
          required
        • filedDate
          string
          required
        • baseForm
          string
          required
        • currency
          string
          required
        • sourceAccessionNumber
          string
          required
        • sourceUrl
          string
          required
        • statements
          object
          required
          • income_statement
            object
            required
            • status
              converted
              or
              incomplete
              required
            • sfrsSchemaId
              string
              required
            • sfrsVersion
              string
              required
            • payload
              object
              or null
              required
              • schemaType
                income_statement
                required
              • schemaVersion
                1.0.0
                required
              • period
                object
                required
                • startDate
                  string
                  required
                  pattern: ^\d{4}-\d{2}-\d{2}$
                • endDate
                  string
                  required
                  pattern: ^\d{4}-\d{2}-\d{2}$
              • currency
                string
                required
                pattern: ^[A-Z]{3}$
              • revenue
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • costOfGoodsSold
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • operatingExpenses
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • ebitda
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • netIncome
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
            • missingFields
              array of
              string
              required
            • fields
              map of
              string
              required

              Observed statement lines keyed by the schema's line names. The governed nomenclature behind every line — concept definitions, roles, and XBRL mappings — is queryable at GET /v2/sfrs/concepts.

          • balance_sheet
            object
            required
            • status
              converted
              or
              incomplete
              required
            • sfrsSchemaId
              string
              required
            • sfrsVersion
              string
              required
            • payload
              object
              or null
              required
              • schemaType
                balance_sheet
                required
              • schemaVersion
                1.0.0
                required
              • period
                object
                required
                • startDate
                  string
                  required
                  pattern: ^\d{4}-\d{2}-\d{2}$
                • endDate
                  string
                  required
                  pattern: ^\d{4}-\d{2}-\d{2}$
              • currency
                string
                required
                pattern: ^[A-Z]{3}$
              • totalAssets
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • totalLiabilities
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • totalEquity
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • cashAndEquivalents
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • totalDebt
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • currentAssets
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • currentLiabilities
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
            • missingFields
              array of
              string
              required
            • fields
              map of
              string
              required

              Observed statement lines keyed by the schema's line names. The governed nomenclature behind every line — concept definitions, roles, and XBRL mappings — is queryable at GET /v2/sfrs/concepts.

          • cash_flow_statement
            object
            required
            • status
              converted
              or
              incomplete
              required
            • sfrsSchemaId
              string
              required
            • sfrsVersion
              string
              required
            • payload
              object
              or null
              required
              • schemaType
                cash_flow_statement
                required
              • schemaVersion
                1.0.0
                required
              • period
                object
                required
                • startDate
                  string
                  required
                  pattern: ^\d{4}-\d{2}-\d{2}$
                • endDate
                  string
                  required
                  pattern: ^\d{4}-\d{2}-\d{2}$
              • currency
                string
                required
                pattern: ^[A-Z]{3}$
              • operatingCashFlow
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • investingCashFlow
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • financingCashFlow
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • netCashChange
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
            • missingFields
              array of
              string
              required
            • fields
              map of
              string
              required

              Observed statement lines keyed by the schema's line names. The governed nomenclature behind every line — concept definitions, roles, and XBRL mappings — is queryable at GET /v2/sfrs/concepts.

          • financial_supplement
            object
            required
            • status
              converted
              or
              incomplete
              required
            • sfrsSchemaId
              string
              required
            • sfrsVersion
              string
              required
            • payload
              object
              or null
              required
              • schemaType
                financial_supplement
                required
              • schemaVersion
                1.0.0
                required
              • period
                object
                required
                • startDate
                  string
                  required
                  pattern: ^\d{4}-\d{2}-\d{2}$
                • endDate
                  string
                  required
                  pattern: ^\d{4}-\d{2}-\d{2}$
              • currency
                string
                required
                pattern: ^[A-Z]{3}$
              • operatingIncome
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • depreciationAndAmortization
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • capitalExpenditures
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • dilutedEps
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
              • sharesOutstanding
                string
                required
                pattern: ^-?(0|[1-9]\d*)(\.\d+)?$
            • missingFields
              array of
              string
              required
            • fields
              map of
              string
              required

              Observed statement lines keyed by the schema's line names. The governed nomenclature behind every line — concept definitions, roles, and XBRL mappings — is queryable at GET /v2/sfrs/concepts.

        • source
          optional
          string
        • sources
          optional
          array of
          object
          • source
            string
            required
          • assurance
            string
            required
          • sourceRank
            integer
            required
  • meta
    optional
    object
    • timestamp
      string
      required
      format: date-time

400

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

401

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

403

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

404

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

409

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

422

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

429

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

500

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

503

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

Type to search…

↑↓ navigate↵ selectEsc close