---
# System prepended metadata

title: '**DashBoard API**'

---

# **DashBoard API**
<hr>
## **Total Data**
>Get token information of dForce ecosystem


**url**
https://app.dforce.network/dashboard/total/info/

**Request Method**
```
GET
```

**Request parameters**
```
none
```
**Return result**
| name   | type        | description      | detail                               |
| ------ | ----------- | ---------------- | ------------------------------------ |
| data   | json object | interface data   |                                      |
| status | string      | interface status | success: "OK"; failed: error message |

**Example**
```
{
    "data": {
        "accumulated_borrow": "38349646999999998056202240",
        "total_asset": "387202749306930471343489024",
        "total_usx": "294039779949814793925296128"
},
    "status": "OK"
}
```

## **DF Token info**
>Get DF token information


**url**
https://app.dforce.network/dashboard/df/info/

**Request Method**
```
GET
```

**Request parameters**
```
none
```
**Return result**
| name   | type        | description      | detail                               |
| ------ | ----------- | ---------------- | ------------------------------------ |
| data   | json object | interface data   |                                      |
| status | string      | interface status | success: "OK"; failed: error message |

**Example**
```
{
    "data": {
        "Multi-chain": {
            "arbitrum": "23111673512794115406823424",
            "bsc": "29917637000000003423338496",
            "mainnet": "876819150174311014798983168"
        },
        "circulating": "417036980687105066401601978",
        "totalSupply": "999930823687105066401601978"
        },
    "status": "OK"
}
```

## **USX Token info**
>Get USX token information


**url**
https://app.dforce.network/dashboard/usx/info/

**Request Method**
```
GET
```

**Request parameters**
```
none
```
**Return result**
| name   | type        | description      | detail                               |
| ------ | ----------- | ---------------- | ------------------------------------ |
| data   | json object | interface data   |                                      |
| status | string      | interface status | success: "OK"; failed: error message |
| multi_chain | json object     | Summary of usx in each chain | |
| pre_chain | json object     | Distribution of usx in each chain | |
| total | json object     | Distribution of usx in all chain | |


**Example**
```json
{
    "data": {
        "multi_chain": { 
        },
        "pre_chain": {
            "ArbitrumOne": {
                "cBridge": "4555449113604458213801984",
                "dForceBridge": "80099999999999994522238976",
                "dex": "875197560196487253590016",
                "lending": "24560646685377092164517888"
            },
            "bsc": {
                "cBridge": "6062493048312620174540800",
                "dForceBridge": "0",
                "dex": "269676725771541577465856",
                "lending": "38467574947329673630056448"
            },
            "mainnet": {
                "cBridge": "4393714770996752898064384",
                "dForceBridge": "0",
                "dex": "0",
                "lending": "26781096842687270961020928"
            }
        },
        "total": {
            "cBridge": "15011656932913832360148992",
            "dForceBridge": "80099999999999994522238976",
            "dex": "1144874285968028864610304",
            "lending": "89809318475394041050562560"
        }
    },
    "status": "OK"
}
```

## **Revenue Token info**
>Get ecosystem revenue information


**url**
https://app.dforce.network/dashboard/revenue/info/

**Request Method**
```
GET
```

**Request parameters**
```
none
```
**Return result**
| name   | type        | description      | detail                               |
| ------ | ----------- | ---------------- | ------------------------------------ |
| data   | json object | interface data   |                                      |
| status | string      | interface status | success: "OK"; failed: error message |
| Total_income_30d | string    | Summary income 30D | |
| Total_revenue_30d | string     | Summary revenue 30D | |
| Total_revenue_6m | list     | each m revenue | |
| Total_income_6m | list     | each m revenue | |


**Example**
```json
{
    "data": {
        "Total_income_30d": "12893523267752843804672",
        "Total_revenue_30d": "22115983053216899137536",
        "Total_income_6m": [
            {
                "1636329600": "25787046535505704386560"
            },
            {
                "1638921600": "25787046535505704386560"
            },
            {
                "1641513600": "25787046535505704386560"
            },
            {
                "1644105600": "25787046535505704386560"
            },
            {
                "1646697600": "25787046535505704386560"
            },
            {
                "1649289600": "12893523267752843804672"
            }
            ],
        "Total_revenue_6m": [
            {
                "1636329600": "44231966106433806663680"
            },
            {
                "1638921600": "44231966106433806663680"
            },
            {
                "1641513600": "44231966106433806663680"
            },
            {
                "1644105600": "44231966106433806663680"
            },
            {
                "1646697600": "44231966106433806663680"
            },
            {
                "1649289600": "22115983053216899137536"
            }
        ]
    },
    "status": "OK"
}
```


