Credit Facilities

Credit facility management

List credit facilities

get

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

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Query parameters

organizationIdstring · uuid · max: 36Optional

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

addressstring · max: 100Optional

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

networkIdstring · max: 50Optional

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

limitinteger · min: 1 · max: 100OptionalDefault: 20

offsetintegerOptionalDefault: 0

Responses

200

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

get/v3/credit-facilities

HTTPcURLJavaScriptPython

GET /v3/credit-facilities HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "creditFacilities": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:1",
      "protocolVersion": "v2",
      "label": "text",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "organization": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "text",
        "slug": "text",
        "header": "text",
        "description": "text",
        "overview": "text",
        "links": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "label": "text",
            "linkText": "text",
            "iconUrl": "text",
            "url": "text"
          }
        ]
      },
      "relatedAddresses": {
        "spigot": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "borrower": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "admin": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "spigotOperator": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "escrow": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "servicing": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "servicingId": "550e8400-e29b-41d4-a716-446655440000"
      },
      "fees": {
        "originationFee": "text",
        "swapFee": "text",
        "servicingFee": "text",
        "drawFee": "text",
        "repayFee": "text"
      },
      "counts": {
        "activeCreditLines": 1,
        "openProposals": 1
      },
      "status": {
        "code": 1,
        "label": "UNINITIALIZED",
        "facilityClosed": true
      },
      "collateral": {
        "maxLtvBps": "8000",
        "totalOutstandingDebt": "1234.56",
        "collateralValue": "2000",
        "ltvBps": "6666",
        "targetLtvBps": "7500",
        "collateralTokens": [
          {
            "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
            "amount": "text",
            "decimals": 1,
            "usdValue": "text"
          }
        ]
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

Get credit facility by ID

get

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

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Path parameters

idstring · uuidRequired

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

Query parameters

Responses

200

Default Response

application/json

idstring · uuidRequired

Credit facility unique identifier

Example: 550e8400-e29b-41d4-a716-446655440000

addressstringRequired

SecuredLine contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequired

CAIP-2 network identifier

Example: eip155:1

protocolVersionstring · nullableRequired

Credit Coop protocol/contract generation (e.g. "v1", "v2"). Null when not classified.

Example: v2

labelstring · nullableRequired

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

organizationIdstring · uuid · nullableRequired

Borrower organization ID

Example: 550e8400-e29b-41d4-a716-446655440000

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

get/v3/credit-facilities/{id}

HTTPcURLJavaScriptPython

GET /v3/credit-facilities/{id} HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "protocolVersion": "v2",
  "label": "text",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "organization": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "text",
    "slug": "text",
    "header": "text",
    "description": "text",
    "overview": "text",
    "links": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "linkText": "text",
        "iconUrl": "text",
        "url": "text"
      }
    ]
  },
  "relatedAddresses": {
    "spigot": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "borrower": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "admin": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "spigotOperator": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "escrow": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "servicing": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "servicingId": "550e8400-e29b-41d4-a716-446655440000"
  },
  "fees": {
    "originationFee": "text",
    "swapFee": "text",
    "servicingFee": "text",
    "drawFee": "text",
    "repayFee": "text"
  },
  "counts": {
    "activeCreditLines": 1,
    "openProposals": 1
  },
  "status": {
    "code": 1,
    "label": "UNINITIALIZED",
    "facilityClosed": true
  },
  "collateral": {
    "maxLtvBps": "8000",
    "totalOutstandingDebt": "1234.56",
    "collateralValue": "2000",
    "ltvBps": "6666",
    "targetLtvBps": "7500",
    "collateralTokens": [
      {
        "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "amount": "text",
        "decimals": 1,
        "usdValue": "text"
      }
    ]
  }
}

Get credit facility credit lines

get

Get credit lines for a Credit Facility. Authentication is required.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Path parameters

idstring · uuidRequired

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

Query parameters

Responses

200

Default Response

application/json

facilityIdstringRequired

Credit Facility UUID

Example: 550e8400-e29b-41d4-a716-446655440000

facilityAddressstringRequired

Credit facility contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequired

CAIP-2 network identifier (e.g. eip155:8453)

Example: eip155:1

