MEmerqube
index

Returns the MerQube index with this uuid

Returns the MerQube index with this uuid

get/index/{uuid}

Request

Response

200 response

base_datestring

the date that the index has level 'base_value'

base_yearinteger
calc_freq'Daily' | 'Daily, EOD' | 'Daily, Real Time' | 'Intraday'
currencystring
descriptionstring required
display_month'Jan' | 'Feb' | 'Mar' | 'Apr' | 'May' | 'Jun' | 'Jul' | 'Aug' | 'Sep' | 'Oct' | 'Nov' | 'Dec'
documentsobject
eod_rt_price_checkboolean
excess_strategy'keep_in_cash'
familystring
family_codesstring[]
family_descriptionstring
fill_missing_databoolean

Controls missing equity price recovery. The API derives this flag from stage and stores true only for backtest; all other stages store false.

first_value_datestring
launch_datestring required
methodologystring
monthinteger
namestring required
namespacestring required
plot_metricstring
portfolio_allocation_displayboolean

whether or not portfolio_allocations are shown on the website. false by default

portfolio_handler_idstring
rebal_freq'Annual' | 'Daily' | 'Monthly' | 'Quarterly' | 'Semi-Annual' | 'Weekly' | 'Bi-Monthly' | 'Intraday' | 'None'
sales_force_deal_idstring

SalesForce Deal ID

stage'prod' | 'test' | 'development' | 'backtest' | 'inqubator' required
tagsstring
titlestring required
weighting_method'Other' | 'Equal'
idstring required

Example response

{
  "base_date": "Tue, 04 Jan 2000 00:00:00 GMT",
  "benchmark": {
    "benchmark_metric": "total_return",
    "index_metric": "total_return",
    "threshold": 0.05,
    "ticker": "MQI:XXX"
  },
  "first_value_date": "Tue, 04 Jan 2000 00:00:00 GMT",
  "identifiers": [
    {
      "provider": "bloomberg"
    }
  ],
  "run_configuration": {
    "schedule": {
      "business_days_prior": 1,
      "holiday_calendar": {
        "cal_type": "MIC",
        "mic": "XNYS"
      },
      "timeout_delta": "minutes=17",
      "triggers": [
        "trigger://exchange/XNYS/early_closing.merq"
      ]
    }
  },
  "run_configurations": [
    {
      "schedule": {
        "business_days_prior": 1,
        "holiday_calendar": {
          "cal_type": "MIC",
          "mic": "XNYS"
        },
        "timeout_delta": "minutes=17",
        "triggers": [
          "trigger://exchange/XNYS/early_closing.merq"
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.