Skip to content
Navigation

Compare directory

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

Authorization

  • BearerAuth
    optional
    HTTP

Query parameters

  • subjects
    optional
    string
    maxLength: 1500 · minLength: 1
  • subject
    optional
    string
    maxLength: 255 · minLength: 1
  • industry
    optional
    venture_capital
    or
    private_equity
    or
    asset_management
    or
    banking
    or
    insurance
    or
    fintech
    +31 more

Returns

200

Default Response

JSON
  • data
    object
    required
    • columns
      array of
      object
      required
      • listingId
        string
        required
        format: uuid
      • slug
        string
        required
      • entityId
        string
        required
        format: uuid
      • name
        string
        required
      • role
        subject
        or
        peer
        required
      • tier
        reference
        or
        managed
        or
        managed_public_filings
        required
      • publicIssuer
        boolean
        required
      • financials
        object
        required
        • source
          sec_filing
          or
          sureshake_filing
          or null
          required
        • sourceLabel
          string
          or null
          required
        • fiscalYear
          integer
          or null
          required
        • periodEnd
          string
          or null
          required
        • currency
          string
          or null
          required
        • revenue
          number
          or null
          required
        • revenueGrowth
          number
          or null
          required
        • grossMargin
          number
          or null
          required
        • ebitdaMargin
          number
          or null
          required
        • leverage
          number
          or null
          required
      • employees
        object
        required
        • count
          integer
          or null
          required
        • min
          integer
          or null
          required
        • max
          integer
          or null
          required
        • source
          organization
          or
          corpus
          or null
          required
      • filings
        object
        required
        • reportsPublished
          integer
          required
          minimum: 0
        • publicReports
          integer
          required
          minimum: 0
        • timestampedFilings
          integer
          required
          minimum: 0
    • peerSelection
      object
      required
      • mode
        explicit
        or
        industry
        required
      • industry
        venture_capital
        or
        private_equity
        or
        asset_management
        or
        banking
        or
        insurance
        or
        fintech
        +31 more
        or null
        required
      • description
        string
        required
    • industries
      array of
      object
      required
      • value
        venture_capital
        or
        private_equity
        or
        asset_management
        or
        banking
        or
        insurance
        or
        fintech
        +31 more
        required
      • label
        string
        required
    • reads
      array of
      object
      required
      • heading
        string
        required
      • body
        string
        required
    • computedAt
      string
      required
      format: date-time
  • 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

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