Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Instruments

Search Instruments

Searches Instruments based on the filter criteria provided.

post/instruments/filter

Request body

field'id' | 'ISIN' | 'CUSIP' | 'CINS' | 'payFrequency' | 'payFrequencyDescription' | 'couponRate' | 'maturityDate' | 'spRating' | 'assetClassCode' | 'assetClassDescription' | 'accrualDate' | 'bidPrice' | 'askPrice' | 'meanPrice' | 'askYieldToMaturity' | 'bidYieldToMaturity' | 'status' | 'statusDescription' | 'issuer.primaryName' | 'issuer.country' | 'issuer.domicileCountry' | 'features.minimumInvestmentAmount' | 'features.incrementalInvestmentAmount' | 'coupon.dayCountDescription' | 'coupon.couponTypeDescription' | 'details.nextCouponDate' | 'statusCode' | 'longOnly' | 'coupon.dayCount' | 'coupon.couponType' | 'coupon.nextCouponDate' | 'sector' | 'price' | 'minimumAmount' | 'orderBook.liquidityRetail' | 'orderBook.liquidityInstitutional' | 'orderBook.liquidityMicro' | 'orderBook.onlyLiveQuotes' | 'orderBook.price' | 'orderBook.yieldToWorst' | 'details.debtTypeDescription' | 'denominationAmounts.incrementAmount' | 'indicators.tradingRestrictionsType' required

The name of the field to be filtered on.

operator'=' | '!=' | '<' | '<=' | '>=' | '>' | '><' | '()' required

Filters, operator= equal to``!= not equal to``< less than``<= less than or equal to``> greater than``>= greater than or equal to``>< in between``() contains

value1string required

The value of the field that should be filtered

value2string

The value of the field that should be filtered. Should be provided when filtering ranges (between "><")

Example request

[
  {
    "field": "spRating",
    "value1": "AA",
    "value2": "A"
  }
]

Response

Searching Instruments by filter criteria was Successful.

Example response

[
  {
    "id": "3fb1e8a9-f7d5-4d90-95e2-43e7326b5636",
    "symbol": "MS",
    "name": "Morgan Stanley",
    "enableExtendedHoursNotionalStatus": "INACTIVE",
    "instrumentType": "EQUITY",
    "type": "EQUITY",
    "status": "ACTIVE",
    "ISIN": "US023135BX34",
    "isOptionsEnabled": true,
    "payFrequency": "SEMI_ANNUALLY",
    "couponRate": 0.05,
    "maturityDate": "2022-05-10",
    "spRating": "AAA",
    "bondType": "CORPORATE_BOND",
    "domicileCountry": "US"
  }
]