COMPREHEND

COMPREHEND

API ACCESS & DOCUMENTATION OVERVIEW

This document provides details about Helios Life Enterprises’ Comprehend Voice Analytics API.
We feed audio from a variety of companies’ events into our analytics engine. Clients may utilize
this API to fetch results from our proprietary engine.

AN ALTERNATIVE APPROACH TO ALPHA GENERATION

Helios helps investors generate novel sources of alpha to outpace the market. Research shows that the tone of voice accounts for 38% of human communication. The voice leaks information not picked up by traditional text-based analysis. Our Comprehend product uses advanced voice-processing and Al technology to extract this distinct data to add to your understanding of equities.
Feel free to contact us:
Sales@HeliosLife.Enterprises

1. SETUP

AUTHENTICATION

The API authenticates against API keys. There are two methods to create an API key, we will generate keys for you. Let us know during onboarding how many keys are needed. Once the API key is created, you may use it in any request to this API by including it in a header called x-api-key or query param key/api_key. Any generated clients from our OpenAPI spec will automatically include thisheader once configured.

2. ENDPOINTS

BASE PATH: https://comprehend.api.helioslife.venturesSearch: v1/result/search

PARAMETERS

The API will return the latest 250 analysis results by default. Users can modify these results by using the following query parameters:
ParameterValuesDescriptions
product (required)stringLimit results to product line
version (required)stringLimit results to one version
tickerstringLimit results to a specific ticker.
time_fieldevent.publishedLimit results to a specific ticker.
time_start1SO-8601 stringEarliest inclusive date time for search
time_end1SO-8601 stringEarliest exclusive date time for search
sortasc.descSort results by datetirne field. Default to 'desc' for most result time first.
sizeintegerMax number of results per page. Default and max is 250
nextPagestringAllows you to fetch the next set Of results from a previous query. If this parameter is used. all other parameters are ignored. This parameter will be found on the provious response.

RESPONSE

Response will consist at the top level with two fields: data and meta. Data will be an array of Result objects, while the meta will importantly have two fields, nextPage and size. The nextPage field can be used in the subsequent request to get the next page of data. If the nextPage field is empty, then there are no more responses.
Example Response
{
  "data": [
    {
      "entity": {
        "name": "Apple. Inc.",
        "ticker": "AAPL-US",
        "type": "PUB"
      },
      "event": {
        "id": 1201320573,
        "time": "2020-04-30T21:00:00+00:00",
        "title": "Q2 2020 Earnings Call",
        "typo": "E"
      },
      "features": [
        -75.1423004605528,
        7.495495056405716,
        -22.552923614927167,
        -6.220561952653014,
        47.48406723024635,
        57.010009751584825,
        30.118726320481727,
        -27.84965603871163,
        22.706801326773956,
        -51.72502733069923,
        -32.17223715395711,
        -27.322545953902292,
        50.48455733501178,
        20.897950488181777,
        1.873028099305742,
        20.69050745384334,
        -78.57375489519475,
        -79.90466095320839,
        -28.575826474977035,
        -11.623898225606183,
        -6.2375414416864885,
        -6827552111649672,
        -42.80299231319803,
        -85.19815564676277,
        10.689347323636468,
        49.886588326525626
      ],
      "id": 5004119521624064,
      "product": "A26",
      "publishedTime": "2020-06-27T21:33:01.348087+00:00",
      "version": "1.0.0",
      "qualityMetric": 100
    }
  ],
  "meta": {
    "executionID": "test",
    "nextPage": "UTIxelMwaFJiMUZhVOZwcl ItNVNabUl 6VW1 oamJsSml aRWRzZEZwUl NVcERTWJ2Y250c RJtdGxhMESGYTFweFJqSINMVnBZVGSaal IxWjVZVmROZEZvelNuWmtiVlYwVFZSamQwOV VRWGxqYURCTVJXaENSROI5TVhkam3WWnZXbGMxYTFWdFZucGtWM2d3Uj8sRFFXZFFV MFkxWDBWSIJFdEpRa016UW14am3WcD3ZMjB4YUdKdFRteEhRVUZuUVZFOVBRPT0=",
    "size": 1
  }
}

DATETIME FORMATTING

Datetime passed as string parameters to the API are allowed to take several forms. You must have a date sectionfollowed by an optional time section separated by a ‘T’. Previous must be complete to take advantage of the subsequent.Any non passed information will be defaulted to the first of that section. Note for time zone even though you can pass us different offsets any response will return datetime in UTC. Formats include:
DATE
  • YYYY
  • YYYY-MM or YYYYMM
  • YYYY-MM-DD or YYYYMMDD
TIME
  • hh
  • hh:mm or hhmm
  • hh:mm:ss or hhmmss
TIME ZONE
  • Z (UTC)
  • ±HH:MM
  • ±HHMM
  • ±HH

FEATURES IN BETA

PLEASE REQUEST THROUGH YOUR HELIOS CONTACT

{
  "participants": [
    {
      "name": "William John Plovanic",
      "title": "Analyst"
    },
    {
      "name": "Paul S. Weiner",
      "title": "Chief Financial & Accounting Officer"
    },
    {
      "name": "Michael Weinstein",
      "title": "Analyst"
    },
    {
      "name": "Steven Lichtman",
      "title": "Analyst"
    },
    {
      "name": "Kristen Stewart",
      "title": "Analyst"
    },
    {
      "name": "Larry Biegelsen",
      "title": "Analyst"
    },
    {
      "name": "Phillip Lang",
      "title": "President. Chief Executive Officer & Director"
    },
    {
      "name": "Amita Shah",
      "title": "Senior Vice President-Regulatory & Quality Affairs"
    }
  ]
}