Skip to content

Latest commit

 

History

History
174 lines (123 loc) · 5.91 KB

MarketQuoteApi.md

File metadata and controls

174 lines (123 loc) · 5.91 KB

upstox_client.MarketQuoteApi

All URIs are relative to https://api-v2.upstox.com

Method HTTP request Description
get_full_market_quote GET /market-quote/quotes Market quotes and instruments - Full market quotes
get_market_quote_ohlc GET /market-quote/ohlc Market quotes and instruments - OHLC quotes
ltp GET /market-quote/ltp Market quotes and instruments - LTP quotes.

get_full_market_quote

GetFullMarketQuoteResponse get_full_market_quote(symbol, api_version)

Market quotes and instruments - Full market quotes

This API provides the functionality to retrieve the full market quotes for one or more instruments.This API returns the complete market data snapshot of up to 500 instruments in one go.

Example

from __future__ import print_function
import time
import upstox_client
from upstox_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAUTH2
configuration = upstox_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = upstox_client.MarketQuoteApi(upstox_client.ApiClient(configuration))
symbol = 'symbol_example' # str | Comma separated list of symbols
api_version = 'api_version_example' # str | API Version Header

try:
    # Market quotes and instruments - Full market quotes
    api_response = api_instance.get_full_market_quote(symbol, api_version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MarketQuoteApi->get_full_market_quote: %s\n" % e)

Parameters

Name Type Description Notes
symbol str Comma separated list of symbols
api_version str API Version Header

Return type

GetFullMarketQuoteResponse

Authorization

OAUTH2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_market_quote_ohlc

GetMarketQuoteOHLCResponse get_market_quote_ohlc(symbol, interval, api_version)

Market quotes and instruments - OHLC quotes

This API provides the functionality to retrieve the OHLC quotes for one or more instruments.This API returns the OHLC snapshots of up to 1000 instruments in one go.

Example

from __future__ import print_function
import time
import upstox_client
from upstox_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAUTH2
configuration = upstox_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = upstox_client.MarketQuoteApi(upstox_client.ApiClient(configuration))
symbol = 'symbol_example' # str | Comma separated list of symbols
interval = 'interval_example' # str | Interval to get ohlc data
api_version = 'api_version_example' # str | API Version Header

try:
    # Market quotes and instruments - OHLC quotes
    api_response = api_instance.get_market_quote_ohlc(symbol, interval, api_version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MarketQuoteApi->get_market_quote_ohlc: %s\n" % e)

Parameters

Name Type Description Notes
symbol str Comma separated list of symbols
interval str Interval to get ohlc data
api_version str API Version Header

Return type

GetMarketQuoteOHLCResponse

Authorization

OAUTH2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ltp

GetMarketQuoteLastTradedPriceResponse ltp(symbol, api_version)

Market quotes and instruments - LTP quotes.

This API provides the functionality to retrieve the LTP quotes for one or more instruments.This API returns the LTPs of up to 1000 instruments in one go.

Example

from __future__ import print_function
import time
import upstox_client
from upstox_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAUTH2
configuration = upstox_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = upstox_client.MarketQuoteApi(upstox_client.ApiClient(configuration))
symbol = 'symbol_example' # str | Comma separated list of symbols
api_version = 'api_version_example' # str | API Version Header

try:
    # Market quotes and instruments - LTP quotes.
    api_response = api_instance.ltp(symbol, api_version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MarketQuoteApi->ltp: %s\n" % e)

Parameters

Name Type Description Notes
symbol str Comma separated list of symbols
api_version str API Version Header

Return type

GetMarketQuoteLastTradedPriceResponse

Authorization

OAUTH2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

[Back to top] [Back to API list] [Back to Model list] [Back to README]