package API.Presidio

Get desktop application:
View/edit binary Protocol Buffers messages

* The Account API retrieves information for various accounts which have interacted with Compound. You can use this API to pull data about a specific account by address, or alternatively, pull data for a list of unhealthy accounts (that is, accounts which are approaching under-collateralization). <code>// Retreives list of accounts and related supply and borrow balances. fetch("API_BASE_URL/api/v2/account"); // Returns details for given account fetch("API_BASE_URL/api/v2/account?addresses[]=0x00..");</code>

• rpc account (AccountRequest, AccountResponse)

  account.proto:172

• rpc post_account (AccountRequest, AccountResponse)

  account.proto:176

* <p><i>Note: This service is experimental (alpha) and subject to change.</i></p> The CToken API retrieves information for all cTokens. You can use this API to pull data about all cTokens: <code>// Retreives list all cTokens fetch("API_BASE_URL/api/v2/ctoken"); // or return details for a single cToken fetch("API_BASE_URL/api/v2/ctoken?addresses[]=0x00..");</code>

• rpc ctoken (CTokenRequest, CTokenResponse)

  ctoken.proto:151

• rpc post_ctoken (CTokenRequest, CTokenResponse)

  ctoken.proto:155

* Custom data types that are shared between services.

(no methods)

* This includes a list of cTokens contextualized to each account. <code>{ "address": "0xbac065be2e8ca097e9ac924e94af000dd3a5663" "health": { "value": "1.07264275673050348990755599431194797431802239523113293682619605751591901" } "tokens": [ { "address": "0xf5dce57282a584d2746faf1593d3121fcac444dc" "borrow_balance_underlying": {"value": "131.4682716123015"} "lifetime_borrow_interest_accrued": {"value": "0.44430505829286"} "lifetime_supply_interest_accrued": {"value": "0.0000021671829864899976"} "supply_balance_underlying": {"value": "0.0"} } ], "total_borrow_value_in_eth": {"value": "0.5100157047140227313856015174794473200000000000000000000000000000" } "total_collateral_value_in_eth": {"value": "0.54706465148029978664135447293587201124121731200000000000000000000000000" } }</code>

Used in: AccountResponse

• bytes address = 1

  The public Ethereum address of the account

• optional Precise total_collateral_value_in_eth = 2

  The value of all collateral supplied by the account. Calculated as <em>cTokens held • exchange rate • collateral factor</em>. Note: assets can be supplied and gain interest without being counted as collateral.

• optional Precise total_borrow_value_in_eth = 3

  The value of all outstanding borrows with accumulated interest.

• optional Precise health = 5

  <pre>total_collateral_value_in_eth / total_borrow_value_in_eth</pre>. If this value is less than 1.0, the account is subject to liquidation.

• int32 block_updated = 6

  doc-false

• repeated AccountCToken tokens = 7

  A list of tokens held by this account, see <ref>AccountCToken</ref> below for details.

* An account's supply, borrow, and interest information for a particular cToken. <code>{ "address": "0xf5dce57282a584d2746faf1593d3121fcac444dc" "borrow_balance_underlying": {"value": "131.4682716123015"} "lifetime_borrow_interest_accrued": {"value": "0.44430505829286"} "lifetime_supply_interest_accrued": {"value": "0.0000021671829864899976"} "supply_balance_underlying": {"value": "0.0"} }</code>

Used in: Account

• bytes address = 1

  The address of the cToken

• string symbol = 2

  The symbol of the cToken

• optional Precise supply_balance_underlying = 3

  The cToken balance converted to underlying tokens <pre>cTokens held • exchange rate</pre>

• optional Precise borrow_balance_underlying = 4

  The borrow balance (this is denominated in the underlying token, not in cTokens)

• optional Precise lifetime_supply_interest_accrued = 5

  The amount of supply interest accrued for the lifetime of this account-cToken pair.

• optional Precise lifetime_borrow_interest_accrued = 6

  The amount of borrow interest accrued for the lifetime of this account-cToken pair.

