Instruments

Search instruments

This API provides the functionality to retrieve the instrument details for searched query

get/v2/instruments/search

Request

  • Base URL: https://api-v2.upstox.com
  • URL: https://api-v2.upstox.com/v2/instruments/search
  • Auth: OAuth 2 (authorization code, authorization URL https://api-v2.upstox.com/v2/login/authorization/dialog, token URL https://api-v2.upstox.com/v2/login/authorization/token)

Query parameters

querystring required

natural language query

exchangesstring

Comma separated exchanges

segmentsstring

Comma separated segments

instrument_typesstring

Comma separated instrument types

expirystring

expiry in format: yyyy-MM-dd

atm_offsetinteger

page number greater than or equal to 1

page_numberinteger

ATM offset number for queries like ATM, ATM+1, ATM-1, etc.

recordsinteger

no of records in a single page

Response

Successful

status'success' | 'error' | 'partial_success'

Changes

No recorded changes to this operation across all 1 revision of this API.