activeCountintegerRequired

Number of active credit lines

totalCountintegerRequired

Total number of credit lines

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

get/v3/credit-facilities/{id}/credit-lines

HTTPcURLJavaScriptPython

GET /v3/credit-facilities/{id}/credit-lines HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "facilityId": "550e8400-e29b-41d4-a716-446655440000",
  "facilityAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "activeCount": 1,
  "totalCount": 1,
  "fees": {
    "originationFee": "text",
    "swapFee": "text",
    "servicingFee": "text",
    "drawFee": "text",
    "repayFee": "text"
  },
  "creditLines": [
    {
      "lineTokenId": "text",
      "deposit": "text",
      "creditLimit": "text",
      "principal": "text",
      "interestBalance": "text",
      "interestAccrued": "text",
      "interestRepaid": "text",
      "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "decimals": 1,
      "isOpen": true,
      "isRestricted": true,
      "earlyWithdrawalFee": "text",
      "deadline": "2025-01-15T10:30:00Z",
      "drawRate": "text",
      "facilityRate": "text",
      "apyPct": 1,
      "createdTxHash": "text",
      "createdBlockNumber": 1,
      "createdAt": "2025-01-15T10:30:00Z",
      "commitmentValue": "text",
      "claimable": "text",
      "facilityType": "text",
      "isDefaulted": true,
      "fees": {
        "originationFees": "text"
      },
      "error": "text",
      "relatedAddresses": {
        "lender": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "vault": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "vaultCurator": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      }
    }
  ],
  "totals": {
    "depositUsd": "text",
    "principalUsd": "text",
    "interestAccruedUsd": "text",
    "interestRepaidUsd": "text",
    "interestBalanceUsd": "text",
    "creditLimitUsd": "text",
    "apyPct": 1
  }
}

Get credit facility proposals

get

Get mutual consent proposals for a Credit Facility. Authentication is required.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Path parameters

idstring · uuidRequired

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

Responses

200

Default Response

application/json

facilityIdstringRequired

Credit Facility UUID

Example: 550e8400-e29b-41d4-a716-446655440000

facilityAddressstringRequired

Credit facility contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequired

CAIP-2 network identifier (e.g. eip155:8453)

Example: eip155:1

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

get/v3/credit-facilities/{id}/proposals

HTTPcURLJavaScriptPython

GET /v3/credit-facilities/{id}/proposals HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "facilityId": "550e8400-e29b-41d4-a716-446655440000",
  "facilityAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "open": [
    {
      "proposalId": "text",
      "taker": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "nonce": "text",
      "msgData": "text",
      "proposalType": "new_credit",
      "parameters": {
        "lender": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "vaultCurator": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "vault": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "amount": "text",
        "drawRate": "text",
        "facilityRate": "text",
        "deadline": "2025-01-15T10:30:00Z",
        "isRestricted": true,
        "earlyWithdrawalFee": "text",
        "lineTokenId": "text",
        "desiredNonce": "text"
      },
      "status": "pending",
      "registeredAt": "2025-01-15T10:30:00Z",
      "registeredTxHash": "text",
      "registeredBlockNumber": 1
    }
  ],
  "closed": [
    {
      "proposalId": "text",
      "taker": "text",
      "nonce": "text",
      "msgData": "text",
      "proposalType": "new_credit",
      "parameters": {
        "lender": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "vaultCurator": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "vault": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "amount": "text",
        "drawRate": "text",
        "facilityRate": "text",
        "deadline": "2025-01-15T10:30:00Z",
        "isRestricted": true,
        "earlyWithdrawalFee": "text",
        "lineTokenId": "text",
        "desiredNonce": "text"
      },
      "status": "accepted",
      "registeredAt": "2025-01-15T10:30:00Z",
      "registeredTxHash": "text",
      "registeredBlockNumber": 1,
      "closedAt": "2025-01-15T10:30:00Z",
      "closedTxHash": "text",
      "closedBlockNumber": 1
    }
  ],
  "revokedAllEvents": [
    {
      "newNonce": "text",
      "timestamp": "2025-01-15T10:30:00Z",
      "txHash": "text",
      "blockNumber": 1
    }
  ]
}