2.3.11 metrics_catalogue

Purpose
Retrieves list of metrices.

Parameters

product (Product, required):
Type of product offered.
Supported products are: constants.Product.PRIVATE_INFRA, constants.Product.PRIVATE_EQUITY.
app (App, optional):
Type of application within the product.
Supported apps are: constants.App.MARKET_INDICES, constants.App.THEMATIC_INDICES.
assetClass (AssetClass, optional):
Asset class. Supported classes are: constants.AssetClass.Equity, constants.AssetClass.Debt.

Example

PY

import sipametrics.constants as CONSTANTS

response = await service.metrics_catalogue(
    product=CONSTANTS.Product.PRIVATE_INFRA, 
    app=CONSTANTS.App.MARKET_INDICES
)

#Sample Response
#{
#    "data": {
#        "results": [
#            {
#                "typeId": 60000004,
#                "description": "Index level reflecting the total returns compounded since inception",
#                "displayName": "Index Price",
#                "name": "indexPrice",
#                "timeseries": 1,
#                "type": "Booty",
#                "debtOrEquity": "*",
#                "referenceUrl": "https://docs.edhecinfra.com/docs/equity-total-return-index",
#                "externalTicker": "T01414"
#            },
#            ...
#        ]
#    },
#    "metaData": [
#        {
#            "dataCount": 40
#        }
#    ]
#}