Vaults

Get vault credit lines

Get credit lines for a vault by querying on-chain data from the creditStrategy contract. Authentication is optional but required to view vaults with private organizations. Vaults with public organizations are visible to everyone.

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

Request

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

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

Query parameters

expandstring[]

Comma-separated list of fields to expand. Valid values: "related-addresses" (includes relatedAddresses with facility address on each credit line), "fees" (includes fees with originationFees on each credit line).

Response

Default Response

vaultIdstring uuid required

Vault ID

vaultAddressstring required

Vault contract address

networkIdstring required

CAIP-2 network identifier

Example response

{
  "vaultId": "550e8400-e29b-41d4-a716-446655440000",
  "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "creditLines": [
    {
      "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "deadline": "2025-01-15T10:30:00Z",
      "createdAt": "2025-01-15T10:30:00Z",
      "relatedAddresses": {
        "facility": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "borrower": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "servicing": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      }
    }
  ]
}

Changes

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