Skip to content

Latest commit

 

History

History
270 lines (250 loc) · 6.56 KB

compound.md

File metadata and controls

270 lines (250 loc) · 6.56 KB

(/compound)

Scopes

Here you can find all the scopes available in this particular namespace. {% api-method method="WS" host="wss://api-v4.zerion.io/" path="compound" %} {% api-method-summary %} info {% endapi-method-summary %} {% api-method-description %} Example request [ "get", { "scope": ["info"], "payload": { "body parameter": "value" } } ] {% endapi-method-description %} {% api-method-spec %} {% api-method-request %} {% api-method-body-parameters %} {% api-method-parameter name="address" type="str" %} Default: - {% endapi-method-parameter %} {% api-method-parameter name="currency" type="enum" %} PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd {% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %} {% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} Successful result. {% endapi-method-response-example-description %}


[
    "received compound info",
    {
        "meta": {
            "status": "ok",
            "request parameter1": "value1",
            "request parameter2": "value2"
        },
        "payload": {
            "info": CompoundInfo
        }
    }
]

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

{% api-method method="WS" host="wss://api-v4.zerion.io/" path="compound" %} {% api-method-summary %} assets {% endapi-method-summary %} {% api-method-description %} Example request [ "get", { "scope": ["assets"], "payload": { "body parameter": "value" } } ] {% endapi-method-description %} {% api-method-spec %} {% api-method-request %} {% api-method-body-parameters %} {% api-method-parameter name="currency" type="enum" %} PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd {% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %} {% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} Successful result. {% endapi-method-response-example-description %}


[
    "received compound assets",
    {
        "meta": {
            "status": "ok",
            "request parameter1": "value1",
            "request parameter2": "value2"
        },
        "payload": {
            "assets": List[CompoundAsset]
        }
    }
]

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

{% api-method method="WS" host="wss://api-v4.zerion.io/" path="compound" %} {% api-method-summary %} actions {% endapi-method-summary %} {% api-method-description %} Example request [ "get", { "scope": ["actions"], "payload": { "body parameter": "value" } } ] {% endapi-method-description %} {% api-method-spec %} {% api-method-request %} {% api-method-body-parameters %} {% api-method-parameter name="address" type="str" %} Default: - {% endapi-method-parameter %} {% api-method-parameter name="currency" type="enum" %} PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd {% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %} {% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} Successful result. {% endapi-method-response-example-description %}


[
    "received compound actions",
    {
        "meta": {
            "status": "ok",
            "request parameter1": "value1",
            "request parameter2": "value2"
        },
        "payload": {
            "actions": List[CompoundAction]
        }
    }
]

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

{% api-method method="WS" host="wss://api-v4.zerion.io/" path="compound" %} {% api-method-summary %} deposits {% endapi-method-summary %} {% api-method-description %} Example request [ "get", { "scope": ["deposits"], "payload": { "body parameter": "value" } } ] {% endapi-method-description %} {% api-method-spec %} {% api-method-request %} {% api-method-body-parameters %} {% api-method-parameter name="address" type="str" %} Default: - {% endapi-method-parameter %} {% api-method-parameter name="currency" type="enum" %} PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd {% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %} {% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} Successful result. {% endapi-method-response-example-description %}


[
    "received compound deposits",
    {
        "meta": {
            "status": "ok",
            "request parameter1": "value1",
            "request parameter2": "value2"
        },
        "payload": {
            "deposits": List[CompoundDeposit]
        }
    }
]

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

{% api-method method="WS" host="wss://api-v4.zerion.io/" path="compound" %} {% api-method-summary %} loans {% endapi-method-summary %} {% api-method-description %} Example request [ "get", { "scope": ["loans"], "payload": { "body parameter": "value" } } ] {% endapi-method-description %} {% api-method-spec %} {% api-method-request %} {% api-method-body-parameters %} {% api-method-parameter name="address" type="str" %} Default: - {% endapi-method-parameter %} {% api-method-parameter name="currency" type="enum" %} PriceCurrency: eth, btc, usd, eur, krw, rub, gbp, aud, cad, inr, jpy, nzd, try, zar, cny, chf. Default: usd {% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %} {% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} Successful result. {% endapi-method-response-example-description %}


[
    "received compound loans",
    {
        "meta": {
            "status": "ok",
            "request parameter1": "value1",
            "request parameter2": "value2"
        },
        "payload": {
            "loans": List[CompoundLoan]
        }
    }
]

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}