## **Poo Data**

>Provide poo related data interface


### **Poo Treasury Data**
>get poo treasury data


**url**
https://app.dforce.network/dashboard/poo/pooTreasury/


**Request Method**
```
GET
```

**Request parameters**

```
none
```

**Return result**
| name   | type        | description      | detail                               |
| ------ | ----------- | ---------------- | ------------------------------------ |
| data   | json object | interface data   |                                      |
| status | string      | interface status | success: "OK"; failed: error message |


**data**
 | name                        | type        | description              | detail                              |
 | --------------------------- | ----------- | ------------------------ | ----------------------------------- |
 | token symbol(token address) | string      | tken amount              |                                     |
 | liquidity                   | json object | token amount information | token (symbol or address) -> amount |
 | markets                     | json object | token amount information | token (symbol or address) -> amount |


**Example**

```
{
  "data": {
    "DF": "6000000000000000000813105",
    "USX": "7491198652746483434212422",
    "liquidity": {
      "DF": "6000000000000000000813105",
      "USX": "491196652746483434212422"
    },
    "markets": {
      "USX": "7000002000000000000000000"
    }
  },
  "status": "OK"
}
```

### **Poo Dex Data**
>get poo dex data


**url**
https://app.dforce.network/dashboard/poo/pooDex/


**Request Method**
```
GET
```

**Request parameters**

```
none
```

**Return result**
| name   | type        | description      | detail                               |
| ------ | ----------- | ---------------- | ------------------------------------ |
| data   | json object | interface data   |                                      |
| status | string      | interface status | success: "OK"; failed: error message |


**data**
 | name        | type        | description                 | detail |
 | ----------- | ----------- | --------------------------- | ------ |
 | mainnet     | json object | info about this network dex |        |
 | ArbitrumOne | json object | info about this network dex |        |
 | bsc         | json object | info about this network dex |        |


**mainnet(bsc,ArbitrumOne)**
| name           | type        | description     | detail |
| -------------- | ----------- | --------------- | ------ |
| MakerDODOV2    | json object | dex policy info |        |
| MakerUniswapV3 | json object | dex policy info |        |


**MakerDODOV2(MakerUniswapV3)**
| name     | type   | description                     | detail |
| -------- | ------ | ------------------------------- | ------ |
| symbol   | string | dex pair symbol                 |        |
| address  | string | dex pair(pool) address          |        |
| amount   | string | dex lpToken(liquidity) amount   |        |
| decimals | int    | dex lpToken(liquidity) decimals |        |
| pair     | array  | dex pair info                   |        |


**`pair[0~n]`**
| name     | type   | description    | detail |
| -------- | ------ | -------------- | ------ |
| symbol   | string | token symbol   |        |
| address  | string | token address  |        |
| amount   | string | token amount   |        |
| decimals | int    | token decimals |        |

**Example**

```
{
  "data": {
    "mainnet": {
      "MakerDODOV2": [
        {
          "address": "0x19E5910F61882Ff6605b576922507F1E1A0302FE",
          "amount": "1489606605095259763222017",
          "decimals": 18,
          "pair": [
            {
              "address": "0xaE6aab43C4f3E0cea4Ab83752C278f8dEbabA689",
              "amount": "2459650893847231462007563",
              "decimals": 18,
              "symbol": "DF"
            },
            {
              "address": "0x641441c631e2F909700d2f41FD87F0aA6A6b4EDb",
              "amount": "166585767707691638853288",
              "decimals": 18,
              "symbol": "USX"
            }
          ],
          "symbol": "DF-USX"
        }
      ],
      "MakerUniswapV3": [
        {
          "address": "0x4DA9f6f328c778fAf9F2807faD6A21E55869B12D",
          "amount": "447452092837040777183584",
          "decimals": 18,
          "pair": [
            {
              "address": "0x641441c631e2F909700d2f41FD87F0aA6A6b4EDb",
              "amount": "16488631449583078404054",
              "decimals": 18,
              "symbol": "USX"
            },
            {
              "address": "0xaE6aab43C4f3E0cea4Ab83752C278f8dEbabA689",
              "amount": "1082878536414749493617553",
              "decimals": 18,
              "symbol": "DF"
            }
          ],
          "symbol": "USX-DF"
        }
      ]
    },
    "bsc": {
      ...
    },
    "ArbitrumOne": {
      ...
    }
  },
  "status": "OK"
}
```

