Credit documents and covenants

One credit facility or covenant, with legal terms and dated evidence.

One row is

One credit facility or covenant, with legal terms and dated evidence

Example response

Trimmed real output. No key needed.

GET /v1/datasets/credit-documents/sample

Dates reflect the example, not current coverage.

{
  "data": {
    "rows": [],
    "access": "full",
    "lockedRows": 0,
    "asOf": "2026-10-08T12:00:00.000Z",
    "truncated": false
  },
  "meta": {
    "dataset": "credit-documents",
    "asOf": null,
    "source": [
      {
        "id": "sec-edgar",
        "attribution": "U.S. Securities and Exchange Commission and the filing issuer",
        "licence": "Public SEC filings; preserve filing attribution and fair-access limits"
      },
      {
        "id": "credit-global",
        "attribution": "Public company filings",
        "licence": "Use subject to Gloom Datasets terms"
      }
    ],
    "historyStarts": null,
    "coverage": {
      "rows": 0,
      "truncated": false
    },
    "lastUpdated": null
  }
}

Routes

Base URL https://api.gloom.sh. Send a key with each call; the key's account needs a plan.

GET /v1/credit/screen8 credits

Credit headroom and springing covenant screen. Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.

Parameter: headroomBelow
In: query
Type: number

Parameter: springingWithinMonths
In: query
Type: integer 1 to 120

Parameter: limit
In: query
Type: integer 1 to 500

Parameter	In	Type
`headroomBelow`	query	number
`springingWithinMonths`	query	integer 1 to 120
`limit`	query	integer 1 to 500

Credits: 8 (search x4)
Plans: Basic, Desk, Enterprise

GET /v1/credit/{symbol}8 credits

Credit facilities, covenants and maturities. Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.

Parameter: symbol
In: path, required
Type: string ^[A-Za-z0-9.:-]{1,32}$
Notes: Company symbol; normalized to uppercase.

Parameter	In	Type	Notes
`symbol`	path, required	string `^[A-Za-z0-9.:-]{1,32}$`	Company symbol; normalized to uppercase.

Credits: 8 (history x4)
Plans: Basic, Desk, Enterprise

GET /v1/credit/{symbol}/instruments/{id}20 credits

Credit instrument evidence. Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.

Parameter: symbol
In: path, required
Type: string ^[A-Za-z0-9.:-]{1,32}$
Notes: Company symbol; normalized to uppercase.

Parameter: id
In: path, required
Type: string ^[0-9a-fA-F-]{36}$

Parameter	In	Type	Notes
`symbol`	path, required	string `^[A-Za-z0-9.:-]{1,32}$`	Company symbol; normalized to uppercase.
`id`	path, required	string `^[0-9a-fA-F-]{36}$`

Credits: 20 (evidence x4)
Plans: Basic, Desk, Enterprise

Meta fields

Field: dataset
Here: The dataset id
In the example: "credit-documents"

Field: asOf
Here: The observation date established by the service; otherwise null
In the example: null

Field: source
Here: Attribution and usage terms of each source
In the example: 2 sources

Field: historyStarts
Here: Earliest stored history when established by the service; otherwise null.
In the example: null, not stated yet

Field: coverage
Here: Service-established coverage; null when unavailable.
In the example: {"rows":0,"truncated":false}

Field: lastUpdated
Here: The source update time established by the service; otherwise null
In the example: null

Field	Here	In the example
`dataset`	The dataset id	`"credit-documents"`
`asOf`	The observation date established by the service; otherwise null	null
`source`	Attribution and usage terms of each source	2 sources
`historyStarts`	Earliest stored history when established by the service; otherwise null.	null, not stated yet
`coverage`	Service-established coverage; null when unavailable.	`{"rows":0,"truncated":false}`
`lastUpdated`	The source update time established by the service; otherwise null	null

Sources

Source: U.S. Securities and Exchange Commission and the filing issuer
Usage terms: Public SEC filings; preserve filing attribution and fair-access limits

Source: Public company filings
Usage terms: Use subject to Gloom Datasets terms

Source	Usage terms
U.S. Securities and Exchange Commission and the filing issuer	Public SEC filings; preserve filing attribution and fair-access limits
Public company filings	Use subject to Gloom Datasets terms

Errors

These routes can answer 400, 401, 402, 403, 404, 429, 503. See Errors for the codes.

Gloom Datasets reads stored data only: a call never starts a collection.