/v1/models

This takes no parameters and returns a list of available models and associated metadata. A response is a list of arrays that look like this:

[
  {
    "slug": "aave-v2.get-lending-pool",
    "displayName": "Aave V2 - Get lending pool for main market",
    "description": "Aave V2 - Get lending pool for main market",
    "latestVersion": "1.1",
    "developer": "Credmark",
    "category": "protocol",
    "subcategory": "aave-v2",
    "tags": [],
    "input": {...},
    "output": {...},
    "error": {...},
    "cmfVersion": "0.8.39"
  },
  {

  },

]

The following are extracted from the decorator @Model.describe() which model developers are encouraged to provide.

FieldValueMeaning

slug

aave-v2.get-lending-pool

The slug (unique ID) of the model that was run.

displayName

Aave V2 - Get lending pool for main market

The model name suitable for display in a UI.

description

Aave V2 - Get lending pool for main market

A full description of the model. (Obviously lacking in this instance!)

latestVersion

1.1

The most recent version of this model.

developer

Credmark

The name of the model’s developer.

category

protocol

The model’s category. This is for discovery convenience.

subcategory

aave-v2

The model’s sub-category.

tags

Another discovery convenience. A list of tags. (None were provided by the author of this model.)

The fields input, output, and error are dictionaries that describe the inputs, outputs, and errors returned by this model. This data is extracted from the model code. Developers may choose to provide example input. This data is useful for reference or for anyone wanting to write a model explorer interface.

Last updated