* The request to the account API can specify a number filters, such as which addresses to retrieve information about or general health requirements. The following shows an example set of request parameters in JSON: <code>{ "addresses": [] // returns all accounts if empty or not included "block_number": 0 // returns latest if given 0 "max_health": { "value": "10.0" } "min_borrow_value_in_eth": { "value": "0.002" } "page_number": 1 "page_size": 10 }</code>

Used as request type in: AccountService.account, AccountService.post_account

Used as field type in: AccountResponse

• repeated bytes addresses = 1

  List of account addresses to filter on, e.g.: ["0x...", ,"0x..."] [Optional]

• optional Precise min_borrow_value_in_eth = 2

  Filter for accounts which total outstanding borrows exceeding given amount. [Optional]

• optional Precise max_health = 3

  Filter for accounts where outstanding borrows divided by collateral value is less than the provided amount. If returned value is less than 1.0, for instance, the account is subject to liquidation. If provided, should be given as `{ "value": "...string formatted number..." }` [Optional]

• uint32 block_number = 4

  If provided, API returns data for given block number from our historical data. Otherwise, API defaults to returning the latest information. [Optional]

• uint32 block_timestamp = 5

  If provided, API returns data for given timestamp from our historical data. Otherwise, API defaults to returning the latest information. [Optional]

• uint32 page_size = 6

  Number of accounts to include in the response, default is 10 e.g. page_size=10 [Optional]

• uint32 page_number = 7

  Pagination number for accounts in the response, default is 1 e.g. page_number=1 [Optional]

The account API returns an overall picture of accounts matching the filters on Compound.

Used as response type in: AccountService.account, AccountService.post_account

• optional Error error = 1

  If set and non-zero, indicates an error returning data. <pre>NO_ERROR = 0 INTERNAL_ERROR = 1 INVALID_PAGE_NUMBER = 2 INVALID_PAGE_SIZE = 3</pre>

• optional AccountRequest request = 2

  The request parameters are echoed in the response.

• optional PaginationSummary pagination_summary = 3

  For example <pre>{ "page_number": 1, "page_size": 100, "total_entries": 83, "total_pages": 1, }</pre>

• float close_factor = 4

  The portion of an outstanding borrow that can be closed in a liquidation, which is a percentage of the total underlying borrow balance. For example if the close factor is 0.1, then an account in liqudation is liable to have 10% of its borrows liquidated.

• float liquidation_incentive = 5

  The amount of extra collateral that will be seized to incentivize liquidation. For example, an incentive of 1.05 implies that a liquidator will receive a 5% bonus on the exchange of collateral during a liquidation

• repeated Account accounts = 6

  The list of accounts (see <ref>Account</ref> below) matching the requested filter, with the associated account and cToken data.

• NO_ERROR = 0

• INTERNAL_ERROR = 1

• INVALID_PAGE_NUMBER = 2

• INVALID_PAGE_SIZE = 3

doc-false

• bytes value = 1

* This includes a list of cTokens contextualized to the full market. <code>{ "cToken": [{ "borrow_rate": {"value": "0.051453109785093843"}, "cash": {"value": "514.078443"}, "collateral_factor": {"value": "0.80000000000000000"}, "exchange_rate": {"value": "0.020024242770802729"}, "interest_rate_model_address": "0x1a43bfd39b15dcf444e17ab408c4b5be32deb7f5", "name": "Compound USD Coin", "number_of_borrowers": 3, "number_of_suppliers": 34, "reserves": {"value": "0"}, "supply_rate": {"value": "0.013237112532748109"}, "symbol": "cUSDC", "token_address": "0x5b281a6dda0b271e91ae35de655ad301c976edb1", "total_borrows": {"value": "178.064546"}, "total_supply": {"value": "34565.25157651"}, "underlying_address": "0x4dbcdf9b62e891a7cec5a2568c3f4faf9e8abe2b", "underlying_name": "USD Coin", "underlying_price": {"value": "0.0041368287055953530000000000"}, "underlying_symbol":"USDC" }], "error": null, "request": { "addresses": ["0x5b281a6dda0b271e91ae35de655ad301c976edb1"], "block_number": 4515576, "block_timestamp": 0 } }</code>

Used in: CTokenResponse

• bytes token_address = 1

  The public Ethereum address of the cToken

• optional Precise total_supply = 2

  The number of cTokens in existence

• optional Precise total_borrows = 4

  The amount of underlying tokens borrowed from the cToken

• optional Precise reserves = 5

  The amount of underylying tokens held by reserves

• optional Precise cash = 6

  The current liquidity of the cToken

• optional Precise exchange_rate = 7

  The cToken / underlying exchange rate. This rate increases over time as supply interest accrues.

• optional Precise supply_rate = 8

  The floating supply interest rate

• optional Precise borrow_rate = 9

  The floating borrow interest rate

• optional Precise collateral_factor = 10

  The amount of the value of the underlying token that will count as collateral. eg. cEth with collataral factor 0.75 means 1 eth of supply allows 0.75 eth of borrowing.

• uint32 number_of_suppliers = 11

  The number of accounts holding this cToken

• uint32 number_of_borrowers = 12

  The number of accounts with oustanding borrows

• optional Precise underlying_price = 13

  The price of the underlying token in eth

• bytes underlying_address = 14

  The address of the underlying token

• string symbol = 15

  The symbol of the ctoken

• string name = 17

  The name of the ctoken

• string underlying_symbol = 18

  The symbol of the underlying token

• string underlying_name = 19

  The name of the underlying token

• bytes interest_rate_model_address = 20

  The address of the interest rate model

* The request to the cToken API can specify a number filters, such as which tokens to retrieve information about or moment in time. The following shows an example set of request parameters in JSON: <code>{ "addresses": [] // returns all tokens if empty or not included "block_timestamp": 0 // returns latest information if given 0 }</code>

Used as request type in: CTokenService.ctoken, CTokenService.post_ctoken

Used as field type in: CTokenResponse

• repeated bytes addresses = 1

  List of token addresses to filter on, e.g.: ["0x...", ,"0x..."] [Optional]

• uint32 block_number = 2

  Only one of block_number or block timestamp should be provided. If provided, API returns data for given block number from our historical data. Otherwise, API defaults to returning the latest information. [Optional]

• uint32 block_timestamp = 3

  Only one of block_number or block timestamp should be provided. If provided, API returns data for given block timestamp from our historical data. Otherwise, API defaults to returning the latest information. [Optional]

The cToken API returns an overall picture of cTokens matching the filter.

Used as response type in: CTokenService.ctoken, CTokenService.post_ctoken

• optional Error error = 1

  If set and non-zero, indicates an error returning data. <pre>NO_ERROR = 0 INTERNAL_ERROR = 1

• optional CTokenRequest request = 2

  The request parameters are echoed in the response.

• repeated CToken cToken = 3

  The list of cToken (see <ref>CToken</ref> below) matching the requested filter.

• NO_ERROR = 0

• INTERNAL_ERROR = 1

doc-false

• string symbol = 1

• optional Precise amount = 2

doc-false

Used in: AccountResponse, CTokenResponse

• uint32 error_code = 1

• string message = 2

• map<string, string> field_errors = 3

Used for paginating results.

Used in: AccountResponse

• uint32 page_number = 1

  The current page number

• uint32 page_size = 2

  The number of entries to show per page.

• uint32 total_entries = 3

  The number of items matching the request across all pages.

• uint32 total_pages = 4

  The number of pages need to show total_entries at the given page_size.

For non-negative numbers only.

Used in: Account, AccountCToken, AccountRequest, CToken, CurrencyAmount

• string value = 1

  The full UNSIGNED number in string form. max value is 2^257 - 1, aka 231584178474632390847141970017375815706539969331281128078915168015826259279871

doc-false

• string value = 1

  The full SIGNED number in string form.