search_bonds
Filter fixed-income instruments by issuer, type, rating, coupon, yield, maturity, and more. Combine filters to narrow results and page through them.
Instructions
Filtered, paged search for fixed income (bond) instruments.
All filters are optional; combine them to narrow down results. Returns a
page object with content (the bonds), totalElements, and totalPages.
Args: page_number: Page number, zero-based. Default 0. page_size: Items per page. Default 20. sort_property: Property to sort by (e.g. "maturityDate"). sort_direction: ASC or DESC. Default DESC. issuer: Filter by issuer name. issuer_symbol: Filter by issuer symbol(s), e.g. ["AAPL"]. bond_status: e.g. ["OUTSTANDING"]. Valid: LIQUIDATED, CONVERTED, FUNGED, REPAID, RESTRUCTURED, CALLED, DEFAULTED, MATURED, OUTSTANDING, PUT, TENDERED, REPURCHASED, PRE_ISSUANCE, UNKNOWN. bond_type: e.g. ["TREASURY", "CORPORATE"]. Valid: AGENCY, CD, CORPORATE, GOVERNMENT, MUNICIPAL, TREASURY. treasury_subtype: Valid: BOND, BILL, NOTE, STRIPS, TIPS, FLOATING. rating: S&P rating(s), e.g. ["AAA", "AA+"]. From AAA through D, NR for not rated (short-term ratings like A-1+/SP-1 also valid). rating_category: INVESTMENT_GRADE or SPECULATIVE_GRADE. sp_outlook: Valid: POSITIVE, NEGATIVE, DEVELOPING, STABLE, NOT_RATED, NOT_MEANINGFUL. sp_creditwatch: Valid: POSITIVE, NEGATIVE, DEVELOPING, NOT_MEANINGFUL. coupon_frequency: Valid: AT_MATURITY, ZERO, MONTHLY, QUARTERLY, SEMI_ANNUAL, ANNUAL. min_coupon: Minimum coupon rate (numeric string). max_coupon: Maximum coupon rate (numeric string). min_maturity_date: yyyy-MM-dd. Defaults server-side to today + 14 days. max_maturity_date: yyyy-MM-dd. min_current_yield: Minimum current yield (numeric string). max_current_yield: Maximum current yield (numeric string). min_par_value: Minimum par value (numeric string). max_par_value: Maximum par value (numeric string). min_liquidity_rating: Minimum liquidity score, 1 (low) to 5 (high). max_liquidity_rating: Maximum liquidity score, 1 (low) to 5 (high). liquidity_rating: Specific liquidity score(s), 1–5. callable: Filter by callable status. perpetual: Filter by perpetual bond status. partial_par: Filter by partial par status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| issuer | No | ||
| rating | No | ||
| callable | No | ||
| bond_type | No | ||
| page_size | No | ||
| perpetual | No | ||
| max_coupon | No | ||
| min_coupon | No | ||
| sp_outlook | No | ||
| bond_status | No | ||
| page_number | No | ||
| partial_par | No | ||
| issuer_symbol | No | ||
| max_par_value | No | ||
| min_par_value | No | ||
| sort_property | No | ||
| sort_direction | No | ||
| sp_creditwatch | No | ||
| rating_category | No | ||
| coupon_frequency | No | ||
| liquidity_rating | No | ||
| treasury_subtype | No | ||
| max_current_yield | No | ||
| max_maturity_date | No | ||
| min_current_yield | No | ||
| min_maturity_date | No | ||
| max_liquidity_rating | No | ||
| min_liquidity_rating | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |