API Documentation

Interface Conventions

• All interface routes carry versions.

• To avoid significant impact on upstream and downstream partners, interfaces within the current version, once released, strive to avoid changes and pursue stability in parameter names, parameter types, and request routing.

Basic Information

• Partner APIs support RESTful requests and Websocket connections. RESTful request parameters are passed in JSON format.

• Development environment BaseURL: https://cedefi.lorenzo-dev.xyz

• The universal return format is JSON.

Access Control

• Authentication

  • Each interface has its own independent authentication type. Authentication is not required by default.

  • Authentication fields include: IP address, API key, secret signature, whilelistlist, etc.

• Rate limit

  • RESTful requests can be rate limited. E.g., no more than 5 requests per second for each IP address .

  • Websocket connection can also pose subscription limits and communication frequency limits.

Interface Description

• /partner/v1/vault/list

  • Function description

    GET request;

    This interface can obtain all currently running vaults.

  • Request parameters: None

  • Return value

    Field name	Field description	Remarks
    address	Vault address
    vaultType	Vault type	Such as simple/composed/link, etc

• /partner/v1/vault/all

  • Function description

    GET request;

    This interface returns a list of all vaults on the platform.

  • Request parameters: None

  • Return value

    Field name	Field description	Remarks
    address	Vault address
    vaultType	Vault type	Such as simple/composed/link, etc
    status	Vault status	working: running; stop: permanent stop; pause: pause;

• /partner/v1/vault/basic

  • Function description

    Get request;

    The interface obtains the current basic information of the vault based on the vault address: unitNAV, PnL, APR7d, APR30d, Chains distributed、symbol、userAmount、TVL、underlying

  • Request parameters

    {
        "address": "0xdAC17F958D2ee523a2206206994597C13D831ec7"
    }

  • Return value

    Field name	Field description	Remarks
    address	Vault contract address
    unitNAV	Net worth of funds
    PnL	Yield value
    APR7d	7-Day yield
    APR30d	30-Day yield
    Chains	Chain deployed on by vault	Ethereum, BSC, etc.
    Symbol	Asset symbol	enzoBTC, finBTC, etc.
    userAmount	Current number of participants
    TVL	Current Total Value Locked	Unit: currency standard
    underlying	Underlying assets of the vault	BTC, ETH, etc.

• /partner/v1/vault/freeze/list

  • Function description

    GET request;

    This interface queries the current vault's blacklist and frozen asset list based on the vault address.

    If the returned list is empty, then nothing has been blacklisted or frozen.

  • Request parameters

    {
        "address": "0xdAC17F958D2ee523a2206206994597C13D831ec7"
    }

  • Return value (as list element)

    Field name	Field description	Remarks
    UserAddr	Address of the blacklisted user
    Amount	Amount of frozen asset	Value is after dividing 10^18
    AssetAddr	Token address of the frozen asset
    FreezeTime	The most recent frozen time	UTC timestamp; The same asset of a user can be frozen multiple times
    Chain	Chain deployed on by vault	Ethereum, BSC, etc.
    Symbol	Asset symbol	enzoBTC, finBTC, etc.

• /partner/v1/vault/performance

  • Function description

    GET request;

    This interface obtains the past performance of the vault based on its vault address: unitNAV, PnL, Symbol, APR7d, APR30d, StartTime, EndTime, TVL.

  • Request parameters

    {
        "address": "0xdAC17F958D2ee523a2206206994597C13D831ec7"
    }

  • Return value

    Field name	Field description	Remarks
    unitNAV	Net worth of funds
    PnL	Yield value
    APR7d	7-Day yield
    APR30d	30-Day yield
    Symbol	Asset symbol	enzoBTC, finBTC, etc.
    StartTime	Start time	Timestamp
    EndTime	End time	Timestamp
    TVL	Total Value Locked	Currency standard

• /partner/v1/vault/por

  • Function description

    GET request;

    This interface obtains the proof of reserve information corresponding to the vault address.

  • Request parameters

    {
        "address": "0xdAC17F958D2ee523a2206206994597C13D831ec7"
    }

  • Return value

    Field name	Field description	Remarks
    method	Proof of reserve method id	1: Balance snapshot; 2: merkel tree 3: zk-snark 4: Third-party centralized audit ...
    content	Content of proof of reserve certificate	String content or download link

• /partner/v1/InitOrUpdate

  • Function description

    POST request;

    Update a partner's information if the partner's name exists; otherwise, create a new partner and populate necessary information.

    Mostly used for onboarding trading partners, e.g., quantitative trading teams.

  • Request parameters

    Field name	Field description	Remarks
    Name	Name of the partner	Needs to be globally unique
    Style	Style of the partner	Balance, growth, etc.
    Logo	URL of the partner's logo
    AssetClass	Asset class
    Category	Asset catalog