DriveWealth Instruments API

The Instruments API from DriveWealth — 5 operation(s) for instruments.

Operations 5

GET /instruments List Instruments
GET /instruments/{symbolOrInstrumentID} Retrieve Instrument
GET /instruments/{symbolOrInstrumentID}/options Retrieve Instrument Options Chain
GET /instruments/{symbolOrInstrumentID}/options/expiration-dates Retrieve Instrument Option Expiration
POST /instruments/filter Search Instruments #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/drivewealth-instruments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

drivewealth-instruments-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: DriveWealth Accounts Instruments API
  version: '1.0'
servers:
- url: https://bo-api.drivewealth.io/back-office
  description: Sandbox server (Uses test data)
- url: https://bo-api.drivewealth.net/back-office
  description: Production Server (Uses LIVE data)
tags:
- name: Instruments
  x-displayName: Instruments
paths:
  /instruments:
    get:
      tags:
      - Instruments
      parameters:
      - in: query
        name: status
        schema:
          type: string
        required: false
        example: ACTIVE
        description: The instrument status; to filter by.
      - in: query
        name: isOptionsEnabled
        schema:
          type: boolean
        required: false
        example: true
        description: The ability to trade options for this instrument; to filter by.
      summary: List Instruments
      description: Retrives a list of Instruments.
      responses:
        '200':
          description: Retrieving a list of Instruments was Successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Instruments'
      security:
      - bearerAuth: []
        dwAppKey: []
      - sessionToken: []
        dwAppKey: []
  /instruments/{symbolOrInstrumentID}:
    get:
      tags:
      - Instruments
      parameters:
      - in: path
        name: symbolOrInstrumentID
        schema:
          type: string
        required: true
        example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636
        description: A unique ID created by DriveWealth to identify a specific Equity Instrument or Option Instrument, also accept the market symbols like Ticker for Equities and OSI for Options.
      - in: query
        name: options
        schema:
          type: string
        required: false
        example: Fundamentals
        description: This query parameter will add an additional property; `fundamentalDataModel` to the response object for an Equity Instrument only. This data consists of financial data model specs for a specific Instrument.
      summary: Retrieve Instrument
      description: Retrieves an Instrument details by symbol or instrumentID.
      responses:
        '200':
          description: Fetching Instrument details was successful.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/EquityInstrumentDetails'
                - $ref: '#/components/schemas/OptionInstrumentDetails'
                - $ref: '#/components/schemas/MutualFundInstrumentDetails'
                - $ref: '#/components/schemas/DebtInstrumentDetails'
                discriminator:
                  propertyName: instrumentType
                  mapping:
                    EQUITY: '#/components/schemas/EquityInstrumentDetails'
                    OPTION: '#/components/schemas/OptionInstrumentDetails'
                    MUTUAL_FUND: '#/components/schemas/MutualFundInstrumentDetails'
                    DEBT: '#/components/schemas/DebtInstrumentDetails'
      security:
      - bearerAuth: []
        dwAppKey: []
      - sessionToken: []
        dwAppKey: []
  /instruments/{symbolOrInstrumentID}/options:
    get:
      tags:
      - Instruments
      parameters:
      - in: path
        name: symbolOrInstrumentID
        schema:
          type: string
        required: true
        example: AAPL
        description: Symbol or instrumentID of the underlying equity security
      - in: query
        name: expirationDate
        schema:
          type: string
        required: true
        example: '2022-05-15'
        description: The expiration date of the option security; to filter by.
      - in: query
        name: page
        schema:
          type: integer
        required: false
        example: 1
      - in: query
        name: pageSize
        schema:
          type: integer
        required: false
        example: 20
        description: The number of option instruments to be returned per page.
      - in: query
        name: sortOrder
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
        required: false
        example: asc
        description: The sorting order of option instruments.
      - in: query
        name: noOfStrikes
        schema:
          type: integer
        required: false
        example: 5
        description: The number of option instruments to be returned above and below market price.
      - in: query
        name: minStrikePrice
        schema:
          type: integer
        required: false
        example: 20
        description: The option instruments to be returned above the strike price.
      - in: query
        name: maxStrikePrice
        schema:
          type: integer
        required: false
        example: 100
        description: The option instruments to be returned below the strike price.
      - in: query
        name: optionType
        schema:
          type: string
          enum:
          - CALL
          - PUT
        required: false
        example: CALL
        description: The type of option instruments to be returned.
      - in: query
        name: id
        schema:
          type: string
        required: false
        example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636
        description: The instrument ID of the option security.
      - in: query
        name: filterBy
        schema:
          type: string
        required: false
        example: expirationDate
        description: The expiration dates for the given underlying security; to filter by.
      summary: Retrieve Instrument Options Chain
      description: Retrieves an Instrument Options Chain by symbol or instrumentID.
      responses:
        '200':
          description: Retrieving an Instrument Options Chain by symbol or instrumentID was Successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionsList'
              examples:
                Options Chain:
                  value:
                    symbol: AAPL
                    options:
                    - optionsData:
                        rootSymbol: AAPL
                        rootId: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636
                        expirationDate: '2018-09-18'
                        optionType: PUT
                        strikePrice: 16.5
                        deliverable: 100
                        multiplier: 100
                      id: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636
                      symbol: AAPL220517P00016000
                      type: OPTION
                      name: Apple Computer September 9 $16.00 Put
                      exchange: NYQ
                      orderSizeMax: 20000
                      orderSizeMin: 1
                      orderSizeStep: 1
      security:
      - bearerAuth: []
        dwAppKey: []
      - sessionToken: []
        dwAppKey: []
  /instruments/{symbolOrInstrumentID}/options/expiration-dates:
    get:
      tags:
      - Instruments
      parameters:
      - in: path
        name: symbolOrInstrumentID
        schema:
          type: string
        required: true
        example: AAPL
        description: Symbol or instrumentID of the underlying equity security.
      summary: Retrieve Instrument Option Expiration
      description: Retrieve an Instrument Option Expiration details by symbol or instrumentID.
      responses:
        '200':
          description: Retrieving an Instrument Option Expiration details by symbol or instrumentID was Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpirationDateList'
      security:
      - bearerAuth: []
        dwAppKey: []
      - sessionToken: []
        dwAppKey: []
  /instruments/filter:
    post:
      tags:
      - Instruments
      summary: Search Instruments
      description: Searches Instruments based on the filter criteria provided.
      operationId: filterInstruments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterCriteria'
            examples:
              InBetweenOperatorSample:
                value:
                - field: spRating
                  operator: '><'
                  value1: A
                  value2: AAA
              MultipleFiltersSample:
                value:
                - field: couponRate
                  operator: '><'
                  value1: '3.14'
                  value2: '6'
                - field: maturityDate
                  operator: '><'
                  value1: '2023-08-24'
                  value2: '2025-02-12'
                - field: maturityDate
                  operator: '><'
                  value1: '2028-01-24'
                  value2: '2032-04-25'
      responses:
        '200':
          description: Searching Instruments by filter criteria was Successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Instruments'
              examples:
                InstrumentsFilterSuccess:
                  value:
                  - id: 2dd415f4-16f0-4df9-9a33-610f1531cb55
                    name: Amazon.com, Inc. 1.5% 2030-06-03
                    instrumentType: DEBT
                    status: ACTIVE
                    payFrequency: SEMI_ANNUALLY
                    couponRate: 1.5
                    maturityDate: '2030-06-03'
                    spRating: AA
                    bondType: CORPORATE_BOND
                    domicileCountry: US
                    ISIN: US023135BS49
                    CUSIP: 023135BS4
                  - id: f8e3a175-5dfc-4d9b-bd1a-7db0e8b48703
                    name: Amazon.com, Inc. 3.8% 2024-12-05
                    instrumentType: DEBT
                    status: ACTIVE
                    payFrequency: SEMI_ANNUALLY
                    couponRate: 3.8
                    maturityDate: '2024-12-05'
                    spRating: AA
                    bondType: CORPORATE_BOND
                    domicileCountry: US
                    ISIN: US023135AN60
                    CUSIP: 023135AN6
      security:
      - bearerAuth: []
        dwAppKey: []
      - sessionToken: []
        dwAppKey: []
