--- title: "Covenant Data API" url: "https://console.9fin.com/apis/covenants-service/versions/d54352ff-53e9-48ef-9f3e-d1bf83d9fca7" --- # Covenant Data API OpenAPI specification document. ```json {"openapi":"3.1.0","info":{"title":"Covenant Data API","version":"0.7.0"},"servers":[{"url":"https://api.9fin.com"}],"paths":{"/v0/covenants/data":{"get":{"tags":["Covenant Data"],"summary":"List Covenant Data","description":"List anonymised covenant data with basic query-param filtering.\n\nThe response is entity-per-instrument with cursor pagination. Only the\nquery parameters declared for this endpoint are accepted; any other\nfilter-looking query parameter is rejected with a ``VALIDATION_ERROR``\nresponse naming the offending field.\n\nWorked examples:\n\n1. Plain (no filters, first page)::\n\n GET /v0/covenants/data\n\n2. Filtered (one fixed-field predicate)::\n\n GET /v0/covenants/data?instrument.type__eq=Bond\n\n3. Filtered + sorted (comma-separated ``__in``, multi-key ``sort_by``)::\n\n GET /v0/covenants/data?instrument.region__in=Europe,US\n &financials.net_senior_leverage__gte=4.0\n &sort_by=terms.issue_date__desc\n\n4. Page 2 with a cursor (``next_cursor`` from the prior page's\n response, replayed verbatim — the cursor is bound to those exact\n filters and sort; reusing it with different filters is rejected)::\n\n GET /v0/covenants/data?instrument.region__in=Europe,US\n &financials.net_senior_leverage__gte=4.0\n &sort_by=terms.issue_date__desc\n &cursor=\n\n5. ``__all`` (AND, not OR - every listed value must be present)::\n\n GET /v0/covenants/data?issuer.sponsor__all=Apollo,Blackstone\n\n6. Ratings and company (CFR) ratings - set membership, exactly as the\n 9fin screener does it. There is no \"BB- or better\" ordering::\n\n GET /v0/covenants/data?ratings.moodys__in=B1,B2,B3\n GET /v0/covenants/data?ratings.s_and_p_cfr__eq=B\n\n7. Size and EBITDA. These are range-valued: on anonymised rows the figure\n is reported as a bucket, and the filter matches when that bucket\n OVERLAPS the bound. A match therefore means \"this deal's reported\n range permits the value\", not \"the exact figure clears it\". Only\n ``__gte``/``__lte`` are accepted - exact and strict comparison against\n a bucket has no honest meaning::\n\n GET /v0/covenants/data?financials.ebitda__gte=100&terms.amount__lte=500\n\n8. Counterparties and booleans::\n\n GET /v0/covenants/data?parties.bookrunner__contains=Goldman\n GET /v0/covenants/data?issuer.sponsored__eq=true\n\nThe complete list of filterable fields, their permitted operators and\ntheir value types is served by the filter catalog, and every field in it\nis accepted here. Fields whose values are anonymised on restricted deals\n(counterparty names, sponsor name, industry L2/L3, purpose, country of\nissuer) are absent from those rows and so never match a filter on them.","operationId":"list_covenant_data_v0_covenants_data_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated sort keys, e.g. 'terms.issue_date__desc,financials.net_senior_leverage__asc'.","title":"Sort By"},"description":"Comma-separated sort keys, e.g. 'terms.issue_date__desc,financials.net_senior_leverage__asc'."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":48,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Opaque pagination cursor from a prior page's next_cursor; omit on the first page.","title":"Cursor"},"description":"Opaque pagination cursor from a prior page's next_cursor; omit on the first page."},{"name":"instrument.type__eq","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["Bond"],"title":"Instrument.Type Eq"}},{"name":"instrument.region__in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated, e.g. 'Europe,US'.","title":"Instrument.Region In"},"description":"Comma-separated, e.g. 'Europe,US'."},{"name":"instrument.currency__eq","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"examples":["EUR"],"title":"Instrument.Currency Eq"}},{"name":"terms.issue_date__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Terms.Issue Date Gte"}},{"name":"terms.issue_date__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Terms.Issue Date Lte"}},{"name":"terms.maturity__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Terms.Maturity Gte"}},{"name":"terms.maturity__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Terms.Maturity Lte"}},{"name":"financials.net_senior_leverage__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Financials.Net Senior Leverage Gte"}},{"name":"financials.net_senior_leverage__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Financials.Net Senior Leverage Lte"}},{"name":"financials.net_total_leverage__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Financials.Net Total Leverage Gte"}},{"name":"financials.net_total_leverage__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Financials.Net Total Leverage Lte"}},{"name":"issuer.sponsor__all","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated; matches only rows co-sponsored by ALL listed names (e.g. 'Apollo,Blackstone' excludes a deal sponsored by only one of them). Reference implementation of a proposed (not yet approved) 9th filter operator - see the worked example below.","title":"Issuer.Sponsor All"},"description":"Comma-separated; matches only rows co-sponsored by ALL listed names (e.g. 'Apollo,Blackstone' excludes a deal sponsored by only one of them). Reference implementation of a proposed (not yet approved) 9th filter operator - see the worked example below."},{"name":"deal.id__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: deal.id equals."},{"name":"deal.id__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: deal.id matches any of (comma-separated)."},{"name":"financials.ebitda__gte","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: financials.ebitda greater than or equal to."},{"name":"financials.ebitda__lte","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: financials.ebitda less than or equal to."},{"name":"financials.net_senior_leverage__eq","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: financials.net_senior_leverage equals."},{"name":"financials.net_senior_leverage__gt","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: financials.net_senior_leverage greater than."},{"name":"financials.net_senior_leverage__lt","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: financials.net_senior_leverage less than."},{"name":"financials.net_total_leverage__eq","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: financials.net_total_leverage equals."},{"name":"financials.net_total_leverage__gt","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: financials.net_total_leverage greater than."},{"name":"financials.net_total_leverage__lt","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: financials.net_total_leverage less than."},{"name":"instrument.category__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.category equals."},{"name":"instrument.category__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.category matches any of (comma-separated)."},{"name":"instrument.category__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.category does not equal."},{"name":"instrument.country_of_issuer__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.country_of_issuer equals."},{"name":"instrument.country_of_issuer__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.country_of_issuer matches any of (comma-separated)."},{"name":"instrument.country_of_issuer__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.country_of_issuer does not equal."},{"name":"instrument.country_of_risk__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.country_of_risk equals."},{"name":"instrument.country_of_risk__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.country_of_risk matches any of (comma-separated)."},{"name":"instrument.country_of_risk__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.country_of_risk does not equal."},{"name":"instrument.currency__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.currency matches any of (comma-separated)."},{"name":"instrument.currency__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.currency does not equal."},{"name":"instrument.is_sustainability_linked__eq","in":"query","required":false,"schema":{"type":"boolean"},"description":"Filter: instrument.is_sustainability_linked equals."},{"name":"instrument.purpose__all","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.purpose matches all of (comma-separated; AND, not OR)."},{"name":"instrument.purpose__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.purpose equals."},{"name":"instrument.purpose__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: instrument.purpose matches any of (comma-separated)."},{"name":"instrument.region__eq","in":"query","required":false,"schema":{"type":"string","enum":["Europe","US"]},"description":"Filter: instrument.region equals."},{"name":"instrument.region__neq","in":"query","required":false,"schema":{"type":"string","enum":["Europe","US"]},"description":"Filter: instrument.region does not equal."},{"name":"instrument.type__in","in":"query","required":false,"schema":{"type":"string","enum":["Loan","Bond"]},"description":"Filter: instrument.type matches any of (comma-separated)."},{"name":"instrument.type__neq","in":"query","required":false,"schema":{"type":"string","enum":["Loan","Bond"]},"description":"Filter: instrument.type does not equal."},{"name":"issuer.company__contains","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.company contains (case-insensitive substring)."},{"name":"issuer.company__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.company equals."},{"name":"issuer.company__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.company matches any of (comma-separated)."},{"name":"issuer.industry__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.industry equals."},{"name":"issuer.industry__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.industry matches any of (comma-separated)."},{"name":"issuer.industry_l2__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.industry_l2 equals."},{"name":"issuer.industry_l2__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.industry_l2 matches any of (comma-separated)."},{"name":"issuer.industry_l3__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.industry_l3 equals."},{"name":"issuer.industry_l3__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.industry_l3 matches any of (comma-separated)."},{"name":"issuer.sponsor__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.sponsor equals."},{"name":"issuer.sponsor__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: issuer.sponsor matches any of (comma-separated)."},{"name":"issuer.sponsored__eq","in":"query","required":false,"schema":{"type":"boolean"},"description":"Filter: issuer.sponsored equals."},{"name":"parties.bookrunner__contains","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: parties.bookrunner contains (case-insensitive substring)."},{"name":"parties.bookrunner__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: parties.bookrunner equals."},{"name":"parties.bookrunner__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: parties.bookrunner matches any of (comma-separated)."},{"name":"parties.bookrunner_legal_advisor__contains","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: parties.bookrunner_legal_advisor contains (case-insensitive substring)."},{"name":"parties.bookrunner_legal_advisor__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: parties.bookrunner_legal_advisor equals."},{"name":"parties.bookrunner_legal_advisor__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: parties.bookrunner_legal_advisor matches any of (comma-separated)."},{"name":"parties.company_legal_advisor__contains","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: parties.company_legal_advisor contains (case-insensitive substring)."},{"name":"parties.company_legal_advisor__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: parties.company_legal_advisor equals."},{"name":"parties.company_legal_advisor__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: parties.company_legal_advisor matches any of (comma-separated)."},{"name":"ratings.fitch__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.fitch equals."},{"name":"ratings.fitch__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.fitch matches any of (comma-separated)."},{"name":"ratings.fitch__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.fitch does not equal."},{"name":"ratings.fitch_cfr__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.fitch_cfr equals."},{"name":"ratings.fitch_cfr__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.fitch_cfr matches any of (comma-separated)."},{"name":"ratings.fitch_cfr__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.fitch_cfr does not equal."},{"name":"ratings.moodys__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.moodys equals."},{"name":"ratings.moodys__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.moodys matches any of (comma-separated)."},{"name":"ratings.moodys__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.moodys does not equal."},{"name":"ratings.moodys_cfr__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.moodys_cfr equals."},{"name":"ratings.moodys_cfr__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.moodys_cfr matches any of (comma-separated)."},{"name":"ratings.moodys_cfr__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.moodys_cfr does not equal."},{"name":"ratings.s_and_p__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.s_and_p equals."},{"name":"ratings.s_and_p__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.s_and_p matches any of (comma-separated)."},{"name":"ratings.s_and_p__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.s_and_p does not equal."},{"name":"ratings.s_and_p_cfr__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.s_and_p_cfr equals."},{"name":"ratings.s_and_p_cfr__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.s_and_p_cfr matches any of (comma-separated)."},{"name":"ratings.s_and_p_cfr__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: ratings.s_and_p_cfr does not equal."},{"name":"terms.amount__gte","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.amount greater than or equal to."},{"name":"terms.amount__lte","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.amount less than or equal to."},{"name":"terms.coupon__eq","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.coupon equals."},{"name":"terms.coupon__gt","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.coupon greater than."},{"name":"terms.coupon__gte","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.coupon greater than or equal to."},{"name":"terms.coupon__lt","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.coupon less than."},{"name":"terms.coupon__lte","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.coupon less than or equal to."},{"name":"terms.issue_date__eq","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Filter: terms.issue_date equals."},{"name":"terms.issue_date__gt","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Filter: terms.issue_date greater than."},{"name":"terms.issue_date__lt","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Filter: terms.issue_date less than."},{"name":"terms.issue_price__eq","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.issue_price equals."},{"name":"terms.issue_price__gt","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.issue_price greater than."},{"name":"terms.issue_price__gte","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.issue_price greater than or equal to."},{"name":"terms.issue_price__lt","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.issue_price less than."},{"name":"terms.issue_price__lte","in":"query","required":false,"schema":{"type":"number"},"description":"Filter: terms.issue_price less than or equal to."},{"name":"terms.maturity__eq","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Filter: terms.maturity equals."},{"name":"terms.maturity__gt","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Filter: terms.maturity greater than."},{"name":"terms.maturity__lt","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Filter: terms.maturity less than."},{"name":"terms.non_call__eq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: terms.non_call equals."},{"name":"terms.non_call__in","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: terms.non_call matches any of (comma-separated)."},{"name":"terms.non_call__neq","in":"query","required":false,"schema":{"type":"string"},"description":"Filter: terms.non_call does not equal."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CovenantDataSearchResponse"}}}},"401":{"description":"Unauthorized - the `Authorization: Bearer` token is missing, expired, malformed, or was not issued for this API. Obtain a new token from the token endpoint using your application's client credentials and retry. Returned by Kong before the request reaches this service; the app itself performs no token check, so this is the only 401 shape.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KongGatewayError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded. Enforced by Kong.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KongGatewayError"}}}}}}}},"components":{"schemas":{"Covenant":{"properties":{"key":{"type":"string","title":"Key"},"category":{"type":"string","title":"Category"},"name":{"type":"string","title":"Name"},"value_type":{"type":"string","enum":["string","number","boolean"],"title":"Value Type"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"title":"Value"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"}},"type":"object","required":["key","category","name","value_type","value"],"title":"Covenant","description":"One covenant datapoint, self-describing.\n\nCarries its own ``key``/``category``/``name`` inline so no second call to the\nreference catalog is needed to interpret a search response. ``value`` is\nheterogeneous by datapoint (string, number, bool); the required\n``value_type`` discriminator disambiguates it, as published in the\nOpenAPI spec.\n\n``value`` is required and never null: a covenant entry whose source\ndatapoint yields no extractable value is dropped by the composition layer\nrather than emitted as ``value: null`` alongside a ``value_type``.\n``unit`` is omitted from the wire (``response_model_exclude_none``) unless\nthe value is a number with a unit."},"CovenantDataRecord":{"properties":{"instrument":{"$ref":"#/components/schemas/Instrument"},"issuer":{"$ref":"#/components/schemas/Issuer"},"deal":{"$ref":"#/components/schemas/Deal"},"terms":{"$ref":"#/components/schemas/Terms"},"ratings":{"$ref":"#/components/schemas/Ratings"},"parties":{"$ref":"#/components/schemas/Parties"},"financials":{"$ref":"#/components/schemas/Financials"},"covenants":{"items":{"$ref":"#/components/schemas/Covenant"},"type":"array","title":"Covenants"}},"type":"object","required":["instrument","issuer","deal","terms","ratings","parties","financials"],"title":"CovenantDataRecord","description":"One instrument (entity-per-instrument shape)."},"CovenantDataSearchResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CovenantDataRecord"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items"],"title":"CovenantDataSearchResponse"},"Deal":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"Deal","description":"Synthesized deal object.\n\n``id`` is a stable hash of the internal deal identity (never the raw\nsequential integer); ``name`` is synthesized from street name + issue\ndate + instrument type since there is no human-readable deal-name field\nupstream."},"Financials":{"properties":{"ebitda":{"anyOf":[{"$ref":"#/components/schemas/Range"},{"type":"null"}]},"net_senior_leverage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Net Senior Leverage"},"net_total_leverage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Net Total Leverage"}},"type":"object","title":"Financials"},"Instrument":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"country_of_risk":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Of Risk"},"country_of_issuer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Of Issuer"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose"},"is_sustainability_linked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Sustainability Linked"}},"type":"object","title":"Instrument"},"Issuer":{"properties":{"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"industry":{"items":{"type":"string"},"type":"array","title":"Industry"},"industry_l2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Industry L2"},"industry_l3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Industry L3"},"sponsor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sponsor"},"sponsored":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Sponsored"}},"type":"object","title":"Issuer"},"Parties":{"properties":{"bookrunner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bookrunner"},"company_legal_advisor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Legal Advisor"},"bookrunner_legal_advisor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bookrunner Legal Advisor"}},"type":"object","title":"Parties","description":"Counterparties on the instrument.\n\nAll three are real firm names and all three are nulled on restricted rows\n(``scramble_func=set_null`` in ``models.py``), mirroring the legacy\nscreener's behaviour exactly."},"Range":{"properties":{"min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min"},"max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max"}},"type":"object","title":"Range","description":"Anonymised numeric bucket, e.g. amount/EBITDA ranges."},"Ratings":{"properties":{"fitch":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fitch"},"moodys":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Moodys"},"s_and_p":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"S And P"},"fitch_cfr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fitch Cfr"},"moodys_cfr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Moodys Cfr"},"s_and_p_cfr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"S And P Cfr"}},"type":"object","title":"Ratings","description":"Instrument ratings at issuance, plus company-level (CFR) ratings.\n\nThe ``*_cfr`` values are Corporate Family Ratings - a property of the\nissuer, not the tranche."},"Terms":{"properties":{"amount":{"anyOf":[{"$ref":"#/components/schemas/Range"},{"type":"null"}]},"coupon":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coupon"},"issue_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Issue Date"},"maturity":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Maturity"},"issue_price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Issue Price"},"non_call":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Non Call"}},"type":"object","title":"Terms"},"ErrorCode":{"enum":["BAD_REQUEST","VALIDATION_ERROR","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR","SERVICE_UNAVAILABLE"],"title":"ErrorCode","type":"string"},"ErrorResponse":{"description":"The error envelope returned by every non-2xx response from this service.","properties":{"error_code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"title":"Message","type":"string"},"trace_id":{"title":"Trace Id","type":"string"}},"required":["error_code","message","trace_id"],"title":"ErrorResponse","type":"object"},"KongGatewayError":{"type":"object","properties":{"message":{"type":"string","title":"Message"}},"required":["message"],"title":"KongGatewayError"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}} ```