9fin Covenant API

CovenantDataRecord

object

One instrument (entity-per-instrument shape).

instrumentobjectrequired
Show Child Parameters
issuerobjectrequired
Show Child Parameters
dealobjectrequired

Synthesized deal object.

id is a stable hash of the internal deal identity (never the raw
sequential integer); name is synthesized from street name + issue
date + instrument type since there is no human-readable deal-name field
upstream.

Show Child Parameters
termsobjectrequired
Show Child Parameters
ratingsobjectrequired

Instrument ratings at issuance, plus company-level (CFR) ratings.

The *_cfr values are Corporate Family Ratings - a property of the
issuer, not the tranche.

Show Child Parameters
partiesobjectrequired

Counterparties on the instrument.

All three are real firm names and all three are nulled on restricted rows
(scramble_func=set_null in models.py), mirroring the legacy
screener’s behaviour exactly.

Show Child Parameters
financialsobjectrequired
Show Child Parameters
covenantsarray[object]

One covenant datapoint, self-describing.

Carries its own key/category/name inline so no second call to the
reference catalog is needed to interpret a search response. value is
heterogeneous by datapoint (string, number, bool); the required
value_type discriminator disambiguates it, as published in the
OpenAPI spec.

value is required and never null: a covenant entry whose source
datapoint yields no extractable value is dropped by the composition layer
rather than emitted as value: null alongside a value_type.
unit is omitted from the wire (response_model_exclude_none) unless
the value is a number with a unit.

Show Child Parameters
Example