components:
  schemas:
    country:
      type: string
      example: US
      description: The ISO standard country alpha-2 code.
    Indicators:
      description: Indicators that provide additional information about the security
      example:
        callIndicator: false
        convertibleIndicator: false
        defaultIndicator: false
        dtcIndicator: true
        oidIndicator: false
        putIndicator: false
        sinkIndicator: false
        tipsIndicator: false
        floaterIndicator: false
        traceEligible: true
        capitalizedIndicator: false
        childIndicator: false
        defeasanceIndicator: false
        equityLinkedNoteIndicator: false
        pikIndicator: false
        tenderExchangeOfferIndicator: false
        warrantsIndicator: false
        tradingRestrictionsType: None
      properties:
        callIndicator:
          description: Indicates if the security is eligible to be redeemed by the issuer on a call basis
          readOnly: true
          type: boolean
        convertibleIndicator:
          description: Specifies whether an issue is convertible or exchangeable
          readOnly: true
          type: boolean
        defaultIndicator:
          description: Specifies whether the security is in default or not
          readOnly: true
          type: boolean
        dtcIndicator:
          description: Indicates whether the security is acceptable for clearing by the DTCC.
          readOnly: true
          type: boolean
        oidIndicator:
          description: Specifies whether or not this issue qualifies for Original Issue Discount status
          readOnly: true
          type: boolean
        putIndicator:
          description: Indicates whether the security carries provisions that allow for redemption at the request of owners of the security
          readOnly: true
          type: boolean
        sinkIndicator:
          description: Indicates whether the security carries a sinking fund as part of its terms and conditions
          readOnly: true
          type: boolean
        tipsIndicator:
          description: Indicates whether the security is a Treasury Inflation Protected Security
          readOnly: true
          type: boolean
        traceEligible:
          description: Indicates whether the security is considered TRACE eligible for price reporting
          readOnly: true
          type: boolean
        capitalizedIndicator:
          description: Specifies whether a bond issuer has set aside some of the proceeds from a bond sale to cover a certain number of interest payments
          readOnly: true
          type: boolean
        childIndicator:
          description: Indicates whether the security is created as the result of a corporate action or other event (the child instrument) from a previously issued instrument (the parent)
          readOnly: true
          type: boolean
        defeasanceIndicator:
          description: Indicates whether the security contains a provision that voids a bond or loan when the borrower sets aside cash or bonds sufficient enough to service the borrower's debt (a process called defeasance)
          readOnly: true
          type: boolean
        equityLinkedNoteIndicator:
          description: Indicates whether the security is an Equity Linked Note
          readOnly: true
          type: boolean
        pikIndicator:
          description: Indicates whether the security carries provisions to make Payment In Kind (PIK) to owners of the security
          readOnly: true
          type: boolean
        tenderExchangeOfferIndicator:
          description: Indicates whether the security has an associated exchange or tender offer
          readOnly: true
          type: boolean
        warrantsIndicator:
          description: Indicates whether there is a warrant associated with the particular security
          readOnly: true
          type: boolean
        floaterIndicator:
          description: Indicates whether the security has a floating or adjustable rate issue
          readOnly: true
          type: boolean
        tradingRestrictionsType:
          description: Indicates whether any trading restrictions are in effect for the security
          enum:
          - None
          - 144A
          - REG_S
          - PRIVATE_PLACEMENT
          - ACCREDITED_INVESTORS
          - REG_D
          - SEC_ACT_OF_1933
          readOnly: true
          type: string
    OptionsList:
      type: object
      properties:
        symbol:
          type: string
          example: AAPL220517P00016000
          description: Option OSI symbol
        options:
          type: array
          items:
            $ref: '#/components/schemas/OptionInstrumentDetails'
    fundamentalDataModel:
      type:
      - object
      - 'null'
      properties:
        id:
          $ref: '#/components/schemas/instrumentID'
        symbol:
          $ref: '#/components/schemas/instrumentSymbol'
        openPrice:
          $ref: '#/components/schemas/openPrice'
        bidPrice:
          $ref: '#/components/schemas/bidPrice'
        askPrice:
          $ref: '#/components/schemas/askPrice'
        lowPrice:
          $ref: '#/components/schemas/lowPrice'
        highPrice:
          $ref: '#/components/schemas/highPrice'
        fiftyTwoWeekLowPrice:
          type: number
          example: 72.05
          description: The lowest price of the instrument in the past 52 weeks.
        fiftyTwoWeekHighPrice:
          type: number
          example: 109.73
          description: The highest price of the instrument in the past 52 weeks.
        cumulativeVolume:
          type: number
          example: 3970567
          description: Cumulative Volume is a running total of daily trade volume. This measures the cumulative inflow and outflow of trading volume for the instrument. Measured in quantity of shares.
        marketCap:
          type: number
          example: 148374700000
          description: The total market cap of the instrument measured in USD.
        peRatio:
          type: number
          example: 12.7434
          description: The Price-earnings ratio for the instrument.
        dividendYield:
          type: number
          example: 3.5312
          description: The percentage of a company's share price that is payed out in dividends each year.
        earningsPerShare:
          type: number
          example: 6.889
          description: The earnings per share of the instrument measured in USD. EPS is company's profit divided by the outstanding shares of its common stock.
        dividend:
          type: number
          example: 3.1
          description: The annual dividend amount paid out per share measured in USD.
        sharesOutstanding:
          type: number
          example: 1307993346
          description: The total shares outstanding for the instrument. Shares outstanding are all the shares of an instrument that have been authorized, issued and purchased by investors.
        timeLastUpdate:
          type: string
          example: '18:28:00'
          description: The last time the instruments data was updated.
        bookValuePerShare:
          type: string
          example: '59.49634'
          description: The book value per share of the instrument measured in USD. The BVPS is the ratio of equity available to common shareholders divided by the number of outstanding shares.
        cashFlowPerShare:
          type: string
          example: '10.40132'
          description: The cash flow per share measured in USD. Cash flow per share is the after-tax earnings plus depreciation on a per-share basis that functions as a measure of a firm's financial strength.
        operatingIncome:
          type: string
          example: '19668000000'
          description: The operating income of an instrument measured in USD. Operating income is an accounting figure that measures the amount of profit realized from a business's operations after deducting operating expenses such as wages, depreciation, and cost of goods sold.
        pbRatio:
          type: string
          example: '1.61196'
          description: The Price-to-Book ratio of the instrument measured USD per share. The Price-to-Bok ratio measures the market valuation of an Instrument relative to its book  value.
        volumeMovingAverage10Day:
          type: number
          example: 7791905
          description: The volume moving average of the last 10 days for the instrument measured in quantity of shares.
        volumeMovingAverage25Day:
          type: number
          example: 6768708
          description: The volume moving average of the last 25 days for the instrument measured in quantity of shares.
        volumeMovingAverage50Day:
          type: number
          example: 7307176
          description: The volume moving average of the last 50 days for the instrument measured in quantity of shares.
        priceMovingAverage50Day:
          type: number
          example: 85.3034
          description: The price moving average of the last 50 days for the instrument measured in (USD) per share.
        priceMovingAverage150Day:
          type: number
          example: 83.6295
          description: The price moving average of the last 150 days for the instrument measured in (USD) per share.
        priceMovingAverage200Day:
          type: number
          example: 84.3036
          description: The price moving average of the last 200 days for the instrument measured in (USD) per share.
        roe:
          type: string
          example: '0.15315'
          description: Return on equity of the instrument measured as a fraction, multiply by 100 to get percentage value. ROE is a measure of financial performance calculated by dividing net income by shareholders' equity.
        percentchangeWTD:
          type: number
          example: 2.31
          description: The percentage change between the most recent market closing price and the closing price at the week start.
        percentchangeMTD:
          type: number
          example: 2.3
          description: The price percentage change for the instrument Month to Date.
        percentchangeYTD:
          type: number
          example: 10.11
          description: The price percentage change for the instrument Year to Date.
        percentchange4week:
          type: number
          example: 21.22
          description: The price percentage change for the instrument in last 4 Weeks.
        percentchange13week:
          type: number
          example: 6.67
          description: The price percentage change for the instrument in last 13 Weeks.
        percentchange26week:
          type: number
          example: 8.26
          description: The price percentage change for the instrument in last 26 Weeks.
        percentchange52week:
          type: number
          example: 12.1
          description: The price percentage change for the instrument in last 52 Weeks.
        percentchange5day:
          type: number
          example: 10.11
          description: The 5 Day Price Percent Change is the percentage change in the company's stock price over the last 5 tradable (business) days.
        percentchangeYTDrelsnp:
          type: number
          example: 9.11
          description: The percentage change in price since the close of the last trading day of the previous year as compared to the change in price of the S&P 500 during that same period.
        percentchange5weekrelsnp:
          type: number
          example: 16.62
          description: The percentage change in price over the last four weeks as compared to the change in price of the S&P 500 during that same period
        percentchange13weekrelsnp:
          type: number
          example: 5.67
          description: The percentage change in price over the last thirteen weeks as compared to the change in price of the S&P 500 during that same period
        percentchange26weekrelsnp:
          type: number
          example: 2.66
          description: The percentage change in price over the last twenty six weeks as compared to the change in price of the S&P 500 during that same period.
        percentchange52weekrelsnp:
          type: number
          example: 11.12
          description: The percentage change in price over the last fifty two weeks as compared to the change in price of the S&P 500 during that same period.
    DebtReferenceData:
      type: object
      properties:
        payFrequency:
          $ref: '#/components/schemas/PayFrequency'
        couponRate:
          $ref: '#/components/schemas/CouponRate'
        maturityDate:
          $ref: '#/components/schemas/MaturityDate'
        spRating:
          $ref: '#/components/schemas/SpRating'
        spRatingDate:
          $ref: '#/components/schemas/SpRatingDate'
        minimumInvestmentAmount:
          description: The minimum initial investment in the security.
          type: integer
          format: int64
          example: 1000
          readOnly: true
        incrementalInvestmentAmount:
          description: The minimum additional investment in the security.
          type: integer
          format: int64
          example: 1000
          readOnly: true
        issueDate:
          description: The date on which the instrument was first made available to the market.
          type: string
          format: date
          example: '2018-05-10'
          readOnly: true
        datedDate:
          description: The date of a Bond Issue from which Interest begins to accrue.
          type: string
          format: date
          example: '2018-05-10'
          readOnly: true
        issueAmount:
          description: The total value of the security at issue.
          type: number
          format: double
          example: 1000000
          readOnly: true
        issuePricePercent:
          description: The nominal value associated with a financial instrument at the time of issuance.
          type: number
          format: double
          example: 100
          readOnly: true
        accruedInterest:
          description: The amount of interest that has accumulated since the last coupon payment.
          type: number
          format: double
          example: 0.05
          readOnly: true
        debtType:
          description: The code for the type fixed income instrument.
          type: integer
          readOnly: true
        bondType:
          $ref: '#/components/schemas/BondType'
        debtTypeDescription:
          type: string
          description: The description for the type fixed income instrument.
          enum:
          - NONE
          - BANK_LOAN
          - ASSET-BACKED_SECURITY_(ABS)
          - BOND
          - CERTIFICATE_OF_DEPOSIT_(CD)
          - DEMAND_NOTE
          - EMPLOYEE_STOCK_OWNERSHIP_PLAN_(ESOP)
          - FHLMC_REFERENCE_NOTES
          - GUARANTEED_INVESTMENT_CERTIFICATE_(GIC)
          - SCHULDSCHEIN
          - INCOME
          - MORTGAGE-BACKED_SECURITY_(MBS)
          - BANKER'S_ACCEPTANCE
          - COLLATERALISED_LOAN_OBLIGATION_(CLO)
          - COLLATERALIZED_MORTGAGE_OBLIGATION_(CMO)
          - NOTE
          - COLLATERALISED_BOND_OBLIGATION_(CBO)
          - COMMERCIAL_PAPER
          - PFANDBRIEF
          - PROMISSORY_NOTES
          - STRUCTURED_ASSETS
          - TRUST_CERTIFICATE
          - PARTICIPATION_UNIT
          - SAVINGS_BOND
          - PASS_THRU_CERTIFICATES
          - UNKNOWN
          - STRIP
          - ANNUITY
          - BILL
          - CERTIFICATE
          - DEPOSIT_NOTE
          - EQUIPMENT_TRUST_CERTIFICATE
          - FNMA_BENCHMARK_ISSUES
          - MORTGAGE/UK_DEBENTURE
          - SCHATZANWEISUNGEN
          - DISCOUNT_NOTE
          - PERMANENT_INTEREST_BEARING_SECURITY
          - OTHER_MONEY_MARKETS
          - LOAN_NOTE
          - MERCHANT_MARINE
          - MORTGAGE_NOTE
          - COLLATERALIZED_DEBT_OBLIGATION_(CDO)
          - PRIVATE_PLACEMENT
          - EXCHANGE_TRADED_NOTE
          - PREMIUM_BOND
          - SECURITY
          - UNIT
          - SAVINGS_NOTES
          - PARTICIPATION_CERTIFICATES
          - DISCOUNT_DEBENTURE
          - DEBENTURE_-_UNSECURED
          - EXCHANGE_TRADED_COMMODITY
          - ASSET-BACKED_COMMERCIAL_PAPER
          - SUKUK
          - DEBENTURE_-_SECURED
          - LETTER_OF_CREDIT
          - GLOBAL_DEPOSITORY_NOTE
          example: BOND
          readOnly: true
        sector:
          type: string
          example: FINANCE_AND_INSURANCE
          description: The categorization of the sector pertaining to the Instrument.
          enum:
          - AGRICULTURE_FORESTRY_FISHING_AND_HUNTING
          - MINING_QUARRYING_AND_OIL_AND_GAS_EXTRACTION
          - UTILITIES
          - CONSTRUCTION
          - MANUFACTURING
          - WHOLESALE_TRADE
          - RETAIL_TRADE
          - TRANSPORTATION_AND_WAREHOUSING
          - INFORMATION
          - FINANCE_AND_INSURANCE
          - REAL_ESTATE_AND_RENTAL_AND_LEASING
          - PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES
          - MANAGEMENT_OF_COMPANIES_AND_ENTERPRISES
          - ADMINISTRATIVE_AND_SUPPORT_AND_WASTE_MANAGEMENT_AND_REMEDIATION_SERVICES
          - EDUCATIONAL_SERVICES
          - HEALTH_CARE_AND_SOCIAL_ASSISTANCE
          - ARTS_ENTERTAINMENT_AND_RECREATION
          - ACCOMMODATION_AND_FOOD_SERVICES
          - OTHER_SERVICES_EXCEPT_PUBLIC_ADMINISTRATION
          - PUBLIC_ADMINISTRATION
        duration:
          description: The duration of the bond.
          type:
          - number
          - 'null'
          format: double
          example: '10.5'
          readOnly: true
        nextCallDate:
          description: The next call date of the bond.
          type:
          - string
          - 'null'
          format: date
          example: '2018-05-10'
          readOnly: true
        debtRankType:
          description: The debt rank type of the bond.
          type: string
          example: SENIOR
          readOnly: true
          enum:
          - UNKNOWN
          - SECOND_MORTGAGE
          - 'FIRST_MORTGAGE '
          - JUNIOR
          - MEZZANINE
          - SENIOR_SUBORDINATED
          - SUBORDINATED
          - THIRD_MORTGAGE
          - UNSUBORDINATED
          - JUNIOR_SUBORDINATED
          - SENIOR
          - NOT_APPLICABLE
          - TIER_I
          - LOWER_TIER_II
          - UPPER_TIER_II
          - TIER_III
          - SENIOR_SECURED
          - ALTERNATIVE_ADDITIONAL_TIER_I
          - SENIOR_NON_PREFERRED
        spRatingType:
          type: string
          example: INVESTMENT_GRADE
          description: The spRating type of the bond.
          enum:
          - INVESTMENT_GRADE
          - HIGH_YIELD
        coupon:
          $ref: '#/components/schemas/Coupon'
        issuer:
          $ref: '#/components/schemas/Issuer'
        indicators:
          $ref: '#/components/schemas/Indicators'
        denominationAmounts:
          $ref: '#/components/schemas/DenominationAmounts'
    FilterCriterion:
      type: object
      required:
      - field
      - operator
      - value1
      properties:
        field:
          description: The name of the field to be filtered on.
          type: string
          example: spRating
          enum:
          - 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
        operator:
          description: 'Filters, operator`= equal to``!= not equal to``< less than``<= less than or equal to``> greater than``>= greater than or equal to``>< in between``() contains` '
          type: string
          enum:
          - '='
          - '!='
          - <
          - <=
          - '>='
          - '>'
          - '><'
          - ()
        value1:
          description: The value of the field that should be filtered
          type: string
          example: AA
        value2:
          description: The value of the field that should be filtered. Should be provided when filtering ranges (between "><")
          type: string
          example: A
    InstrumentBase:
      type: object
      properties:
        symbol:
          $ref: '#/components/schemas/instrumentSymbol'
        name:
          type: string
          example: Morgan Stanley
          description: A friendly name of the Instrument, like the Company name for an equity
        orderSizeMax:
          type: number
          example: 20000
          description: The maximum share amount for any order of this Instrument.
        orderSizeMin:
          type: number
          example: 0.1
          description: The minimum share amount for any order of this Instrument.
        orderSizeStep:
          type: number
          example: 0.01
          description: Increment amount on order of this Instrument.
        id:
          $ref: '#/components/schemas/instrumentID'
        instrumentType:
          $ref: '#/components/schemas/instrumentType'
        exchange:
          type: string
          example: NYQ
          description: The st

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/drivewealth/refs/heads/main/openapi/drivewealth-instruments-api-openapi.yml