### **Poo Lend Data**
>get poo lending data


**url**
https://app.dforce.network/dashboard/poo/pooLend/


**Request Method**
```
GET
```

**Request parameters**

```
none
```

**Return result**
| name   | type        | description      | detail                               |
| ------ | ----------- | ---------------- | ------------------------------------ |
| data   | json object | interface data   |                                      |
| status | string      | interface status | success: "OK"; failed: error message |


**data**
 | name        | type        | description                     | detail |
 | ----------- | ----------- | ------------------------------- | ------ |
 | mainnet     | json object | info about this network lending |        |
 | ArbitrumOne | json object | info about this network lending |        |
 | bsc         | json object | info about this network lending |        |


**mainnet(bsc,ArbitrumOne)**
| name             | type   | description                  | detail |
| ---------------- | ------ | ---------------------------- | ------ |
| supply_tokens    | array  | poo deposit token info list  |        |
| borrow_tokens    | array  | poo borrowed token info list |        |
| collateral_rate  | string | poo collateral rate          |        |
<!-- | supply_value     | string | poo info                     |        |
| collateral_value | string | poo info                     |        |
| borrow_value     | string | poo info                     |        |
| equity           | string | poo info                     |        |
| shortfall        | string | poo info                     |        |
| sum_borrowed     | string | poo info                     |        |
| sum_collateral   | string | poo info                     |        | -->


**supply_tokens**
| name             | type   | description            | detail |
| ---------------- | ------ | ---------------------- | ------ |
| symbol           | string | token symbol           |        |
| address          | string | iToken address         |        |
| amount           | string | token supply amount    |        |
| decimals         | string | token decimals         |        |
| apy              | string | token supply apy       |        |
| collateralFactor | string | token collateralFactor |        |
| price            | string | token price            |        |


**borrow_tokens**
| name         | type   | description          | detail |
| ------------ | ------ | -------------------- | ------ |
| symbol       | string | token symbol         |        |
| address      | string | iToken address       |        |
| amount       | string | token borrowe amount |        |
| decimals     | string | token decimals       |        |
| apy          | string | token borrow apy     |        |
| cash         | string | iToken cash          |        |
| borrowFactor | string | token borrowFactor   |        |
| price        | string | token price          |        |

**Example**

```
{
  "data": {
    "ArbitrumOne": {
      "borrow_tokens": [
        {
          "address": "0xee338313f022caee84034253174fa562495dcc15",
          "amount": "502438832877181183913",
          "apy": "28081054834543781",
          "borrowFactor": "1000000000000000000",
          "cash": "1025671390106166836421",
          "decimals": "18",
          "price": "2926920000000000000000",
          "symbol": "ETH"
        }
      ],
      "borrow_value": "1470598268724879150818637",
      "collateral_rate": "2312001022752632769",
      "collateral_value": "4000029060411966684287359",
      "equity": "1929426432625292530825617559014884804741104",
      "shortfall": "0",
      "sum_borrowed": "1470598268724879150818637960000000000000000",
      "sum_collateral": "3400024701350171681644255519014884804741104",
      "supply_tokens": [
        {
          "address": "0x0385f851060c09a552f1a28ea3f612660256cbaa",
          "amount": "4000029060411966684287359",
          "apy": "36345445157695",
          "collateralFactor": "850000000000000000",
          "decimals": "18",
          "price": "1000000000000000000",
          "symbol": "USX"
        }
      ],
      "supply_value": "4000029060411966684287359"
    },
    "bsc": {
      ...
    },
    "mainnet": {
      "borrow_tokens": [
        
      ],
      "borrow_value": "0",
      "borrowed_value": "0",
      "collateral_rate": "0",
      "collateral_value": "0",
      "collateral_vaule": "0",
      "equity": "0",
      "shortfall": "0",
      "supply_tokens": [
        
      ],
      "supply_value": "0"
    }
  },
  "status": "OK"
}
```



