Platform

Get platform statistics

Get all platform statistics in a single response. No authentication required, but authenticated requests may receive increased rate limits.

get/v3/platform/stats

Request

  • Base URL: https://api.creditcoop.xyz
  • URL: https://api.creditcoop.xyz/v3/platform/stats
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://clerk.creditcoop.xyz/oauth/authorize, token URL https://clerk.creditcoop.xyz/oauth/token)
    • none

Response

Default Response

totalVolumeUsdstring required

Total volume in USD (borrows + repayments). Returned as a string to avoid floating-point precision loss.

activeLoansUsdstring required

Current outstanding principal in USD. Returned as a string to avoid floating-point precision loss.

totalInterestPaidUsdstring required

Total interest paid in USD. Returned as a string to avoid floating-point precision loss.

totalBorrowedUsdstring required

Cumulative total borrowed in USD (all time). Returned as a string to avoid floating-point precision loss.

borrowCountinteger required

Total number of borrow entries across all organizations.

repayCountinteger required

Total number of repay entries across all organizations (principal + interest).

repayPrincipalCountinteger required

Number of principal repay entries across all organizations.

repayInterestCountinteger required

Number of interest repay entries across all organizations.

valuationIncompleteboolean required

True when one or more outstanding balances could not be valued in USD and were counted as zero, so activeLoansUsd is off by an unknown amount in an unknown direction — a balance is a net, so an omitted one may have been negative. Read it as a partial valuation, not as a bound. False means every outstanding balance was valued. Only activeLoansUsd is affected; the historical totals are unaffected.

Example response

{
  "totalVolumeUsd": "1234567.890000",
  "activeLoansUsd": "500000.000000",
  "totalInterestPaidUsd": "45678.900000",
  "totalBorrowedUsd": "2000000.000000",
  "borrowCount": 128,
  "repayCount": 342,
  "repayPrincipalCount": 210,
  "repayInterestCount": 132
}

Changes

No recorded changes to this operation across all 1 revision of this API.