# Revenue API for Lending

---
## Descriptions
Below is the revenue API of dForce lending protocol, you can request by one day or a period of days, the returns are organized by each iToken(interest bearing token in dForce Lending) in each date with five major values (TotalValueLocked is optional for usage).

## Request URL
* https://api.dforce.network/api/revenue
* ### parameters description

| name |required| example | description |
| ------- | - | --------| ------ |
| from | No, Yes when `to` used | 20210811|From date, unsigned, default is the latest day(i.e. yesterday), estimate by block time|
| to | No | 20210811|End date, unsigned, default is the latest day(i.e. yesterday), estimate by block time|
| network | No | mainnet, bsc, arbitrunm |Network，default for Ethereum Mainnet|

Example:
[https://api.dforce.network/api/revenue?from=20210810&to=20211001&network=bsc](https://api.dforce.network/api/revenue/?from=20210810&to=20211001&network=bsc)

---
* ### returns description

| name |format | description |
| ------- | -------- | ------ |
| ActiveDeposits | json object | total value deposited(borrowers&lenders) |
| BorrowVolume | json object | total value of funds borrowed |
| Revenue | json object | total interest paid |
| ProtocolRevenue | json object | revenue that goes to the protocol |
| TotalValueLocked| json object | total value locked in the protocal |

Example:

{
    "ActiveDeposits": {
        "0x0BF8C72d618B5d46b055165e21d661400008fa0F": {
            "symbol": "iUSDT",
            "value": [
                {
                    "Amount": 156587.0424095598, //total in amount
                    "Date": "2021-08-10", //the day
                    "TimeStamp": 1628553600, //start timestamp of the day
                    "USDValue": 156636.36732791882 //total value in dollar
                }
            ]
        }
    },
    "BorrowVolume": {
        "0x0BF8C72d618B5d46b055165e21d661400008fa0F": {
            "symbol": "iUSDT",
            "value": [
                {
                    "Amount": 1516395.3177305937,
                    "Date": "2021-08-10",
                    "TimeStamp": 1628553600,
                    "USDValue": 1516872.9822556789
                }
            ]
        }
    },
    "Revenue": {
        "0x0BF8C72d618B5d46b055165e21d661400008fa0F": {
            "symbol": "iUSDT",
            "value": [
                {
                    "Amount": 1031.3944760348645,
                    "Date": "2021-08-10",
                    "TimeStamp": 1628553600,
                    "USDValue": 1031.7193652948156
                },
            ]
        }
    },
    "ProtocolRevenue": {
        "0x0BF8C72d618B5d46b055165e21d661400008fa0F": {
            "symbol": "iUSDT",
            "value": [
                {
                    "Amount": 103.13944760348646,
                    "Date": "2021-08-10",
                    "TimeStamp": 1628553600,
                    "USDValue": 103.17193652948157
                },
            ]
        }
    },
    "TotalValueLocked"： {
        "0x0BF8C72d618B5d46b055165e21d661400008fa0F": {
            "symbol": "iUSDT",
            "value": [
                {
                    "Amount": 1344676.996653462,
                    "Date": "2021-08-10",
                    "TimeStamp": 1628553600,
                    "USDValue": 1345100.569907408
                },
            ]
        }
    }
}