Borrowers

Get borrower by ID

Get a single borrower organization by ID. Authentication is optional but required to view private borrowers.

get/v3/borrowers/{id}

Request

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

Path parameters

idstring uuid required

Borrower organization ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

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

organizationIdstring uuid required

Borrower organization ID

namestring required

Organization name

networkIdsstring[] required

CAIP-2 network identifiers for blockchain networks this borrower has credit facilities on

Example response

{
  "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.