Sign in
Borrowers

List borrowers

List enabled borrower organizations. Authentication is optional but affects results.

get/v3/borrowers

Request

  • Base URL: https://api.creditcoop.xyz
  • URL: https://api.creditcoop.xyz/v3/borrowers
  • 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

Query parameters

limitinteger
offsetinteger
protocolVersionstring[]

Filter by protocol version(s). Comma-separated or repeated (e.g. ?protocolVersion=v1,v2 or ?protocolVersion=v1&protocolVersion=v2). Omit to return all versions.

expandstring[]

Comma-separated list of fields to expand. Valid values: "organization" (includes full organization object with links), "stats" (includes borrower statistics), "apy" (includes weighted APY and facilities count), "status" (includes on-chain cross-default status, one entry per Servicing contract).

Response

Default Response

Example response

{
  "borrowers": [
    {
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "networkIds": [
        "eip155:1"
      ],
      "organization": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      },
      "stats": {
        "totalVolumeUsd": "1234567.890000",
        "activeLoansUsd": "1234567.890000",
        "totalInterestPaidUsd": "1234567.890000",
        "totalBorrowedUsd": "1234567.890000"
      }
    }
  ]
}

Changes

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