Credit Facilities

List credit facilities

List enabled Credit Facilities. Authentication is required. Users see credit facilities for public orgs plus private orgs they have access to.

get/v3/credit-facilities

Request

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

Query parameters

organizationIdstring uuid

Filter by borrower organization ID. Example: 550e8400-e29b-41d4-a716-446655440000

addressstring

Filter by credit facility address. Case-insensitive when networkId is omitted or is an EVM chain (eip155:*), case-sensitive otherwise.

networkIdstring

Filter by network ID (CAIP-2 blockchain ID), e.g., eip155:1 (Ethereum), eip155:137 (Polygon), solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp (Solana)

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.

limitinteger
offsetinteger
expandstring[]

Comma-separated list of fields to expand. Valid values: "related-addresses" (fetches on-chain addresses: spigot, borrower, admin, spigotOperator, escrow, servicing (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[]).

Response

Default Response

Example response

{
  "creditFacilities": [
    {
      "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.