--- title: "9fin Instruments (Bonds & Loans) API" url: "https://console.9fin.com/apis/instruments-bonds-and-loans/versions/b44d153f-c159-4311-9d98-5a5ab2608aa6" --- # 9fin Instruments (Bonds & Loans) API OpenAPI specification document. ```json {"components":{"schemas":{"ErrorDetail":{"description":"One field-level problem within an error response.","properties":{"field":{"examples":["limit"],"title":"Field","type":"string"},"message":{"examples":["Input should be less than or equal to 200"],"title":"Message","type":"string"}},"required":["field","message"],"title":"ErrorDetail","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"},{"details":[{"field":"limit","message":"Input should be less than or equal to 200"}],"error_code":"validation_error","message":"Request validation failed","trace_id":"5cc0f4dd4a0a4b7fa0b3b0f2b4f9a1c7"}],"properties":{"details":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorDetail"},"type":"array"},{"type":"null"}],"title":"Details"},"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"},"InstrumentListSchema":{"description":"Public-facing list of instruments.","properties":{"items":{"items":{"$ref":"#/components/schemas/InstrumentSchema"},"title":"Items","type":"array"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"required":["items","next_cursor"],"title":"InstrumentListSchema","type":"object"},"InstrumentSchema":{"description":"Public-facing subset of an instrument.","properties":{"amount":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Amount"},"benchmark":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benchmark"},"bookrunner_legal_advisor_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bookrunner Legal Advisor Id"},"company_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Company Id"},"country_ref_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Ref Name"},"coupon":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Coupon"},"currency_ref_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Ref Code"},"deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"},"debt_security_ref_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Debt Security Ref Name"},"entity_nf_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Nf Id"},"grade":{"items":{"type":"string"},"title":"Grade","type":"array"},"instrument_status_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instrument Status Name"},"instrument_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instrument Type"},"issue_date":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"title":"Issue Date"},"issuer_entity_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Issuer Entity Id"},"maturity":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"title":"Maturity"},"nf_id":{"title":"Nf Id","type":"string"},"other_figi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Other Figi"},"other_isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Other Isin"},"price_date":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"title":"Price Date"},"purpose":{"items":{"type":"string"},"title":"Purpose","type":"array"},"redeemed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Redeemed"},"reg_144a_figi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reg 144A Figi"},"reg_144a_isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reg 144A Isin"},"reg_s_figi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reg S Figi"},"reg_s_isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reg S Isin"},"tap_deal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tap Deal"},"tranche_seq":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tranche Seq"}},"required":["nf_id","instrument_type","amount","entity_nf_id","company_id","country_ref_name","coupon","currency_ref_code","deal_id","tranche_seq","debt_security_ref_name","reg_144a_isin","reg_s_isin","other_isin","reg_144a_figi","reg_s_figi","other_figi","instrument_status_name","price_date","issue_date","issuer_entity_id","maturity","redeemed","grade","tap_deal","purpose","bookrunner_legal_advisor_id","benchmark"],"title":"InstrumentSchema","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"}},"securitySchemes":{"HTTPBearer":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"info":{"description":"API to access 9fin Bonds & Loans Instruments,excluding any that are covered by a dedicated API (Private Credit, CLOs etc.)","title":"9fin Instruments (Bonds & Loans) API","version":"0.8.0"},"openapi":"3.1.0","paths":{"/v0/instruments/bonds-and-loans":{"get":{"description":"Returns a list of Bonds & Loans instruments.\nAllows for filtering and sorting by a variety of instrument attributes.","operationId":"list_instruments_v0_instruments_bonds_and_loans_get","parameters":[{"description":"Comma-separated list of `field__asc` / `field__desc` tokens applied in order, e.g. `company_name__desc,price__asc`. Sortable fields: nf_id, entity_nf_id, amount, coupon, price_date, issue_date, maturity, redeemed, tap_deal, reg_144a_isin, reg_s_isin, other_isin, reg_144a_figi, reg_s_figi, other_figi, instrument_type, country_ref_name, currency_ref_code, debt_security_ref_name, instrument_status_name, benchmark.","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: nf_id, entity_nf_id, amount, coupon, price_date, issue_date, maturity, redeemed, tap_deal, reg_144a_isin, reg_s_isin, other_isin, reg_144a_figi, reg_s_figi, other_figi, instrument_type, country_ref_name, currency_ref_code, debt_security_ref_name, instrument_status_name, benchmark.","title":"Sort By"}},{"description":"Maximum number of rows to return.","in":"query","name":"limit","required":false,"schema":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"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 nf_id where the value is equal to the given value.","in":"query","name":"nf_id__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter nf_id where the value is equal to the given value.","title":"Nf Id Eq"}},{"description":"Filter nf_id where the value is not equal to the given value.","in":"query","name":"nf_id__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter nf_id where the value is not equal to the given value.","title":"Nf Id Neq"}},{"description":"Filter nf_id where the value contains the given value.","in":"query","name":"nf_id__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter nf_id where the value contains the given value.","title":"Nf Id Contains"}},{"description":"Filter nf_id where the value is in the given list.","in":"query","name":"nf_id__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter nf_id where the value is in the given list.","title":"Nf Id In"}},{"description":"Filter entity_nf_id where the value is equal to the given value.","in":"query","name":"entity_nf_id__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter entity_nf_id where the value is equal to the given value.","title":"Entity Nf Id Eq"}},{"description":"Filter entity_nf_id where the value is not equal to the given value.","in":"query","name":"entity_nf_id__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter entity_nf_id where the value is not equal to the given value.","title":"Entity Nf Id Neq"}},{"description":"Filter entity_nf_id where the value contains the given value.","in":"query","name":"entity_nf_id__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter entity_nf_id where the value contains the given value.","title":"Entity Nf Id Contains"}},{"description":"Filter entity_nf_id where the value is in the given list.","in":"query","name":"entity_nf_id__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter entity_nf_id where the value is in the given list.","title":"Entity Nf Id In"}},{"description":"Filter entity_nf_id to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"entity_nf_id__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter entity_nf_id to rows where the value is NULL (true) or is not NULL (false).","title":"Entity Nf Id Isnull"}},{"description":"Filter amount where the value is equal to the given value.","in":"query","name":"amount__eq","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter amount where the value is equal to the given value.","title":"Amount Eq"}},{"description":"Filter amount where the value is not equal to the given value.","in":"query","name":"amount__neq","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter amount where the value is not equal to the given value.","title":"Amount Neq"}},{"description":"Filter amount where the value is greater than the given value.","in":"query","name":"amount__gt","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter amount where the value is greater than the given value.","title":"Amount Gt"}},{"description":"Filter amount where the value is greater or equal to the given value.","in":"query","name":"amount__gte","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter amount where the value is greater or equal to the given value.","title":"Amount Gte"}},{"description":"Filter amount where the value is less than the given value.","in":"query","name":"amount__lt","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter amount where the value is less than the given value.","title":"Amount Lt"}},{"description":"Filter amount where the value is less or equal to the given value.","in":"query","name":"amount__lte","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter amount where the value is less or equal to the given value.","title":"Amount Lte"}},{"description":"Filter amount where the value is in the given list.","in":"query","name":"amount__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter amount where the value is in the given list.","title":"Amount In"}},{"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 coupon where the value is equal to the given value.","in":"query","name":"coupon__eq","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter coupon where the value is equal to the given value.","title":"Coupon Eq"}},{"description":"Filter coupon where the value is not equal to the given value.","in":"query","name":"coupon__neq","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter coupon where the value is not equal to the given value.","title":"Coupon Neq"}},{"description":"Filter coupon where the value is greater than the given value.","in":"query","name":"coupon__gt","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter coupon where the value is greater than the given value.","title":"Coupon Gt"}},{"description":"Filter coupon where the value is greater or equal to the given value.","in":"query","name":"coupon__gte","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter coupon where the value is greater or equal to the given value.","title":"Coupon Gte"}},{"description":"Filter coupon where the value is less than the given value.","in":"query","name":"coupon__lt","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter coupon where the value is less than the given value.","title":"Coupon Lt"}},{"description":"Filter coupon where the value is less or equal to the given value.","in":"query","name":"coupon__lte","required":false,"schema":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"default":null,"description":"Filter coupon where the value is less or equal to the given value.","title":"Coupon Lte"}},{"description":"Filter coupon where the value is in the given list.","in":"query","name":"coupon__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter coupon where the value is in the given list.","title":"Coupon In"}},{"description":"Filter coupon to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"coupon__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter coupon to rows where the value is NULL (true) or is not NULL (false).","title":"Coupon Isnull"}},{"description":"Filter price_date where the value is equal to the given value.","in":"query","name":"price_date__eq","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter price_date where the value is equal to the given value.","title":"Price Date Eq"}},{"description":"Filter price_date where the value is not equal to the given value.","in":"query","name":"price_date__neq","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter price_date where the value is not equal to the given value.","title":"Price Date Neq"}},{"description":"Filter price_date where the value is greater than the given value.","in":"query","name":"price_date__gt","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter price_date where the value is greater than the given value.","title":"Price Date Gt"}},{"description":"Filter price_date where the value is greater or equal to the given value.","in":"query","name":"price_date__gte","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter price_date where the value is greater or equal to the given value.","title":"Price Date Gte"}},{"description":"Filter price_date where the value is less than the given value.","in":"query","name":"price_date__lt","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter price_date where the value is less than the given value.","title":"Price Date Lt"}},{"description":"Filter price_date where the value is less or equal to the given value.","in":"query","name":"price_date__lte","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter price_date where the value is less or equal to the given value.","title":"Price Date Lte"}},{"description":"Filter price_date where the value is in the given list.","in":"query","name":"price_date__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter price_date where the value is in the given list.","title":"Price Date In"}},{"description":"Filter price_date to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"price_date__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter price_date to rows where the value is NULL (true) or is not NULL (false).","title":"Price Date Isnull"}},{"description":"Filter issue_date where the value is equal to the given value.","in":"query","name":"issue_date__eq","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter issue_date where the value is equal to the given value.","title":"Issue Date Eq"}},{"description":"Filter issue_date where the value is not equal to the given value.","in":"query","name":"issue_date__neq","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter issue_date where the value is not equal to the given value.","title":"Issue Date Neq"}},{"description":"Filter issue_date where the value is greater than the given value.","in":"query","name":"issue_date__gt","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter issue_date where the value is greater than the given value.","title":"Issue Date Gt"}},{"description":"Filter issue_date where the value is greater or equal to the given value.","in":"query","name":"issue_date__gte","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter issue_date where the value is greater or equal to the given value.","title":"Issue Date Gte"}},{"description":"Filter issue_date where the value is less than the given value.","in":"query","name":"issue_date__lt","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter issue_date where the value is less than the given value.","title":"Issue Date Lt"}},{"description":"Filter issue_date where the value is less or equal to the given value.","in":"query","name":"issue_date__lte","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter issue_date where the value is less or equal to the given value.","title":"Issue Date Lte"}},{"description":"Filter issue_date where the value is in the given list.","in":"query","name":"issue_date__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter issue_date where the value is in the given list.","title":"Issue Date In"}},{"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 maturity where the value is equal to the given value.","in":"query","name":"maturity__eq","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter maturity where the value is equal to the given value.","title":"Maturity Eq"}},{"description":"Filter maturity where the value is not equal to the given value.","in":"query","name":"maturity__neq","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter maturity where the value is not equal to the given value.","title":"Maturity Neq"}},{"description":"Filter maturity where the value is greater than the given value.","in":"query","name":"maturity__gt","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter maturity where the value is greater than the given value.","title":"Maturity Gt"}},{"description":"Filter maturity where the value is greater or equal to the given value.","in":"query","name":"maturity__gte","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter maturity where the value is greater or equal to the given value.","title":"Maturity Gte"}},{"description":"Filter maturity where the value is less than the given value.","in":"query","name":"maturity__lt","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter maturity where the value is less than the given value.","title":"Maturity Lt"}},{"description":"Filter maturity where the value is less or equal to the given value.","in":"query","name":"maturity__lte","required":false,"schema":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}],"default":null,"description":"Filter maturity where the value is less or equal to the given value.","title":"Maturity Lte"}},{"description":"Filter maturity where the value is in the given list.","in":"query","name":"maturity__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter maturity where the value is in the given list.","title":"Maturity In"}},{"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 redeemed where the value is equal to the given value.","in":"query","name":"redeemed__eq","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter redeemed where the value is equal to the given value.","title":"Redeemed Eq"}},{"description":"Filter redeemed where the value is not equal to the given value.","in":"query","name":"redeemed__neq","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter redeemed where the value is not equal to the given value.","title":"Redeemed Neq"}},{"description":"Filter redeemed to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"redeemed__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter redeemed to rows where the value is NULL (true) or is not NULL (false).","title":"Redeemed Isnull"}},{"description":"Filter tap_deal where the value is equal to the given value.","in":"query","name":"tap_deal__eq","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter tap_deal where the value is equal to the given value.","title":"Tap Deal Eq"}},{"description":"Filter tap_deal where the value is not equal to the given value.","in":"query","name":"tap_deal__neq","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter tap_deal where the value is not equal to the given value.","title":"Tap Deal Neq"}},{"description":"Filter tap_deal to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"tap_deal__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter tap_deal to rows where the value is NULL (true) or is not NULL (false).","title":"Tap Deal Isnull"}},{"description":"Filter reg_144a_isin where the value is equal to the given value.","in":"query","name":"reg_144a_isin__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_144a_isin where the value is equal to the given value.","title":"Reg 144A Isin Eq"}},{"description":"Filter reg_144a_isin where the value is not equal to the given value.","in":"query","name":"reg_144a_isin__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_144a_isin where the value is not equal to the given value.","title":"Reg 144A Isin Neq"}},{"description":"Filter reg_144a_isin where the value contains the given value.","in":"query","name":"reg_144a_isin__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_144a_isin where the value contains the given value.","title":"Reg 144A Isin Contains"}},{"description":"Filter reg_144a_isin where the value is in the given list.","in":"query","name":"reg_144a_isin__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_144a_isin where the value is in the given list.","title":"Reg 144A Isin In"}},{"description":"Filter reg_144a_isin to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"reg_144a_isin__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter reg_144a_isin to rows where the value is NULL (true) or is not NULL (false).","title":"Reg 144A Isin Isnull"}},{"description":"Filter reg_s_isin where the value is equal to the given value.","in":"query","name":"reg_s_isin__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_s_isin where the value is equal to the given value.","title":"Reg S Isin Eq"}},{"description":"Filter reg_s_isin where the value is not equal to the given value.","in":"query","name":"reg_s_isin__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_s_isin where the value is not equal to the given value.","title":"Reg S Isin Neq"}},{"description":"Filter reg_s_isin where the value contains the given value.","in":"query","name":"reg_s_isin__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_s_isin where the value contains the given value.","title":"Reg S Isin Contains"}},{"description":"Filter reg_s_isin where the value is in the given list.","in":"query","name":"reg_s_isin__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_s_isin where the value is in the given list.","title":"Reg S Isin In"}},{"description":"Filter reg_s_isin to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"reg_s_isin__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter reg_s_isin to rows where the value is NULL (true) or is not NULL (false).","title":"Reg S Isin Isnull"}},{"description":"Filter other_isin where the value is equal to the given value.","in":"query","name":"other_isin__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter other_isin where the value is equal to the given value.","title":"Other Isin Eq"}},{"description":"Filter other_isin where the value is not equal to the given value.","in":"query","name":"other_isin__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter other_isin where the value is not equal to the given value.","title":"Other Isin Neq"}},{"description":"Filter other_isin where the value contains the given value.","in":"query","name":"other_isin__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter other_isin where the value contains the given value.","title":"Other Isin Contains"}},{"description":"Filter other_isin where the value is in the given list.","in":"query","name":"other_isin__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter other_isin where the value is in the given list.","title":"Other Isin In"}},{"description":"Filter other_isin to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"other_isin__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter other_isin to rows where the value is NULL (true) or is not NULL (false).","title":"Other Isin Isnull"}},{"description":"Filter reg_144a_figi where the value is equal to the given value.","in":"query","name":"reg_144a_figi__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_144a_figi where the value is equal to the given value.","title":"Reg 144A Figi Eq"}},{"description":"Filter reg_144a_figi where the value is not equal to the given value.","in":"query","name":"reg_144a_figi__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_144a_figi where the value is not equal to the given value.","title":"Reg 144A Figi Neq"}},{"description":"Filter reg_144a_figi where the value contains the given value.","in":"query","name":"reg_144a_figi__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_144a_figi where the value contains the given value.","title":"Reg 144A Figi Contains"}},{"description":"Filter reg_144a_figi where the value is in the given list.","in":"query","name":"reg_144a_figi__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_144a_figi where the value is in the given list.","title":"Reg 144A Figi In"}},{"description":"Filter reg_144a_figi to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"reg_144a_figi__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter reg_144a_figi to rows where the value is NULL (true) or is not NULL (false).","title":"Reg 144A Figi Isnull"}},{"description":"Filter reg_s_figi where the value is equal to the given value.","in":"query","name":"reg_s_figi__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_s_figi where the value is equal to the given value.","title":"Reg S Figi Eq"}},{"description":"Filter reg_s_figi where the value is not equal to the given value.","in":"query","name":"reg_s_figi__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_s_figi where the value is not equal to the given value.","title":"Reg S Figi Neq"}},{"description":"Filter reg_s_figi where the value contains the given value.","in":"query","name":"reg_s_figi__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_s_figi where the value contains the given value.","title":"Reg S Figi Contains"}},{"description":"Filter reg_s_figi where the value is in the given list.","in":"query","name":"reg_s_figi__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter reg_s_figi where the value is in the given list.","title":"Reg S Figi In"}},{"description":"Filter reg_s_figi to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"reg_s_figi__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter reg_s_figi to rows where the value is NULL (true) or is not NULL (false).","title":"Reg S Figi Isnull"}},{"description":"Filter other_figi where the value is equal to the given value.","in":"query","name":"other_figi__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter other_figi where the value is equal to the given value.","title":"Other Figi Eq"}},{"description":"Filter other_figi where the value is not equal to the given value.","in":"query","name":"other_figi__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter other_figi where the value is not equal to the given value.","title":"Other Figi Neq"}},{"description":"Filter other_figi where the value contains the given value.","in":"query","name":"other_figi__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter other_figi where the value contains the given value.","title":"Other Figi Contains"}},{"description":"Filter other_figi where the value is in the given list.","in":"query","name":"other_figi__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter other_figi where the value is in the given list.","title":"Other Figi In"}},{"description":"Filter other_figi to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"other_figi__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter other_figi to rows where the value is NULL (true) or is not NULL (false).","title":"Other Figi Isnull"}},{"description":"Filter instrument_type where the value is equal to the given value.","in":"query","name":"instrument_type__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter instrument_type where the value is equal to the given value.","title":"Instrument Type Eq"}},{"description":"Filter instrument_type where the value is not equal to the given value.","in":"query","name":"instrument_type__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter instrument_type where the value is not equal to the given value.","title":"Instrument Type Neq"}},{"description":"Filter instrument_type where the value contains the given value.","in":"query","name":"instrument_type__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter instrument_type where the value contains the given value.","title":"Instrument Type Contains"}},{"description":"Filter instrument_type where the value is in the given list.","in":"query","name":"instrument_type__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter instrument_type where the value is in the given list.","title":"Instrument Type In"}},{"description":"Filter instrument_type to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"instrument_type__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter instrument_type to rows where the value is NULL (true) or is not NULL (false).","title":"Instrument Type Isnull"}},{"description":"Filter country_ref_name where the value is equal to the given value.","in":"query","name":"country_ref_name__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter country_ref_name where the value is equal to the given value.","title":"Country Ref Name Eq"}},{"description":"Filter country_ref_name where the value is not equal to the given value.","in":"query","name":"country_ref_name__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter country_ref_name where the value is not equal to the given value.","title":"Country Ref Name Neq"}},{"description":"Filter country_ref_name where the value contains the given value.","in":"query","name":"country_ref_name__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter country_ref_name where the value contains the given value.","title":"Country Ref Name Contains"}},{"description":"Filter country_ref_name where the value is in the given list.","in":"query","name":"country_ref_name__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter country_ref_name where the value is in the given list.","title":"Country Ref Name In"}},{"description":"Filter country_ref_name to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"country_ref_name__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter country_ref_name to rows where the value is NULL (true) or is not NULL (false).","title":"Country Ref Name Isnull"}},{"description":"Filter currency_ref_code where the value is equal to the given value.","in":"query","name":"currency_ref_code__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter currency_ref_code where the value is equal to the given value.","title":"Currency Ref Code Eq"}},{"description":"Filter currency_ref_code where the value is not equal to the given value.","in":"query","name":"currency_ref_code__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter currency_ref_code where the value is not equal to the given value.","title":"Currency Ref Code Neq"}},{"description":"Filter currency_ref_code where the value contains the given value.","in":"query","name":"currency_ref_code__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter currency_ref_code where the value contains the given value.","title":"Currency Ref Code Contains"}},{"description":"Filter currency_ref_code where the value is in the given list.","in":"query","name":"currency_ref_code__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter currency_ref_code where the value is in the given list.","title":"Currency Ref Code In"}},{"description":"Filter currency_ref_code to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"currency_ref_code__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter currency_ref_code to rows where the value is NULL (true) or is not NULL (false).","title":"Currency Ref Code Isnull"}},{"description":"Filter debt_security_ref_name where the value is equal to the given value.","in":"query","name":"debt_security_ref_name__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter debt_security_ref_name where the value is equal to the given value.","title":"Debt Security Ref Name Eq"}},{"description":"Filter debt_security_ref_name where the value is not equal to the given value.","in":"query","name":"debt_security_ref_name__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter debt_security_ref_name where the value is not equal to the given value.","title":"Debt Security Ref Name Neq"}},{"description":"Filter debt_security_ref_name where the value contains the given value.","in":"query","name":"debt_security_ref_name__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter debt_security_ref_name where the value contains the given value.","title":"Debt Security Ref Name Contains"}},{"description":"Filter debt_security_ref_name where the value is in the given list.","in":"query","name":"debt_security_ref_name__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter debt_security_ref_name where the value is in the given list.","title":"Debt Security Ref Name In"}},{"description":"Filter debt_security_ref_name to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"debt_security_ref_name__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter debt_security_ref_name to rows where the value is NULL (true) or is not NULL (false).","title":"Debt Security Ref Name Isnull"}},{"description":"Filter instrument_status_name where the value is equal to the given value.","in":"query","name":"instrument_status_name__eq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter instrument_status_name where the value is equal to the given value.","title":"Instrument Status Name Eq"}},{"description":"Filter instrument_status_name where the value is not equal to the given value.","in":"query","name":"instrument_status_name__neq","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter instrument_status_name where the value is not equal to the given value.","title":"Instrument Status Name Neq"}},{"description":"Filter instrument_status_name where the value contains the given value.","in":"query","name":"instrument_status_name__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter instrument_status_name where the value contains the given value.","title":"Instrument Status Name Contains"}},{"description":"Filter instrument_status_name where the value is in the given list.","in":"query","name":"instrument_status_name__in","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter instrument_status_name where the value is in the given list.","title":"Instrument Status Name In"}},{"description":"Filter instrument_status_name to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"instrument_status_name__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter instrument_status_name to rows where the value is NULL (true) or is not NULL (false).","title":"Instrument Status Name Isnull"}},{"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 where the grade array contains this value.","in":"query","name":"grade__contains","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Filter where the grade array contains this value.","title":"Grade Contains"}},{"description":"Filter grade to rows where the value is NULL (true) or is not NULL (false).","in":"query","name":"grade__isnull","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Filter grade to rows where the value is NULL (true) or is not NULL (false).","title":"Grade 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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstrumentListSchema"}}},"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/ErrorResponse"}}},"description":"Request validation failed (e.g. unknown query parameter)."},"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":"List Instruments","tags":["Instrument"]}},"/v0/instruments/bonds-and-loans/{nf_id}":{"get":{"description":"Returns a single Bonds & Loans instrument.\nAllows for supplying a single instrument nf_id to get data about it.","operationId":"get_instrument_v0_instruments_bonds_and_loans__nf_id__get","parameters":[{"in":"path","name":"nf_id","required":true,"schema":{"title":"Nf Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstrumentSchema"}}},"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/ErrorResponse"}}},"description":"Request validation failed (e.g. unknown query parameter)."},"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":"Get Instrument","tags":["Instrument"]}}},"servers":[{"description":"Production environment","url":"https://api.9fin.com"}]} ```