---
title: "List Instruments"
method: POST
path: "/api/instruments/"
tags: ["instruments"]
---

# List Instruments

`POST /api/instruments/`

## Request

- Base URL: `https://api.harmoney.in`
- URL: `https://api.harmoney.in/api/instruments/`
- Auth: API key in header `x-api-key`

List instruments with filtering, sorting, and pagination.

## Request body

- InstrumentsListRequest: Request schema for instruments list endpoint.
  - `pagination` PaginationParams, required: Pagination parameters for API requests and database queries.
    - `page` integer: Page number (1-indexed)
    - `page_size` integer: Number of items per page (max 1000)
  - `query` InstrumentsListQuery: Query filters for instruments list.
    - `entity_ids` integer[], nullable
    - `asset_classes` AssetClass[], nullable
    - `instrument_types` InstrumentType[], nullable
    - `search_string` string, nullable
    - `updated_at` DateRangeFilter: Date range filter with optional start and end dates.
      - `start_date` string, date, nullable
      - `end_date` string, date, nullable
    - `issue_date` DateRangeFilter: Date range filter with optional start and end dates.
      - `start_date` string, date, nullable
      - `end_date` string, date, nullable

## Response `200`

Successful Response

- AppUtilsPaginationPaginatedResponseInstrumentListItem2
  - `items` AppApiDatafeedSchemaInstrumentsListInstrumentListItem[], required
    - `instrument_id` integer, required
    - `entity_id` integer, required
    - `asset_class` string, required
    - `instrument_type` string, required
    - `short_name` string, required
    - `name` string, required
    - `identifiers` InstrumentIdentifiers, required: Identifiers for instruments - currently supports ISIN.
      - `ISIN` string, nullable
    - `issuance_details` InstrumentIssuanceDetails, required: Issuance details for instruments.
      - `issue_date` string, date, nullable
      - `face_value` string, nullable
      - `outstanding_face_value` string, nullable: Outstanding principal as of current date
      - `issue_size` string, nullable
      - `mode_of_issue` string, nullable
      - `is_listed` boolean, nullable
    - `coupon_details` InstrumentCouponDetails, required: Coupon details for debt instruments.
      - `coupon_type` string, nullable
      - `coupon` string, nullable
      - `next_coupon_rate` string, nullable
      - `benchmark` string, nullable
      - `spread` string, nullable
      - `coupon_frequency` string, nullable
      - `next_coupon_date` string, date, nullable
      - `previous_coupon_date` string, date, nullable
      - `day_count_convention` string, nullable
      - `shut_period` integer, nullable
      - `step_up_details` CouponAdjustmentDetails: Coupon adjustment details for step-up/step-down bonds.
        - `adjustment_rate` string, nullable: Rate by which coupon changes
        - `adjustment_date` string, date, nullable: Date when the adjustment occurs
        - `reason` string, nullable: Reason for the adjustment
      - `step_down_details` CouponAdjustmentDetails: Coupon adjustment details for step-up/step-down bonds.
        - `adjustment_rate` string, nullable: Rate by which coupon changes
        - `adjustment_date` string, date, nullable: Date when the adjustment occurs
        - `reason` string, nullable: Reason for the adjustment
    - `maturity_details` InstrumentMaturityDetails, required: Maturity details for debt instruments.
      - `maturity_date` string, date, nullable
      - `maturity_type` string, nullable
      - `maturity_amount` string, nullable
      - `is_callable` boolean, nullable
      - `is_puttable` boolean, nullable
      - `call_date` string, date, nullable
      - `put_date` string, date, nullable
    - `covenants` InstrumentCovenants, required: Covenant details for debt instruments.
      - `is_taxable` boolean, nullable
      - `secured` boolean, nullable
      - `seniority` string, nullable
      - `rank` string, nullable
      - `guaranteed` boolean, nullable
    - `is_verified` boolean, required
    - `unique_id` string, nullable
  - `page` integer, required
  - `page_size` integer, required
  - `total` integer, required
  - `total_pages` integer, required
  - `has_next` boolean, required
  - `has_previous` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/inferedge/apis/india-fixed-income-data-feed.md) - [All operations](https://skmtc.dev/inferedge/apis/india-fixed-income-data-feed/llms.txt) - [OpenAPI document](https://skmtc.dev/inferedge/apis/india-fixed-income-data-feed/revisions/66687f780824?raw)