Credit Facilities

Get credit facility by ID

Get a single Credit Facility by ID. Authentication is required.

get/v3/credit-facilities/{id}

Request

  • Base URL: https://api.creditcoop.xyz
  • URL: https://api.creditcoop.xyz/v3/credit-facilities/{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)

Path parameters

idstring uuid required

Credit Facility ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

expandstring[]

Comma-separated list of fields to expand. Valid values: "related-addresses" (fetches on-chain addresses: spigot, borrower, admin, spigotOperator, escrow, servicing + commitmentToken (v3 only)), "fees" (fetches fee configuration: originationFee, swapFee + servicingFee (v2 only), drawFee + repayFee (v3 only)), "organization" (includes full organization object with links), "counts" (fetches activeCreditLines and openProposals), "status" (fetches on-chain contract status), "collateral" (fetches on-chain collateral state: maxLtvBps, collateralValue, totalOutstandingDebt, ltvBps, collateralTokens[]), "totals" (v3 only. fetches facility-level native-unit aggregates: totalCommitment, totalDrawn, drawnRate, undrawnRate, token, decimals. Null for v1/v2 facilities.).

Response

Default Response

idstring uuid required

Credit facility unique identifier

addressstring required

SecuredLine contract address

networkIdstring required

CAIP-2 network identifier

protocolVersionstring nullable required

Credit Coop protocol/contract generation ("v1", "v2", or "v3"). Determines which fields apply — several facility and credit-line fields are v3 only. Null when not classified.

labelstring nullable required

Display label for the credit facility. Always present; null if not configured.

organizationIdstring uuid nullable required

Borrower organization ID

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "protocolVersion": "v3",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "organization": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  },
  "relatedAddresses": {
    "spigot": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "borrower": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "admin": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "spigotOperator": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "escrow": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "servicing": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "servicingId": "550e8400-e29b-41d4-a716-446655440000",
    "commitmentToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
  },
  "collateral": {
    "maxLtvBps": "8000",
    "totalOutstandingDebt": "1234.56",
    "collateralValue": "2000",
    "ltvBps": "6666",
    "targetLtvBps": "7500",
    "collateralTokens": [
      {
        "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      }
    ]
  },
  "totals": {
    "creditLimitUsd": "1234567.89",
    "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
  }
}

Changes

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