--- title: "PCRED Instrument List" url: "https://console.9fin.com/apis/instruments-private-credit/versions/0a7cc486-1d5a-439d-bde2-7d398e87f4ee/operations/get_instruments_v0_instruments_private_credit_get" --- > Full API specification: https://console.9fin.com/apis/instruments-private-credit/versions/0a7cc486-1d5a-439d-bde2-7d398e87f4ee.md # PCRED Instrument List `GET` `/v0/instruments/private-credit` Operation ID: `get_instruments_v0_instruments_private_credit_get` Returns a list of PCRED instrument data. Allows for filtering and sorting by a variety of instrument attributes. ## Query parameters - `sort_by` (optional) - Comma-separated list of `field__asc` / `field__desc` tokens applied in order, e.g. `company_name__desc,price__asc`. Sortable fields: company_name, company_country_of_risk, company_is_sponsored, company_is_public, industry_l1, industry_l2, industry_l3, reporting_type, reporting_period, reporting_currency, cov_lite, portability, currency, type, status, issuer_entity, issuer_country, borrower_legal_advisor, lender_legal_advisor, sponsor, borrower_advisor, lender_advisor, benchmark, is_add_on, governing_law, is_redeemed, is_sustainability_linked. - `limit` (optional) - Maximum number of rows to return. - `cursor` (optional) - Opaque keyset-pagination cursor from a prior page. - `company_name__eq` (optional) - Filter company_name where the value is equal to the given value. - `company_name__neq` (optional) - Filter company_name where the value is not equal to the given value. - `company_name__contains` (optional) - Filter company_name where the value contains the given value. - `company_name__in` (optional) - Filter company_name where the value is in the given list. - `company_country_of_risk__eq` (optional) - Filter company_country_of_risk where the value is equal to the given value. - `company_country_of_risk__neq` (optional) - Filter company_country_of_risk where the value is not equal to the given value. - `company_country_of_risk__contains` (optional) - Filter company_country_of_risk where the value contains the given value. - `company_country_of_risk__in` (optional) - Filter company_country_of_risk where the value is in the given list. - `company_country_of_risk__isnull` (optional) - Filter company_country_of_risk to rows where the value is NULL (true) or is not NULL (false). - `company_is_sponsored__eq` (optional) - Filter company_is_sponsored where the value is equal to the given value. - `company_is_sponsored__neq` (optional) - Filter company_is_sponsored where the value is not equal to the given value. - `company_is_public__eq` (optional) - Filter company_is_public where the value is equal to the given value. - `company_is_public__neq` (optional) - Filter company_is_public where the value is not equal to the given value. - `industry_l1__eq` (optional) - Filter industry_l1 where the value is equal to the given value. - `industry_l1__neq` (optional) - Filter industry_l1 where the value is not equal to the given value. - `industry_l1__contains` (optional) - Filter industry_l1 where the value contains the given value. - `industry_l1__in` (optional) - Filter industry_l1 where the value is in the given list. - `industry_l1__isnull` (optional) - Filter industry_l1 to rows where the value is NULL (true) or is not NULL (false). - `industry_l2__eq` (optional) - Filter industry_l2 where the value is equal to the given value. - `industry_l2__neq` (optional) - Filter industry_l2 where the value is not equal to the given value. - `industry_l2__contains` (optional) - Filter industry_l2 where the value contains the given value. - `industry_l2__in` (optional) - Filter industry_l2 where the value is in the given list. - `industry_l2__isnull` (optional) - Filter industry_l2 to rows where the value is NULL (true) or is not NULL (false). - `industry_l3__eq` (optional) - Filter industry_l3 where the value is equal to the given value. - `industry_l3__neq` (optional) - Filter industry_l3 where the value is not equal to the given value. - `industry_l3__contains` (optional) - Filter industry_l3 where the value contains the given value. - `industry_l3__in` (optional) - Filter industry_l3 where the value is in the given list. - `industry_l3__isnull` (optional) - Filter industry_l3 to rows where the value is NULL (true) or is not NULL (false). - `reporting_type__eq` (optional) - Filter reporting_type where the value is equal to the given value. - `reporting_type__neq` (optional) - Filter reporting_type where the value is not equal to the given value. - `reporting_type__contains` (optional) - Filter reporting_type where the value contains the given value. - `reporting_type__in` (optional) - Filter reporting_type where the value is in the given list. - `reporting_type__isnull` (optional) - Filter reporting_type to rows where the value is NULL (true) or is not NULL (false). - `reporting_period__eq` (optional) - Filter reporting_period where the value is equal to the given value. - `reporting_period__neq` (optional) - Filter reporting_period where the value is not equal to the given value. - `reporting_period__gt` (optional) - Filter reporting_period where the value is greater than the given value. - `reporting_period__gte` (optional) - Filter reporting_period where the value is greater or equal to the given value. - `reporting_period__lt` (optional) - Filter reporting_period where the value is less than the given value. - `reporting_period__lte` (optional) - Filter reporting_period where the value is less or equal to the given value. - `reporting_period__in` (optional) - Filter reporting_period where the value is in the given list. - `reporting_period__isnull` (optional) - Filter reporting_period to rows where the value is NULL (true) or is not NULL (false). - `reporting_currency__eq` (optional) - Filter reporting_currency where the value is equal to the given value. - `reporting_currency__neq` (optional) - Filter reporting_currency where the value is not equal to the given value. - `reporting_currency__contains` (optional) - Filter reporting_currency where the value contains the given value. - `reporting_currency__in` (optional) - Filter reporting_currency where the value is in the given list. - `reporting_currency__isnull` (optional) - Filter reporting_currency to rows where the value is NULL (true) or is not NULL (false). - `marketed_sales__eq` (optional) - Filter where the marketed_sales range overlaps the window bounded by this value (equal). - `marketed_sales__gt` (optional) - Filter where the marketed_sales range overlaps the window bounded by this value (greater). - `marketed_sales__gte` (optional) - Filter where the marketed_sales range overlaps the window bounded by this value (greater_or_equal). - `marketed_sales__lt` (optional) - Filter where the marketed_sales range overlaps the window bounded by this value (less). - `marketed_sales__lte` (optional) - Filter where the marketed_sales range overlaps the window bounded by this value (less_or_equal). - `marketed_sales__isnull` (optional) - Filter marketed_sales to rows where the value is NULL (true) or is not NULL (false). - `marketed_ebitda__eq` (optional) - Filter where the marketed_ebitda range overlaps the window bounded by this value (equal). - `marketed_ebitda__gt` (optional) - Filter where the marketed_ebitda range overlaps the window bounded by this value (greater). - `marketed_ebitda__gte` (optional) - Filter where the marketed_ebitda range overlaps the window bounded by this value (greater_or_equal). - `marketed_ebitda__lt` (optional) - Filter where the marketed_ebitda range overlaps the window bounded by this value (less). - `marketed_ebitda__lte` (optional) - Filter where the marketed_ebitda range overlaps the window bounded by this value (less_or_equal). - `marketed_ebitda__isnull` (optional) - Filter marketed_ebitda to rows where the value is NULL (true) or is not NULL (false). - `marketed_capex__eq` (optional) - Filter where the marketed_capex range overlaps the window bounded by this value (equal). - `marketed_capex__gt` (optional) - Filter where the marketed_capex range overlaps the window bounded by this value (greater). - `marketed_capex__gte` (optional) - Filter where the marketed_capex range overlaps the window bounded by this value (greater_or_equal). - `marketed_capex__lt` (optional) - Filter where the marketed_capex range overlaps the window bounded by this value (less). - `marketed_capex__lte` (optional) - Filter where the marketed_capex range overlaps the window bounded by this value (less_or_equal). - `marketed_capex__isnull` (optional) - Filter marketed_capex to rows where the value is NULL (true) or is not NULL (false). - `marketed_capex_margin__eq` (optional) - Filter where the marketed_capex_margin range overlaps the window bounded by this value (equal). - `marketed_capex_margin__gt` (optional) - Filter where the marketed_capex_margin range overlaps the window bounded by this value (greater). - `marketed_capex_margin__gte` (optional) - Filter where the marketed_capex_margin range overlaps the window bounded by this value (greater_or_equal). - `marketed_capex_margin__lt` (optional) - Filter where the marketed_capex_margin range overlaps the window bounded by this value (less). - `marketed_capex_margin__lte` (optional) - Filter where the marketed_capex_margin range overlaps the window bounded by this value (less_or_equal). - `marketed_capex_margin__isnull` (optional) - Filter marketed_capex_margin to rows where the value is NULL (true) or is not NULL (false). - `marketed_gross_senior_leverage__eq` (optional) - Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (equal). - `marketed_gross_senior_leverage__gt` (optional) - Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (greater). - `marketed_gross_senior_leverage__gte` (optional) - Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (greater_or_equal). - `marketed_gross_senior_leverage__lt` (optional) - Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (less). - `marketed_gross_senior_leverage__lte` (optional) - Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (less_or_equal). - `marketed_gross_senior_leverage__isnull` (optional) - Filter marketed_gross_senior_leverage to rows where the value is NULL (true) or is not NULL (false). - `marketed_net_senior_leverage__eq` (optional) - Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (equal). - `marketed_net_senior_leverage__gt` (optional) - Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (greater). - `marketed_net_senior_leverage__gte` (optional) - Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (greater_or_equal). - `marketed_net_senior_leverage__lt` (optional) - Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (less). - `marketed_net_senior_leverage__lte` (optional) - Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (less_or_equal). - `marketed_net_senior_leverage__isnull` (optional) - Filter marketed_net_senior_leverage to rows where the value is NULL (true) or is not NULL (false). - `marketed_gross_total_leverage__eq` (optional) - Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (equal). - `marketed_gross_total_leverage__gt` (optional) - Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (greater). - `marketed_gross_total_leverage__gte` (optional) - Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (greater_or_equal). - `marketed_gross_total_leverage__lt` (optional) - Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (less). - `marketed_gross_total_leverage__lte` (optional) - Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (less_or_equal). - `marketed_gross_total_leverage__isnull` (optional) - Filter marketed_gross_total_leverage to rows where the value is NULL (true) or is not NULL (false). - `marketed_net_total_leverage__eq` (optional) - Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (equal). - `marketed_net_total_leverage__gt` (optional) - Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (greater). - `marketed_net_total_leverage__gte` (optional) - Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (greater_or_equal). - `marketed_net_total_leverage__lt` (optional) - Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (less). - `marketed_net_total_leverage__lte` (optional) - Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (less_or_equal). - `marketed_net_total_leverage__isnull` (optional) - Filter marketed_net_total_leverage to rows where the value is NULL (true) or is not NULL (false). - `marketed_interest_coverage__eq` (optional) - Filter where the marketed_interest_coverage range overlaps the window bounded by this value (equal). - `marketed_interest_coverage__gt` (optional) - Filter where the marketed_interest_coverage range overlaps the window bounded by this value (greater). - `marketed_interest_coverage__gte` (optional) - Filter where the marketed_interest_coverage range overlaps the window bounded by this value (greater_or_equal). - `marketed_interest_coverage__lt` (optional) - Filter where the marketed_interest_coverage range overlaps the window bounded by this value (less). - `marketed_interest_coverage__lte` (optional) - Filter where the marketed_interest_coverage range overlaps the window bounded by this value (less_or_equal). - `marketed_interest_coverage__isnull` (optional) - Filter marketed_interest_coverage to rows where the value is NULL (true) or is not NULL (false). - `cov_lite__eq` (optional) - Filter cov_lite where the value is equal to the given value. - `cov_lite__neq` (optional) - Filter cov_lite where the value is not equal to the given value. - `cov_lite__isnull` (optional) - Filter cov_lite to rows where the value is NULL (true) or is not NULL (false). - `portability__eq` (optional) - Filter portability where the value is equal to the given value. - `portability__neq` (optional) - Filter portability where the value is not equal to the given value. - `portability__isnull` (optional) - Filter portability to rows where the value is NULL (true) or is not NULL (false). - `currency__eq` (optional) - Filter currency where the value is equal to the given value. - `currency__neq` (optional) - Filter currency where the value is not equal to the given value. - `currency__contains` (optional) - Filter currency where the value contains the given value. - `currency__in` (optional) - Filter currency where the value is in the given list. - `currency__isnull` (optional) - Filter currency to rows where the value is NULL (true) or is not NULL (false). - `amount__eq` (optional) - Filter where the amount range overlaps the window bounded by this value (equal). - `amount__gt` (optional) - Filter where the amount range overlaps the window bounded by this value (greater). - `amount__gte` (optional) - Filter where the amount range overlaps the window bounded by this value (greater_or_equal). - `amount__lt` (optional) - Filter where the amount range overlaps the window bounded by this value (less). - `amount__lte` (optional) - Filter where the amount range overlaps the window bounded by this value (less_or_equal). - `amount__isnull` (optional) - Filter amount to rows where the value is NULL (true) or is not NULL (false). - `margin__eq` (optional) - Filter where the margin range overlaps the window bounded by this value (equal). - `margin__gt` (optional) - Filter where the margin range overlaps the window bounded by this value (greater). - `margin__gte` (optional) - Filter where the margin range overlaps the window bounded by this value (greater_or_equal). - `margin__lt` (optional) - Filter where the margin range overlaps the window bounded by this value (less). - `margin__lte` (optional) - Filter where the margin range overlaps the window bounded by this value (less_or_equal). - `margin__isnull` (optional) - Filter margin to rows where the value is NULL (true) or is not NULL (false). - `type__eq` (optional) - Filter type where the value is equal to the given value. - `type__neq` (optional) - Filter type where the value is not equal to the given value. - `type__contains` (optional) - Filter type where the value contains the given value. - `type__in` (optional) - Filter type where the value is in the given list. - `type__isnull` (optional) - Filter type to rows where the value is NULL (true) or is not NULL (false). - `maturity__eq` (optional) - Filter where the maturity range overlaps the window bounded by this value (equal). - `maturity__gt` (optional) - Filter where the maturity range overlaps the window bounded by this value (greater). - `maturity__gte` (optional) - Filter where the maturity range overlaps the window bounded by this value (greater_or_equal). - `maturity__lt` (optional) - Filter where the maturity range overlaps the window bounded by this value (less). - `maturity__lte` (optional) - Filter where the maturity range overlaps the window bounded by this value (less_or_equal). - `maturity__isnull` (optional) - Filter maturity to rows where the value is NULL (true) or is not NULL (false). - `issue_date__eq` (optional) - Filter where the issue_date range overlaps the window bounded by this value (equal). - `issue_date__gt` (optional) - Filter where the issue_date range overlaps the window bounded by this value (greater). - `issue_date__gte` (optional) - Filter where the issue_date range overlaps the window bounded by this value (greater_or_equal). - `issue_date__lt` (optional) - Filter where the issue_date range overlaps the window bounded by this value (less). - `issue_date__lte` (optional) - Filter where the issue_date range overlaps the window bounded by this value (less_or_equal). - `issue_date__isnull` (optional) - Filter issue_date to rows where the value is NULL (true) or is not NULL (false). - `issue_price__eq` (optional) - Filter where the issue_price range overlaps the window bounded by this value (equal). - `issue_price__gt` (optional) - Filter where the issue_price range overlaps the window bounded by this value (greater). - `issue_price__gte` (optional) - Filter where the issue_price range overlaps the window bounded by this value (greater_or_equal). - `issue_price__lt` (optional) - Filter where the issue_price range overlaps the window bounded by this value (less). - `issue_price__lte` (optional) - Filter where the issue_price range overlaps the window bounded by this value (less_or_equal). - `issue_price__isnull` (optional) - Filter issue_price to rows where the value is NULL (true) or is not NULL (false). - `purpose__contains` (optional) - Filter where the purpose array contains this value. - `purpose__isnull` (optional) - Filter purpose to rows where the value is NULL (true) or is not NULL (false). - `tenor__eq` (optional) - Filter where the tenor range overlaps the window bounded by this value (equal). - `tenor__gt` (optional) - Filter where the tenor range overlaps the window bounded by this value (greater). - `tenor__gte` (optional) - Filter where the tenor range overlaps the window bounded by this value (greater_or_equal). - `tenor__lt` (optional) - Filter where the tenor range overlaps the window bounded by this value (less). - `tenor__lte` (optional) - Filter where the tenor range overlaps the window bounded by this value (less_or_equal). - `tenor__isnull` (optional) - Filter tenor to rows where the value is NULL (true) or is not NULL (false). - `status__eq` (optional) - Filter status where the value is equal to the given value. - `status__neq` (optional) - Filter status where the value is not equal to the given value. - `status__contains` (optional) - Filter status where the value contains the given value. - `status__in` (optional) - Filter status where the value is in the given list. - `issuer_entity__eq` (optional) - Filter issuer_entity where the value is equal to the given value. - `issuer_entity__neq` (optional) - Filter issuer_entity where the value is not equal to the given value. - `issuer_entity__contains` (optional) - Filter issuer_entity where the value contains the given value. - `issuer_entity__in` (optional) - Filter issuer_entity where the value is in the given list. - `issuer_country__eq` (optional) - Filter issuer_country where the value is equal to the given value. - `issuer_country__neq` (optional) - Filter issuer_country where the value is not equal to the given value. - `issuer_country__contains` (optional) - Filter issuer_country where the value contains the given value. - `issuer_country__in` (optional) - Filter issuer_country where the value is in the given list. - `issuer_country__isnull` (optional) - Filter issuer_country to rows where the value is NULL (true) or is not NULL (false). - `borrower_legal_advisor__eq` (optional) - Filter borrower_legal_advisor where the value is equal to the given value. - `borrower_legal_advisor__neq` (optional) - Filter borrower_legal_advisor where the value is not equal to the given value. - `borrower_legal_advisor__contains` (optional) - Filter borrower_legal_advisor where the value contains the given value. - `borrower_legal_advisor__in` (optional) - Filter borrower_legal_advisor where the value is in the given list. - `lender_legal_advisor__eq` (optional) - Filter lender_legal_advisor where the value is equal to the given value. - `lender_legal_advisor__neq` (optional) - Filter lender_legal_advisor where the value is not equal to the given value. - `lender_legal_advisor__contains` (optional) - Filter lender_legal_advisor where the value contains the given value. - `lender_legal_advisor__in` (optional) - Filter lender_legal_advisor where the value is in the given list. - `pik_coupon__eq` (optional) - Filter where the pik_coupon range overlaps the window bounded by this value (equal). - `pik_coupon__gt` (optional) - Filter where the pik_coupon range overlaps the window bounded by this value (greater). - `pik_coupon__gte` (optional) - Filter where the pik_coupon range overlaps the window bounded by this value (greater_or_equal). - `pik_coupon__lt` (optional) - Filter where the pik_coupon range overlaps the window bounded by this value (less). - `pik_coupon__lte` (optional) - Filter where the pik_coupon range overlaps the window bounded by this value (less_or_equal). - `pik_coupon__isnull` (optional) - Filter pik_coupon to rows where the value is NULL (true) or is not NULL (false). - `sponsor__eq` (optional) - Filter sponsor where the value is equal to the given value. - `sponsor__neq` (optional) - Filter sponsor where the value is not equal to the given value. - `sponsor__contains` (optional) - Filter sponsor where the value contains the given value. - `sponsor__in` (optional) - Filter sponsor where the value is in the given list. - `borrower_advisor__eq` (optional) - Filter borrower_advisor where the value is equal to the given value. - `borrower_advisor__neq` (optional) - Filter borrower_advisor where the value is not equal to the given value. - `borrower_advisor__contains` (optional) - Filter borrower_advisor where the value contains the given value. - `borrower_advisor__in` (optional) - Filter borrower_advisor where the value is in the given list. - `lender_advisor__eq` (optional) - Filter lender_advisor where the value is equal to the given value. - `lender_advisor__neq` (optional) - Filter lender_advisor where the value is not equal to the given value. - `lender_advisor__contains` (optional) - Filter lender_advisor where the value contains the given value. - `lender_advisor__in` (optional) - Filter lender_advisor where the value is in the given list. - `benchmark__eq` (optional) - Filter benchmark where the value is equal to the given value. - `benchmark__neq` (optional) - Filter benchmark where the value is not equal to the given value. - `benchmark__contains` (optional) - Filter benchmark where the value contains the given value. - `benchmark__in` (optional) - Filter benchmark where the value is in the given list. - `benchmark__isnull` (optional) - Filter benchmark to rows where the value is NULL (true) or is not NULL (false). - `is_add_on__eq` (optional) - Filter is_add_on where the value is equal to the given value. - `is_add_on__neq` (optional) - Filter is_add_on where the value is not equal to the given value. - `is_add_on__isnull` (optional) - Filter is_add_on to rows where the value is NULL (true) or is not NULL (false). - `governing_law__eq` (optional) - Filter governing_law where the value is equal to the given value. - `governing_law__neq` (optional) - Filter governing_law where the value is not equal to the given value. - `governing_law__contains` (optional) - Filter governing_law where the value contains the given value. - `governing_law__in` (optional) - Filter governing_law where the value is in the given list. - `governing_law__isnull` (optional) - Filter governing_law to rows where the value is NULL (true) or is not NULL (false). - `is_redeemed__eq` (optional) - Filter is_redeemed where the value is equal to the given value. - `is_redeemed__neq` (optional) - Filter is_redeemed where the value is not equal to the given value. - `is_redeemed__isnull` (optional) - Filter is_redeemed to rows where the value is NULL (true) or is not NULL (false). - `lenders__contains` (optional) - Filter where the lenders array contains this value. - `lenders__isnull` (optional) - Filter lenders to rows where the value is NULL (true) or is not NULL (false). - `is_sustainability_linked__eq` (optional) - Filter is_sustainability_linked where the value is equal to the given value. - `is_sustainability_linked__neq` (optional) - Filter is_sustainability_linked where the value is not equal to the given value. - `is_sustainability_linked__isnull` (optional) - Filter is_sustainability_linked to rows where the value is NULL (true) or is not NULL (false). ## Responses - `200` - Successful Response - `400` - Bad request (e.g. invalid cursor). - `422` - Validation Error - `500` - Unexpected server error. - `503` - Service unavailable (e.g. database down). ## OpenAPI definition ```yaml openapi: 3.1.0 info: title: 9Fin Instruments (Private Credit) API version: 0.1.10 servers: - description: Production environment url: https://api.9fin.com paths: /v0/instruments/private-credit: get: description: |- Returns a list of PCRED instrument data. Allows for filtering and sorting by a variety of instrument attributes. operationId: get_instruments_v0_instruments_private_credit_get parameters: - description: "Comma-separated list of `field__asc` / `field__desc` tokens applied in order, e.g. `company_name__desc,price__asc`. Sortable fields: company_name, company_country_of_risk, company_is_sponsored, company_is_public, industry_l1, industry_l2, industry_l3, reporting_type, reporting_period, reporting_currency, cov_lite, portability, currency, type, status, issuer_entity, issuer_country, borrower_legal_advisor, lender_legal_advisor, sponsor, borrower_advisor, lender_advisor, benchmark, is_add_on, governing_law, is_redeemed, is_sustainability_linked." in: query name: sort_by required: false schema: anyOf: - type: string - type: "null" default: null description: "Comma-separated list of `field__asc` / `field__desc` tokens applied in order, e.g. `company_name__desc,price__asc`. Sortable fields: company_name, company_country_of_risk, company_is_sponsored, company_is_public, industry_l1, industry_l2, industry_l3, reporting_type, reporting_period, reporting_currency, cov_lite, portability, currency, type, status, issuer_entity, issuer_country, borrower_legal_advisor, lender_legal_advisor, sponsor, borrower_advisor, lender_advisor, benchmark, is_add_on, governing_law, is_redeemed, is_sustainability_linked." title: Sort By - description: Maximum number of rows to return. in: query name: limit required: false schema: anyOf: - maximum: 100 minimum: 1 type: integer - type: "null" default: 20 description: Maximum number of rows to return. title: Limit - description: Opaque keyset-pagination cursor from a prior page. in: query name: cursor required: false schema: anyOf: - type: string - type: "null" default: null description: Opaque keyset-pagination cursor from a prior page. title: Cursor - description: Filter company_name where the value is equal to the given value. in: query name: company_name__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter company_name where the value is equal to the given value. title: Company Name Eq - description: Filter company_name where the value is not equal to the given value. in: query name: company_name__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter company_name where the value is not equal to the given value. title: Company Name Neq - description: Filter company_name where the value contains the given value. in: query name: company_name__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter company_name where the value contains the given value. title: Company Name Contains - description: Filter company_name where the value is in the given list. in: query name: company_name__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter company_name where the value is in the given list. title: Company Name In - description: Filter company_country_of_risk where the value is equal to the given value. in: query name: company_country_of_risk__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter company_country_of_risk where the value is equal to the given value. title: Company Country Of Risk Eq - description: Filter company_country_of_risk where the value is not equal to the given value. in: query name: company_country_of_risk__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter company_country_of_risk where the value is not equal to the given value. title: Company Country Of Risk Neq - description: Filter company_country_of_risk where the value contains the given value. in: query name: company_country_of_risk__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter company_country_of_risk where the value contains the given value. title: Company Country Of Risk Contains - description: Filter company_country_of_risk where the value is in the given list. in: query name: company_country_of_risk__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter company_country_of_risk where the value is in the given list. title: Company Country Of Risk In - description: Filter company_country_of_risk to rows where the value is NULL (true) or is not NULL (false). in: query name: company_country_of_risk__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter company_country_of_risk to rows where the value is NULL (true) or is not NULL (false). title: Company Country Of Risk Isnull - description: Filter company_is_sponsored where the value is equal to the given value. in: query name: company_is_sponsored__eq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter company_is_sponsored where the value is equal to the given value. title: Company Is Sponsored Eq - description: Filter company_is_sponsored where the value is not equal to the given value. in: query name: company_is_sponsored__neq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter company_is_sponsored where the value is not equal to the given value. title: Company Is Sponsored Neq - description: Filter company_is_public where the value is equal to the given value. in: query name: company_is_public__eq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter company_is_public where the value is equal to the given value. title: Company Is Public Eq - description: Filter company_is_public where the value is not equal to the given value. in: query name: company_is_public__neq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter company_is_public where the value is not equal to the given value. title: Company Is Public Neq - description: Filter industry_l1 where the value is equal to the given value. in: query name: industry_l1__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l1 where the value is equal to the given value. title: Industry L1 Eq - description: Filter industry_l1 where the value is not equal to the given value. in: query name: industry_l1__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l1 where the value is not equal to the given value. title: Industry L1 Neq - description: Filter industry_l1 where the value contains the given value. in: query name: industry_l1__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l1 where the value contains the given value. title: Industry L1 Contains - description: Filter industry_l1 where the value is in the given list. in: query name: industry_l1__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l1 where the value is in the given list. title: Industry L1 In - description: Filter industry_l1 to rows where the value is NULL (true) or is not NULL (false). in: query name: industry_l1__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter industry_l1 to rows where the value is NULL (true) or is not NULL (false). title: Industry L1 Isnull - description: Filter industry_l2 where the value is equal to the given value. in: query name: industry_l2__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l2 where the value is equal to the given value. title: Industry L2 Eq - description: Filter industry_l2 where the value is not equal to the given value. in: query name: industry_l2__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l2 where the value is not equal to the given value. title: Industry L2 Neq - description: Filter industry_l2 where the value contains the given value. in: query name: industry_l2__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l2 where the value contains the given value. title: Industry L2 Contains - description: Filter industry_l2 where the value is in the given list. in: query name: industry_l2__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l2 where the value is in the given list. title: Industry L2 In - description: Filter industry_l2 to rows where the value is NULL (true) or is not NULL (false). in: query name: industry_l2__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter industry_l2 to rows where the value is NULL (true) or is not NULL (false). title: Industry L2 Isnull - description: Filter industry_l3 where the value is equal to the given value. in: query name: industry_l3__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l3 where the value is equal to the given value. title: Industry L3 Eq - description: Filter industry_l3 where the value is not equal to the given value. in: query name: industry_l3__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l3 where the value is not equal to the given value. title: Industry L3 Neq - description: Filter industry_l3 where the value contains the given value. in: query name: industry_l3__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l3 where the value contains the given value. title: Industry L3 Contains - description: Filter industry_l3 where the value is in the given list. in: query name: industry_l3__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter industry_l3 where the value is in the given list. title: Industry L3 In - description: Filter industry_l3 to rows where the value is NULL (true) or is not NULL (false). in: query name: industry_l3__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter industry_l3 to rows where the value is NULL (true) or is not NULL (false). title: Industry L3 Isnull - description: Filter reporting_type where the value is equal to the given value. in: query name: reporting_type__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter reporting_type where the value is equal to the given value. title: Reporting Type Eq - description: Filter reporting_type where the value is not equal to the given value. in: query name: reporting_type__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter reporting_type where the value is not equal to the given value. title: Reporting Type Neq - description: Filter reporting_type where the value contains the given value. in: query name: reporting_type__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter reporting_type where the value contains the given value. title: Reporting Type Contains - description: Filter reporting_type where the value is in the given list. in: query name: reporting_type__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter reporting_type where the value is in the given list. title: Reporting Type In - description: Filter reporting_type to rows where the value is NULL (true) or is not NULL (false). in: query name: reporting_type__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter reporting_type to rows where the value is NULL (true) or is not NULL (false). title: Reporting Type Isnull - description: Filter reporting_period where the value is equal to the given value. in: query name: reporting_period__eq required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter reporting_period where the value is equal to the given value. title: Reporting Period Eq - description: Filter reporting_period where the value is not equal to the given value. in: query name: reporting_period__neq required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter reporting_period where the value is not equal to the given value. title: Reporting Period Neq - description: Filter reporting_period where the value is greater than the given value. in: query name: reporting_period__gt required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter reporting_period where the value is greater than the given value. title: Reporting Period Gt - description: Filter reporting_period where the value is greater or equal to the given value. in: query name: reporting_period__gte required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter reporting_period where the value is greater or equal to the given value. title: Reporting Period Gte - description: Filter reporting_period where the value is less than the given value. in: query name: reporting_period__lt required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter reporting_period where the value is less than the given value. title: Reporting Period Lt - description: Filter reporting_period where the value is less or equal to the given value. in: query name: reporting_period__lte required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter reporting_period where the value is less or equal to the given value. title: Reporting Period Lte - description: Filter reporting_period where the value is in the given list. in: query name: reporting_period__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter reporting_period where the value is in the given list. title: Reporting Period In - description: Filter reporting_period to rows where the value is NULL (true) or is not NULL (false). in: query name: reporting_period__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter reporting_period to rows where the value is NULL (true) or is not NULL (false). title: Reporting Period Isnull - description: Filter reporting_currency where the value is equal to the given value. in: query name: reporting_currency__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter reporting_currency where the value is equal to the given value. title: Reporting Currency Eq - description: Filter reporting_currency where the value is not equal to the given value. in: query name: reporting_currency__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter reporting_currency where the value is not equal to the given value. title: Reporting Currency Neq - description: Filter reporting_currency where the value contains the given value. in: query name: reporting_currency__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter reporting_currency where the value contains the given value. title: Reporting Currency Contains - description: Filter reporting_currency where the value is in the given list. in: query name: reporting_currency__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter reporting_currency where the value is in the given list. title: Reporting Currency In - description: Filter reporting_currency to rows where the value is NULL (true) or is not NULL (false). in: query name: reporting_currency__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter reporting_currency to rows where the value is NULL (true) or is not NULL (false). title: Reporting Currency Isnull - description: Filter where the marketed_sales range overlaps the window bounded by this value (equal). in: query name: marketed_sales__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_sales range overlaps the window bounded by this value (equal). title: Marketed Sales Eq - description: Filter where the marketed_sales range overlaps the window bounded by this value (greater). in: query name: marketed_sales__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_sales range overlaps the window bounded by this value (greater). title: Marketed Sales Gt - description: Filter where the marketed_sales range overlaps the window bounded by this value (greater_or_equal). in: query name: marketed_sales__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_sales range overlaps the window bounded by this value (greater_or_equal). title: Marketed Sales Gte - description: Filter where the marketed_sales range overlaps the window bounded by this value (less). in: query name: marketed_sales__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_sales range overlaps the window bounded by this value (less). title: Marketed Sales Lt - description: Filter where the marketed_sales range overlaps the window bounded by this value (less_or_equal). in: query name: marketed_sales__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_sales range overlaps the window bounded by this value (less_or_equal). title: Marketed Sales Lte - description: Filter marketed_sales to rows where the value is NULL (true) or is not NULL (false). in: query name: marketed_sales__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter marketed_sales to rows where the value is NULL (true) or is not NULL (false). title: Marketed Sales Isnull - description: Filter where the marketed_ebitda range overlaps the window bounded by this value (equal). in: query name: marketed_ebitda__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_ebitda range overlaps the window bounded by this value (equal). title: Marketed Ebitda Eq - description: Filter where the marketed_ebitda range overlaps the window bounded by this value (greater). in: query name: marketed_ebitda__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_ebitda range overlaps the window bounded by this value (greater). title: Marketed Ebitda Gt - description: Filter where the marketed_ebitda range overlaps the window bounded by this value (greater_or_equal). in: query name: marketed_ebitda__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_ebitda range overlaps the window bounded by this value (greater_or_equal). title: Marketed Ebitda Gte - description: Filter where the marketed_ebitda range overlaps the window bounded by this value (less). in: query name: marketed_ebitda__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_ebitda range overlaps the window bounded by this value (less). title: Marketed Ebitda Lt - description: Filter where the marketed_ebitda range overlaps the window bounded by this value (less_or_equal). in: query name: marketed_ebitda__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_ebitda range overlaps the window bounded by this value (less_or_equal). title: Marketed Ebitda Lte - description: Filter marketed_ebitda to rows where the value is NULL (true) or is not NULL (false). in: query name: marketed_ebitda__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter marketed_ebitda to rows where the value is NULL (true) or is not NULL (false). title: Marketed Ebitda Isnull - description: Filter where the marketed_capex range overlaps the window bounded by this value (equal). in: query name: marketed_capex__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex range overlaps the window bounded by this value (equal). title: Marketed Capex Eq - description: Filter where the marketed_capex range overlaps the window bounded by this value (greater). in: query name: marketed_capex__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex range overlaps the window bounded by this value (greater). title: Marketed Capex Gt - description: Filter where the marketed_capex range overlaps the window bounded by this value (greater_or_equal). in: query name: marketed_capex__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex range overlaps the window bounded by this value (greater_or_equal). title: Marketed Capex Gte - description: Filter where the marketed_capex range overlaps the window bounded by this value (less). in: query name: marketed_capex__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex range overlaps the window bounded by this value (less). title: Marketed Capex Lt - description: Filter where the marketed_capex range overlaps the window bounded by this value (less_or_equal). in: query name: marketed_capex__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex range overlaps the window bounded by this value (less_or_equal). title: Marketed Capex Lte - description: Filter marketed_capex to rows where the value is NULL (true) or is not NULL (false). in: query name: marketed_capex__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter marketed_capex to rows where the value is NULL (true) or is not NULL (false). title: Marketed Capex Isnull - description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (equal). in: query name: marketed_capex_margin__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (equal). title: Marketed Capex Margin Eq - description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (greater). in: query name: marketed_capex_margin__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (greater). title: Marketed Capex Margin Gt - description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (greater_or_equal). in: query name: marketed_capex_margin__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (greater_or_equal). title: Marketed Capex Margin Gte - description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (less). in: query name: marketed_capex_margin__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (less). title: Marketed Capex Margin Lt - description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (less_or_equal). in: query name: marketed_capex_margin__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_capex_margin range overlaps the window bounded by this value (less_or_equal). title: Marketed Capex Margin Lte - description: Filter marketed_capex_margin to rows where the value is NULL (true) or is not NULL (false). in: query name: marketed_capex_margin__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter marketed_capex_margin to rows where the value is NULL (true) or is not NULL (false). title: Marketed Capex Margin Isnull - description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (equal). in: query name: marketed_gross_senior_leverage__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (equal). title: Marketed Gross Senior Leverage Eq - description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (greater). in: query name: marketed_gross_senior_leverage__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (greater). title: Marketed Gross Senior Leverage Gt - description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (greater_or_equal). in: query name: marketed_gross_senior_leverage__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (greater_or_equal). title: Marketed Gross Senior Leverage Gte - description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (less). in: query name: marketed_gross_senior_leverage__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (less). title: Marketed Gross Senior Leverage Lt - description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (less_or_equal). in: query name: marketed_gross_senior_leverage__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_senior_leverage range overlaps the window bounded by this value (less_or_equal). title: Marketed Gross Senior Leverage Lte - description: Filter marketed_gross_senior_leverage to rows where the value is NULL (true) or is not NULL (false). in: query name: marketed_gross_senior_leverage__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter marketed_gross_senior_leverage to rows where the value is NULL (true) or is not NULL (false). title: Marketed Gross Senior Leverage Isnull - description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (equal). in: query name: marketed_net_senior_leverage__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (equal). title: Marketed Net Senior Leverage Eq - description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (greater). in: query name: marketed_net_senior_leverage__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (greater). title: Marketed Net Senior Leverage Gt - description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (greater_or_equal). in: query name: marketed_net_senior_leverage__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (greater_or_equal). title: Marketed Net Senior Leverage Gte - description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (less). in: query name: marketed_net_senior_leverage__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (less). title: Marketed Net Senior Leverage Lt - description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (less_or_equal). in: query name: marketed_net_senior_leverage__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_senior_leverage range overlaps the window bounded by this value (less_or_equal). title: Marketed Net Senior Leverage Lte - description: Filter marketed_net_senior_leverage to rows where the value is NULL (true) or is not NULL (false). in: query name: marketed_net_senior_leverage__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter marketed_net_senior_leverage to rows where the value is NULL (true) or is not NULL (false). title: Marketed Net Senior Leverage Isnull - description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (equal). in: query name: marketed_gross_total_leverage__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (equal). title: Marketed Gross Total Leverage Eq - description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (greater). in: query name: marketed_gross_total_leverage__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (greater). title: Marketed Gross Total Leverage Gt - description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (greater_or_equal). in: query name: marketed_gross_total_leverage__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (greater_or_equal). title: Marketed Gross Total Leverage Gte - description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (less). in: query name: marketed_gross_total_leverage__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (less). title: Marketed Gross Total Leverage Lt - description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (less_or_equal). in: query name: marketed_gross_total_leverage__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_gross_total_leverage range overlaps the window bounded by this value (less_or_equal). title: Marketed Gross Total Leverage Lte - description: Filter marketed_gross_total_leverage to rows where the value is NULL (true) or is not NULL (false). in: query name: marketed_gross_total_leverage__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter marketed_gross_total_leverage to rows where the value is NULL (true) or is not NULL (false). title: Marketed Gross Total Leverage Isnull - description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (equal). in: query name: marketed_net_total_leverage__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (equal). title: Marketed Net Total Leverage Eq - description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (greater). in: query name: marketed_net_total_leverage__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (greater). title: Marketed Net Total Leverage Gt - description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (greater_or_equal). in: query name: marketed_net_total_leverage__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (greater_or_equal). title: Marketed Net Total Leverage Gte - description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (less). in: query name: marketed_net_total_leverage__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (less). title: Marketed Net Total Leverage Lt - description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (less_or_equal). in: query name: marketed_net_total_leverage__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_net_total_leverage range overlaps the window bounded by this value (less_or_equal). title: Marketed Net Total Leverage Lte - description: Filter marketed_net_total_leverage to rows where the value is NULL (true) or is not NULL (false). in: query name: marketed_net_total_leverage__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter marketed_net_total_leverage to rows where the value is NULL (true) or is not NULL (false). title: Marketed Net Total Leverage Isnull - description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (equal). in: query name: marketed_interest_coverage__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (equal). title: Marketed Interest Coverage Eq - description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (greater). in: query name: marketed_interest_coverage__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (greater). title: Marketed Interest Coverage Gt - description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (greater_or_equal). in: query name: marketed_interest_coverage__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (greater_or_equal). title: Marketed Interest Coverage Gte - description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (less). in: query name: marketed_interest_coverage__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (less). title: Marketed Interest Coverage Lt - description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (less_or_equal). in: query name: marketed_interest_coverage__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the marketed_interest_coverage range overlaps the window bounded by this value (less_or_equal). title: Marketed Interest Coverage Lte - description: Filter marketed_interest_coverage to rows where the value is NULL (true) or is not NULL (false). in: query name: marketed_interest_coverage__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter marketed_interest_coverage to rows where the value is NULL (true) or is not NULL (false). title: Marketed Interest Coverage Isnull - description: Filter cov_lite where the value is equal to the given value. in: query name: cov_lite__eq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter cov_lite where the value is equal to the given value. title: Cov Lite Eq - description: Filter cov_lite where the value is not equal to the given value. in: query name: cov_lite__neq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter cov_lite where the value is not equal to the given value. title: Cov Lite Neq - description: Filter cov_lite to rows where the value is NULL (true) or is not NULL (false). in: query name: cov_lite__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter cov_lite to rows where the value is NULL (true) or is not NULL (false). title: Cov Lite Isnull - description: Filter portability where the value is equal to the given value. in: query name: portability__eq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter portability where the value is equal to the given value. title: Portability Eq - description: Filter portability where the value is not equal to the given value. in: query name: portability__neq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter portability where the value is not equal to the given value. title: Portability Neq - description: Filter portability to rows where the value is NULL (true) or is not NULL (false). in: query name: portability__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter portability to rows where the value is NULL (true) or is not NULL (false). title: Portability Isnull - description: Filter currency where the value is equal to the given value. in: query name: currency__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter currency where the value is equal to the given value. title: Currency Eq - description: Filter currency where the value is not equal to the given value. in: query name: currency__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter currency where the value is not equal to the given value. title: Currency Neq - description: Filter currency where the value contains the given value. in: query name: currency__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter currency where the value contains the given value. title: Currency Contains - description: Filter currency where the value is in the given list. in: query name: currency__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter currency where the value is in the given list. title: Currency In - description: Filter currency to rows where the value is NULL (true) or is not NULL (false). in: query name: currency__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter currency to rows where the value is NULL (true) or is not NULL (false). title: Currency Isnull - description: Filter where the amount range overlaps the window bounded by this value (equal). in: query name: amount__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the amount range overlaps the window bounded by this value (equal). title: Amount Eq - description: Filter where the amount range overlaps the window bounded by this value (greater). in: query name: amount__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the amount range overlaps the window bounded by this value (greater). title: Amount Gt - description: Filter where the amount range overlaps the window bounded by this value (greater_or_equal). in: query name: amount__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the amount range overlaps the window bounded by this value (greater_or_equal). title: Amount Gte - description: Filter where the amount range overlaps the window bounded by this value (less). in: query name: amount__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the amount range overlaps the window bounded by this value (less). title: Amount Lt - description: Filter where the amount range overlaps the window bounded by this value (less_or_equal). in: query name: amount__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the amount range overlaps the window bounded by this value (less_or_equal). title: Amount Lte - description: Filter amount to rows where the value is NULL (true) or is not NULL (false). in: query name: amount__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter amount to rows where the value is NULL (true) or is not NULL (false). title: Amount Isnull - description: Filter where the margin range overlaps the window bounded by this value (equal). in: query name: margin__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the margin range overlaps the window bounded by this value (equal). title: Margin Eq - description: Filter where the margin range overlaps the window bounded by this value (greater). in: query name: margin__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the margin range overlaps the window bounded by this value (greater). title: Margin Gt - description: Filter where the margin range overlaps the window bounded by this value (greater_or_equal). in: query name: margin__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the margin range overlaps the window bounded by this value (greater_or_equal). title: Margin Gte - description: Filter where the margin range overlaps the window bounded by this value (less). in: query name: margin__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the margin range overlaps the window bounded by this value (less). title: Margin Lt - description: Filter where the margin range overlaps the window bounded by this value (less_or_equal). in: query name: margin__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the margin range overlaps the window bounded by this value (less_or_equal). title: Margin Lte - description: Filter margin to rows where the value is NULL (true) or is not NULL (false). in: query name: margin__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter margin to rows where the value is NULL (true) or is not NULL (false). title: Margin Isnull - description: Filter type where the value is equal to the given value. in: query name: type__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter type where the value is equal to the given value. title: Type Eq - description: Filter type where the value is not equal to the given value. in: query name: type__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter type where the value is not equal to the given value. title: Type Neq - description: Filter type where the value contains the given value. in: query name: type__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter type where the value contains the given value. title: Type Contains - description: Filter type where the value is in the given list. in: query name: type__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter type where the value is in the given list. title: Type In - description: Filter type to rows where the value is NULL (true) or is not NULL (false). in: query name: type__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter type to rows where the value is NULL (true) or is not NULL (false). title: Type Isnull - description: Filter where the maturity range overlaps the window bounded by this value (equal). in: query name: maturity__eq required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the maturity range overlaps the window bounded by this value (equal). title: Maturity Eq - description: Filter where the maturity range overlaps the window bounded by this value (greater). in: query name: maturity__gt required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the maturity range overlaps the window bounded by this value (greater). title: Maturity Gt - description: Filter where the maturity range overlaps the window bounded by this value (greater_or_equal). in: query name: maturity__gte required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the maturity range overlaps the window bounded by this value (greater_or_equal). title: Maturity Gte - description: Filter where the maturity range overlaps the window bounded by this value (less). in: query name: maturity__lt required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the maturity range overlaps the window bounded by this value (less). title: Maturity Lt - description: Filter where the maturity range overlaps the window bounded by this value (less_or_equal). in: query name: maturity__lte required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the maturity range overlaps the window bounded by this value (less_or_equal). title: Maturity Lte - description: Filter maturity to rows where the value is NULL (true) or is not NULL (false). in: query name: maturity__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter maturity to rows where the value is NULL (true) or is not NULL (false). title: Maturity Isnull - description: Filter where the issue_date range overlaps the window bounded by this value (equal). in: query name: issue_date__eq required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the issue_date range overlaps the window bounded by this value (equal). title: Issue Date Eq - description: Filter where the issue_date range overlaps the window bounded by this value (greater). in: query name: issue_date__gt required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the issue_date range overlaps the window bounded by this value (greater). title: Issue Date Gt - description: Filter where the issue_date range overlaps the window bounded by this value (greater_or_equal). in: query name: issue_date__gte required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the issue_date range overlaps the window bounded by this value (greater_or_equal). title: Issue Date Gte - description: Filter where the issue_date range overlaps the window bounded by this value (less). in: query name: issue_date__lt required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the issue_date range overlaps the window bounded by this value (less). title: Issue Date Lt - description: Filter where the issue_date range overlaps the window bounded by this value (less_or_equal). in: query name: issue_date__lte required: false schema: anyOf: - format: date type: string - type: "null" default: null description: Filter where the issue_date range overlaps the window bounded by this value (less_or_equal). title: Issue Date Lte - description: Filter issue_date to rows where the value is NULL (true) or is not NULL (false). in: query name: issue_date__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter issue_date to rows where the value is NULL (true) or is not NULL (false). title: Issue Date Isnull - description: Filter where the issue_price range overlaps the window bounded by this value (equal). in: query name: issue_price__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the issue_price range overlaps the window bounded by this value (equal). title: Issue Price Eq - description: Filter where the issue_price range overlaps the window bounded by this value (greater). in: query name: issue_price__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the issue_price range overlaps the window bounded by this value (greater). title: Issue Price Gt - description: Filter where the issue_price range overlaps the window bounded by this value (greater_or_equal). in: query name: issue_price__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the issue_price range overlaps the window bounded by this value (greater_or_equal). title: Issue Price Gte - description: Filter where the issue_price range overlaps the window bounded by this value (less). in: query name: issue_price__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the issue_price range overlaps the window bounded by this value (less). title: Issue Price Lt - description: Filter where the issue_price range overlaps the window bounded by this value (less_or_equal). in: query name: issue_price__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the issue_price range overlaps the window bounded by this value (less_or_equal). title: Issue Price Lte - description: Filter issue_price to rows where the value is NULL (true) or is not NULL (false). in: query name: issue_price__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter issue_price to rows where the value is NULL (true) or is not NULL (false). title: Issue Price Isnull - description: Filter where the purpose array contains this value. in: query name: purpose__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter where the purpose array contains this value. title: Purpose Contains - description: Filter purpose to rows where the value is NULL (true) or is not NULL (false). in: query name: purpose__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter purpose to rows where the value is NULL (true) or is not NULL (false). title: Purpose Isnull - description: Filter where the tenor range overlaps the window bounded by this value (equal). in: query name: tenor__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the tenor range overlaps the window bounded by this value (equal). title: Tenor Eq - description: Filter where the tenor range overlaps the window bounded by this value (greater). in: query name: tenor__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the tenor range overlaps the window bounded by this value (greater). title: Tenor Gt - description: Filter where the tenor range overlaps the window bounded by this value (greater_or_equal). in: query name: tenor__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the tenor range overlaps the window bounded by this value (greater_or_equal). title: Tenor Gte - description: Filter where the tenor range overlaps the window bounded by this value (less). in: query name: tenor__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the tenor range overlaps the window bounded by this value (less). title: Tenor Lt - description: Filter where the tenor range overlaps the window bounded by this value (less_or_equal). in: query name: tenor__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the tenor range overlaps the window bounded by this value (less_or_equal). title: Tenor Lte - description: Filter tenor to rows where the value is NULL (true) or is not NULL (false). in: query name: tenor__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter tenor to rows where the value is NULL (true) or is not NULL (false). title: Tenor Isnull - description: Filter status where the value is equal to the given value. in: query name: status__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter status where the value is equal to the given value. title: Status Eq - description: Filter status where the value is not equal to the given value. in: query name: status__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter status where the value is not equal to the given value. title: Status Neq - description: Filter status where the value contains the given value. in: query name: status__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter status where the value contains the given value. title: Status Contains - description: Filter status where the value is in the given list. in: query name: status__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter status where the value is in the given list. title: Status In - description: Filter issuer_entity where the value is equal to the given value. in: query name: issuer_entity__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter issuer_entity where the value is equal to the given value. title: Issuer Entity Eq - description: Filter issuer_entity where the value is not equal to the given value. in: query name: issuer_entity__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter issuer_entity where the value is not equal to the given value. title: Issuer Entity Neq - description: Filter issuer_entity where the value contains the given value. in: query name: issuer_entity__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter issuer_entity where the value contains the given value. title: Issuer Entity Contains - description: Filter issuer_entity where the value is in the given list. in: query name: issuer_entity__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter issuer_entity where the value is in the given list. title: Issuer Entity In - description: Filter issuer_country where the value is equal to the given value. in: query name: issuer_country__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter issuer_country where the value is equal to the given value. title: Issuer Country Eq - description: Filter issuer_country where the value is not equal to the given value. in: query name: issuer_country__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter issuer_country where the value is not equal to the given value. title: Issuer Country Neq - description: Filter issuer_country where the value contains the given value. in: query name: issuer_country__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter issuer_country where the value contains the given value. title: Issuer Country Contains - description: Filter issuer_country where the value is in the given list. in: query name: issuer_country__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter issuer_country where the value is in the given list. title: Issuer Country In - description: Filter issuer_country to rows where the value is NULL (true) or is not NULL (false). in: query name: issuer_country__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter issuer_country to rows where the value is NULL (true) or is not NULL (false). title: Issuer Country Isnull - description: Filter borrower_legal_advisor where the value is equal to the given value. in: query name: borrower_legal_advisor__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter borrower_legal_advisor where the value is equal to the given value. title: Borrower Legal Advisor Eq - description: Filter borrower_legal_advisor where the value is not equal to the given value. in: query name: borrower_legal_advisor__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter borrower_legal_advisor where the value is not equal to the given value. title: Borrower Legal Advisor Neq - description: Filter borrower_legal_advisor where the value contains the given value. in: query name: borrower_legal_advisor__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter borrower_legal_advisor where the value contains the given value. title: Borrower Legal Advisor Contains - description: Filter borrower_legal_advisor where the value is in the given list. in: query name: borrower_legal_advisor__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter borrower_legal_advisor where the value is in the given list. title: Borrower Legal Advisor In - description: Filter lender_legal_advisor where the value is equal to the given value. in: query name: lender_legal_advisor__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter lender_legal_advisor where the value is equal to the given value. title: Lender Legal Advisor Eq - description: Filter lender_legal_advisor where the value is not equal to the given value. in: query name: lender_legal_advisor__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter lender_legal_advisor where the value is not equal to the given value. title: Lender Legal Advisor Neq - description: Filter lender_legal_advisor where the value contains the given value. in: query name: lender_legal_advisor__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter lender_legal_advisor where the value contains the given value. title: Lender Legal Advisor Contains - description: Filter lender_legal_advisor where the value is in the given list. in: query name: lender_legal_advisor__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter lender_legal_advisor where the value is in the given list. title: Lender Legal Advisor In - description: Filter where the pik_coupon range overlaps the window bounded by this value (equal). in: query name: pik_coupon__eq required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the pik_coupon range overlaps the window bounded by this value (equal). title: Pik Coupon Eq - description: Filter where the pik_coupon range overlaps the window bounded by this value (greater). in: query name: pik_coupon__gt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the pik_coupon range overlaps the window bounded by this value (greater). title: Pik Coupon Gt - description: Filter where the pik_coupon range overlaps the window bounded by this value (greater_or_equal). in: query name: pik_coupon__gte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the pik_coupon range overlaps the window bounded by this value (greater_or_equal). title: Pik Coupon Gte - description: Filter where the pik_coupon range overlaps the window bounded by this value (less). in: query name: pik_coupon__lt required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the pik_coupon range overlaps the window bounded by this value (less). title: Pik Coupon Lt - description: Filter where the pik_coupon range overlaps the window bounded by this value (less_or_equal). in: query name: pik_coupon__lte required: false schema: anyOf: - type: number - type: "null" default: null description: Filter where the pik_coupon range overlaps the window bounded by this value (less_or_equal). title: Pik Coupon Lte - description: Filter pik_coupon to rows where the value is NULL (true) or is not NULL (false). in: query name: pik_coupon__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter pik_coupon to rows where the value is NULL (true) or is not NULL (false). title: Pik Coupon Isnull - description: Filter sponsor where the value is equal to the given value. in: query name: sponsor__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter sponsor where the value is equal to the given value. title: Sponsor Eq - description: Filter sponsor where the value is not equal to the given value. in: query name: sponsor__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter sponsor where the value is not equal to the given value. title: Sponsor Neq - description: Filter sponsor where the value contains the given value. in: query name: sponsor__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter sponsor where the value contains the given value. title: Sponsor Contains - description: Filter sponsor where the value is in the given list. in: query name: sponsor__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter sponsor where the value is in the given list. title: Sponsor In - description: Filter borrower_advisor where the value is equal to the given value. in: query name: borrower_advisor__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter borrower_advisor where the value is equal to the given value. title: Borrower Advisor Eq - description: Filter borrower_advisor where the value is not equal to the given value. in: query name: borrower_advisor__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter borrower_advisor where the value is not equal to the given value. title: Borrower Advisor Neq - description: Filter borrower_advisor where the value contains the given value. in: query name: borrower_advisor__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter borrower_advisor where the value contains the given value. title: Borrower Advisor Contains - description: Filter borrower_advisor where the value is in the given list. in: query name: borrower_advisor__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter borrower_advisor where the value is in the given list. title: Borrower Advisor In - description: Filter lender_advisor where the value is equal to the given value. in: query name: lender_advisor__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter lender_advisor where the value is equal to the given value. title: Lender Advisor Eq - description: Filter lender_advisor where the value is not equal to the given value. in: query name: lender_advisor__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter lender_advisor where the value is not equal to the given value. title: Lender Advisor Neq - description: Filter lender_advisor where the value contains the given value. in: query name: lender_advisor__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter lender_advisor where the value contains the given value. title: Lender Advisor Contains - description: Filter lender_advisor where the value is in the given list. in: query name: lender_advisor__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter lender_advisor where the value is in the given list. title: Lender Advisor In - description: Filter benchmark where the value is equal to the given value. in: query name: benchmark__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter benchmark where the value is equal to the given value. title: Benchmark Eq - description: Filter benchmark where the value is not equal to the given value. in: query name: benchmark__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter benchmark where the value is not equal to the given value. title: Benchmark Neq - description: Filter benchmark where the value contains the given value. in: query name: benchmark__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter benchmark where the value contains the given value. title: Benchmark Contains - description: Filter benchmark where the value is in the given list. in: query name: benchmark__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter benchmark where the value is in the given list. title: Benchmark In - description: Filter benchmark to rows where the value is NULL (true) or is not NULL (false). in: query name: benchmark__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter benchmark to rows where the value is NULL (true) or is not NULL (false). title: Benchmark Isnull - description: Filter is_add_on where the value is equal to the given value. in: query name: is_add_on__eq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter is_add_on where the value is equal to the given value. title: Is Add On Eq - description: Filter is_add_on where the value is not equal to the given value. in: query name: is_add_on__neq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter is_add_on where the value is not equal to the given value. title: Is Add On Neq - description: Filter is_add_on to rows where the value is NULL (true) or is not NULL (false). in: query name: is_add_on__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter is_add_on to rows where the value is NULL (true) or is not NULL (false). title: Is Add On Isnull - description: Filter governing_law where the value is equal to the given value. in: query name: governing_law__eq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter governing_law where the value is equal to the given value. title: Governing Law Eq - description: Filter governing_law where the value is not equal to the given value. in: query name: governing_law__neq required: false schema: anyOf: - type: string - type: "null" default: null description: Filter governing_law where the value is not equal to the given value. title: Governing Law Neq - description: Filter governing_law where the value contains the given value. in: query name: governing_law__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter governing_law where the value contains the given value. title: Governing Law Contains - description: Filter governing_law where the value is in the given list. in: query name: governing_law__in required: false schema: anyOf: - type: string - type: "null" default: null description: Filter governing_law where the value is in the given list. title: Governing Law In - description: Filter governing_law to rows where the value is NULL (true) or is not NULL (false). in: query name: governing_law__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter governing_law to rows where the value is NULL (true) or is not NULL (false). title: Governing Law Isnull - description: Filter is_redeemed where the value is equal to the given value. in: query name: is_redeemed__eq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter is_redeemed where the value is equal to the given value. title: Is Redeemed Eq - description: Filter is_redeemed where the value is not equal to the given value. in: query name: is_redeemed__neq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter is_redeemed where the value is not equal to the given value. title: Is Redeemed Neq - description: Filter is_redeemed to rows where the value is NULL (true) or is not NULL (false). in: query name: is_redeemed__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter is_redeemed to rows where the value is NULL (true) or is not NULL (false). title: Is Redeemed Isnull - description: Filter where the lenders array contains this value. in: query name: lenders__contains required: false schema: anyOf: - type: string - type: "null" default: null description: Filter where the lenders array contains this value. title: Lenders Contains - description: Filter lenders to rows where the value is NULL (true) or is not NULL (false). in: query name: lenders__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter lenders to rows where the value is NULL (true) or is not NULL (false). title: Lenders Isnull - description: Filter is_sustainability_linked where the value is equal to the given value. in: query name: is_sustainability_linked__eq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter is_sustainability_linked where the value is equal to the given value. title: Is Sustainability Linked Eq - description: Filter is_sustainability_linked where the value is not equal to the given value. in: query name: is_sustainability_linked__neq required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter is_sustainability_linked where the value is not equal to the given value. title: Is Sustainability Linked Neq - description: Filter is_sustainability_linked to rows where the value is NULL (true) or is not NULL (false). in: query name: is_sustainability_linked__isnull required: false schema: anyOf: - type: boolean - type: "null" default: null description: Filter is_sustainability_linked to rows where the value is NULL (true) or is not NULL (false). title: Is Sustainability Linked Isnull responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstrumentsResponse" description: Successful Response "400": content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" description: Bad request (e.g. invalid cursor). "422": content: application/json: schema: $ref: "#/components/schemas/HTTPValidationError" description: Validation Error "500": content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" description: Unexpected server error. "503": content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" description: Service unavailable (e.g. database down). security: - HTTPBearer: [] summary: PCRED Instrument List tags: - Instrument security: - HTTPBearer: [] components: schemas: InstrumentsResponse: properties: items: description: Instruments the fit the provided filter criteria. items: $ref: "#/components/schemas/Instrument" title: Items type: array next_cursor: anyOf: - type: string - type: "null" description: Cursor to pass in the next request to fetch the next page of instruments title: Next Cursor total_count: description: Total count of all items the match the provided filter criteria. title: Total Count type: integer required: - items - next_cursor - total_count title: InstrumentsResponse type: object ErrorResponse: description: Client-facing error envelope. examples: - error_code: invalid_cursor message: The supplied cursor could not be decoded. trace_id: 202bde256c7d446f9623efdc96286c5d - error_code: service_unavailable message: Database is not available trace_id: c2416d52c6d14c8e831aad792407442c properties: error_code: title: Error Code type: string message: title: Message type: string trace_id: anyOf: - type: string - type: "null" title: Trace Id required: - error_code - message title: ErrorResponse type: object HTTPValidationError: properties: detail: items: $ref: "#/components/schemas/ValidationError" title: Detail type: array title: HTTPValidationError type: object InternalServerErrorResponse: properties: error_code: examples: - internal_server_error title: Error Code type: string message: examples: - An unexpected error occurred. title: Message type: string trace_id: anyOf: - type: string - type: "null" examples: - e7dfd20231374d308f04655eb0538be4 title: Trace Id required: - error_code - message - trace_id title: InternalServerErrorResponse type: object Instrument: properties: amount: anyOf: - $ref: "#/components/schemas/CurrencyRange" - type: "null" description: Principal amount of the instrument, with values converted across currencies and expressed as a range. benchmark: anyOf: - type: string - type: "null" description: Reference benchmark rate the margin is set over (e.g. SOFR, EURIBOR). title: Benchmark borrower_advisors: anyOf: - items: $ref: "#/components/schemas/Advisor" type: array - type: "null" description: Non-legal advisers (e.g. financial or M&A advisers) acting for the borrower. title: Borrower Advisors borrower_legal_advisor: anyOf: - $ref: "#/components/schemas/LegalAdvisor" - type: "null" description: Law firm advising the borrower on the financing. company: anyOf: - $ref: "#/components/schemas/Company" - type: "null" description: The borrowing company that the instrument finances. cov_lite: anyOf: - type: boolean - type: "null" description: Whether the instrument is covenant-lite (lacks maintenance covenants). title: Cov Lite currency: anyOf: - $ref: "#/components/schemas/Currency" - type: "null" description: Currency in which the instrument is denominated. debt_purpose: anyOf: - items: type: string type: array - type: "null" description: Intended use(s) of proceeds (e.g. acquisition, refinancing, dividend recap). title: Debt Purpose debt_security: anyOf: - $ref: "#/components/schemas/DebtSecurity" - type: "null" description: Type of debt security (e.g. term loan, senior secured notes). governing_law: anyOf: - type: string - type: "null" description: Jurisdiction whose law governs the instrument's documentation. title: Governing Law is_green: anyOf: - type: boolean - type: "null" description: Whether the instrument is a green financing (proceeds earmarked for environmental projects). title: Is Green is_sponsor_deal: anyOf: - type: boolean - type: "null" description: Whether the financing backs a private-equity-sponsored borrower. title: Is Sponsor Deal is_sustainability_linked: anyOf: - type: boolean - type: "null" description: Whether the instrument's terms are linked to sustainability performance targets. title: Is Sustainability Linked is_tap_deal: anyOf: - type: boolean - type: "null" description: Whether the instrument is a tap (an add-on to an existing issuance). title: Is Tap Deal issue_date: anyOf: - $ref: "#/components/schemas/DateRange" - type: "null" description: Date the instrument was issued, expressed as a range to reflect uncertainty or marketed windows. issue_price: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Issue price as a percentage of par, expressed as a range. issuer_entity: anyOf: - $ref: "#/components/schemas/IssuerEntity" - type: "null" description: Legal entity that issues or borrows under the instrument. lender_advisors: anyOf: - items: $ref: "#/components/schemas/Advisor" type: array - type: "null" description: Non-legal advisers (e.g. financial or M&A advisers) acting for the lender(s). title: Lender Advisors lender_legal_advisor: anyOf: - $ref: "#/components/schemas/LegalAdvisor" - type: "null" description: Law firm advising the lender(s) on the financing. lenders: anyOf: - items: type: string type: array - type: "null" description: Names of the lenders providing the financing. title: Lenders margin: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Interest margin (spread) over the benchmark rate, in basis points, expressed as a range. marketed_capex: anyOf: - $ref: "#/components/schemas/CurrencyRange" - type: "null" description: Capital expenditure figure marketed to lenders, with values converted across currencies and expressed as a range. marketed_capex_as_percentage_of_sales: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Marketed capital expenditure as a percentage of sales, expressed as a range. marketed_ebitda: anyOf: - $ref: "#/components/schemas/CurrencyRange" - type: "null" description: EBITDA figure marketed to lenders, with values converted across currencies and expressed as a range. marketed_ebitda_as_percentage_of_margin: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Marketed EBITDA margin (EBITDA as a percentage of sales), expressed as a range. marketed_interest_coverage: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Marketed interest coverage ratio (EBITDA / interest expense), expressed as a range. marketed_sales: anyOf: - $ref: "#/components/schemas/CurrencyRange" - type: "null" description: Sales/revenue figure marketed to lenders, with values converted across currencies and expressed as a range. marketed_senior_gross_leverage: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Marketed senior gross leverage multiple (senior debt / EBITDA), expressed as a range. marketed_senior_net_leverage: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Marketed senior net leverage multiple (senior debt net of cash / EBITDA), expressed as a range. marketed_total_gross_leverage: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Marketed total gross leverage multiple (total debt / EBITDA), expressed as a range. marketed_total_net_leverage: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Marketed total net leverage multiple (total debt net of cash / EBITDA), expressed as a range. maturity: anyOf: - $ref: "#/components/schemas/DateRange" - type: "null" description: Date the instrument matures, expressed as a range to reflect uncertainty or marketed windows. nf_id: description: 9Fin ID for this instrument. Unique for all instruments and across APIs. title: Nf Id type: string pik_coupon: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Payment-in-kind (PIK) coupon rate, expressed as a range. portability: anyOf: - type: boolean - type: "null" description: Whether the debt is portable (can survive a change of control of the borrower). title: Portability redeemed: anyOf: - type: boolean - type: "null" description: Whether the instrument has been redeemed/repaid. title: Redeemed reporting_period_currency: anyOf: - $ref: "#/components/schemas/Currency" - type: "null" description: Currency in which the issuer's reported financials are expressed. reporting_period_date: anyOf: - format: date type: string - type: "null" description: End date of the financial reporting period the marketed figures relate to. title: Reporting Period Date reporting_type: anyOf: - type: string - type: "null" description: Type of financial reporting the marketed figures are based on (e.g. last twelve months, annual). title: Reporting Type sources: anyOf: - items: type: string type: array - type: "null" description: Sources from which the instrument's data was obtained. title: Sources sponsors: anyOf: - items: $ref: "#/components/schemas/Sponsor" type: array - type: "null" description: Private equity sponsor(s) backing the borrower, where applicable. title: Sponsors status: anyOf: - type: string - type: "null" description: Current lifecycle status of the instrument (e.g. announced, priced, closed). title: Status tenor: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Tenor of the instrument in years, expressed as a range. required: - nf_id - borrower_legal_advisor - lender_legal_advisor - borrower_advisors - lender_advisors - company - currency - debt_security - governing_law - status - issuer_entity - reporting_period_currency - reporting_type - debt_purpose - sponsors - issue_date - maturity - amount - marketed_capex - marketed_ebitda - marketed_sales - issue_price - margin - marketed_interest_coverage - marketed_senior_gross_leverage - marketed_senior_net_leverage - marketed_total_gross_leverage - marketed_total_net_leverage - marketed_ebitda_as_percentage_of_margin - marketed_capex_as_percentage_of_sales - pik_coupon - tenor - benchmark - cov_lite - is_green - is_sustainability_linked - lenders - portability - redeemed - reporting_period_date - sources - is_sponsor_deal - is_tap_deal title: Instrument type: object ValidationError: properties: ctx: title: Context type: object input: title: Input loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object CurrencyRange: description: >- A monetary value as a range, converted into each major currency. The same underlying amount is provided in EUR, GBP and USD for convenience, alongside the original currency and value as reported. properties: eur: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Value converted to euros, expressed as a range. gbp: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Value converted to pounds sterling, expressed as a range. original_currency: anyOf: - $ref: "#/components/schemas/Currency" - type: "null" description: Currency the value was originally reported in. original_value: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Value in the original reporting currency, expressed as a range. usd: anyOf: - $ref: "#/components/schemas/FloatRange" - type: "null" description: Value converted to US dollars, expressed as a range. required: - eur - gbp - usd - original_currency - original_value title: CurrencyRange type: object Advisor: properties: full_name: description: Full legal name of the advisory firm. title: Full Name type: string short_name: description: Abbreviated or commonly used name of the advisory firm. title: Short Name type: string street_name: description: Name commonly used to identify the advisory firm. title: Street Name type: string required: - street_name - full_name - short_name title: Advisor type: object LegalAdvisor: properties: full_name: description: Full legal name of the law firm. title: Full Name type: string short_name: description: Abbreviated or commonly used name of the law firm. title: Short Name type: string street_name: description: Name commonly used to identify the law firm. title: Street Name type: string required: - street_name - full_name - short_name title: LegalAdvisor type: object Company: properties: alias: anyOf: - items: type: string type: array - type: "null" description: Alternative names the company is also known by. title: Alias cik: anyOf: - type: integer - type: "null" description: SEC Central Index Key (CIK) identifying the company in SEC filings. title: Cik country_of_risk: description: Country to which the company's credit risk is primarily attributed. title: Country Of Risk type: string description: anyOf: - type: string - type: "null" description: Free-text description of the company and its business. title: Description full_name: description: Full legal name of the company. title: Full Name type: string industry: anyOf: - $ref: "#/components/schemas/Industry" - type: "null" description: Hierarchical industry classification of the company. nf_id: description: 9Fin ID for this company. Unique for all companies and across APIs. title: Nf Id type: string street_name: description: Name commonly used to identify the company. title: Street Name type: string website: anyOf: - format: uri minLength: 1 type: string - type: "null" description: URL of the company's website. title: Website required: - nf_id - street_name - full_name - country_of_risk - description - industry - website - cik - alias title: Company type: object Currency: properties: code: description: ISO 4217 currency code (e.g. EUR, GBP, USD). title: Code type: string name: description: Human-readable currency name. title: Name type: string required: - code - name title: Currency type: object DebtSecurity: properties: abbreviation: description: Common abbreviation for the debt security type (e.g. TLB). title: Abbreviation type: string name: description: Full name of the debt security type (e.g. Term Loan B). title: Name type: string type: $ref: "#/components/schemas/DebtType" description: Interest-rate type of the security (fixed, floating, or N/A). required: - name - abbreviation - type title: DebtSecurity type: object DateRange: description: >- A date expressed as a (possibly open-ended) range. Used where a date is only known to fall within a window rather than on an exact day. properties: lower: anyOf: - format: date type: string - type: "null" description: Earliest date in the range; null if unbounded below. title: Lower lower_inclusive: description: Whether the lower bound is inclusive. title: Lower Inclusive type: boolean upper: anyOf: - format: date type: string - type: "null" description: Latest date in the range; null if unbounded above. title: Upper upper_inclusive: description: Whether the upper bound is inclusive. title: Upper Inclusive type: boolean required: - upper - lower - upper_inclusive - lower_inclusive title: DateRange type: object FloatRange: description: >- A numeric value expressed as a (possibly open-ended) range. Marketed metrics are frequently disclosed as ranges rather than exact figures, so values are represented by their bounds and whether each bound is inclusive. properties: lower: anyOf: - type: number - type: "null" description: Lower bound of the range; null if unbounded below. title: Lower lower_inclusive: description: Whether the lower bound is inclusive. title: Lower Inclusive type: boolean upper: anyOf: - type: number - type: "null" description: Upper bound of the range; null if unbounded above. title: Upper upper_inclusive: description: Whether the upper bound is inclusive. title: Upper Inclusive type: boolean required: - upper - lower - upper_inclusive - lower_inclusive title: FloatRange type: object IssuerEntity: properties: company: anyOf: - $ref: "#/components/schemas/Company" - type: "null" description: The parent company associated with the issuer entity. name: description: Name of the issuing/borrowing legal entity. title: Name type: string required: - name - company title: IssuerEntity type: object Sponsor: properties: full_name: description: Full legal name of the private equity sponsor. title: Full Name type: string short_name: description: Abbreviated or commonly used name of the sponsor. title: Short Name type: string street_name: description: Name commonly used to identify the sponsor. title: Street Name type: string website: anyOf: - format: uri minLength: 1 type: string - type: "null" description: URL of the sponsor's website. title: Website required: - street_name - full_name - short_name - website title: Sponsor type: object Industry: properties: level_1: description: Top-level (broadest) industry classification. title: Level 1 type: string level_2: description: Second-level industry classification, nested under level 1. title: Level 2 type: string level_3: description: Third-level (most granular) industry classification, nested under level 2. title: Level 3 type: string required: - level_1 - level_2 - level_3 title: Industry type: object DebtType: enum: - fixed - floating - N/A title: DebtType type: string securitySchemes: HTTPBearer: bearerFormat: JWT scheme: bearer type: http ```