Barchart OnDemand | getQuote API

Inputs

symbols required

A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used. For futures, notation such as for the active contract or for the first nearby is supported, as is for all futures contracts for a given root symbol, as is for all options contracts for a given underlying futures symbol.

Type

list (A comma or semi-colon delimited string.)

Example

AAPL,GOOG

fields optional

The fields requested.

Type

list (A comma or semi-colon delimited string.)

Example

fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate

only optional

Returns only specified fields

Type

list (A comma or semi-colon delimited string.)

Example

symbol,name

Outputs

Name / Requirement

Description

Type

symbol
always returned

A symbol or code that identifies a financial instrument.

string
A sequence of characters. (example: GOOG)

name
always returned

The type of symbol used.

string
A sequence of characters. (example: GOOG)

dayCode
always returned

The day code for the session. Day codes are "1-9" for days 1 through 9, "0" (zero) for the 10th of the month, and "A - U" for days 11 through 31.

string
A sequence of characters. (example: GOOG)

serverTimestamp
always returned

The time the message was generated on the server.

dateTime
A date and time in the format of YYYY-MM-DD HH:MI:SS<TIMEZONE_OFFSET>.

mode
always returned

An indicator representing if the quote is real-time ("R"), delayed ("I") or end-of-day ("D") if available.

string
A sequence of characters. (example: GOOG)

lastPrice
always returned

The last price the instrument traded.

double
A numeric type defining a number with fractional parts. (example: 2.14)

tradeSize
as requested

The size of the last traded price / transaction.

int
A numeric type defining a whole number. (example: 2)

tradeTimestamp
always returned

The exchange timestamp for the last traded price.

dateTime
A date and time in the format of YYYY-MM-DD HH:MI:SS<TIMEZONE_OFFSET>.

netChange
always returned

The difference between the last traded price and the previous close.

double
A numeric type defining a number with fractional parts. (example: 2.14)

percentChange
always returned

The percent difference between the last traded price and the previous close.

double
A numeric type defining a number with fractional parts. (example: 2.14)

tick
as requested

An indicator representing whether the last traded price was up ("+"), the same (".") or below ("-") the previous last price.

string
A sequence of characters. (example: GOOG)

previousLastPrice
as requested

The price previous to the current last price.

double
A numeric type defining a number with fractional parts. (example: 2.14)

previousTimestamp
as requested

The exchange timestamp of the previous last price.

date
A date in the format of YYYY-MM-DD.

bid
as requested

The current bid price.

double
A numeric type defining a number with fractional parts. (example: 2.14)

bidSize
as requested

The size (quantity) of the current bid price.

int
A numeric type defining a whole number. (example: 2)

ask
as requested

The current ask price.

double
A numeric type defining a number with fractional parts. (example: 2.14)

askSize
as requested

The size (quantity) of the current ask price.

int
A numeric type defining a whole number. (example: 2)

unitCode
always returned

string
A sequence of characters. (example: GOOG)

open
always returned

The opening (first) price for the session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

high
always returned

The highest traded price for the session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

low
always returned

The lowest traded price for the session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

close
always returned

The last traded price for the session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

numTrades
always returned

The number of individual transactions over the course of a trading session.

int
A numeric type defining a whole number. (example: 2)

dollarVolume
always returned

double
A numeric type defining a number with fractional parts. (example: 2.14)

flag
always returned

If present, can be one of the following: "c" meaning that the market is closed for this instrument. "p" meaning that the market is in a pre-open state. This occurs when there are bids and offers being placed, but no trade has occurred yet. This is normally seen shortly before the official opening time for busy markets, but can also be seen throughout the day for lightly traded markets. "s" meaning that the instrument has settled, and that this is the final, settlement price.

string
A sequence of characters. (example: GOOG)

previousOpen
as requested

The opening (first) price for the previous session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

previousHigh
as requested

The highest traded price for the previous session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

previousLow
as requested

The lowest traded price for the previous session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

previousClose
as requested

The last traded price for the previous session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

settlement
as requested

The settlement price determined by the exchange.

double
A numeric type defining a number with fractional parts. (example: 2.14)

previousSettlement
as requested

The settlement price for the previous session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

volume
always returned

The quantity of shares or contracts traded.

int
A numeric type defining a whole number. (example: 2)

previousVolume
always returned

The quantity of shares or contracts traded from the previous day.

int
A numeric type defining a whole number. (example: 2)

openInterest
as requested

The quantity of open interest for futures.

double
A numeric type defining a number with fractional parts. (example: 2.14)

fiftyTwoWkHigh
as requested

The highest price over the past 52 weeks.

double
A numeric type defining a number with fractional parts. (example: 2.14)

fiftyTwoWkHighDate
as requested

The date in which the high price was reached over the past 52 weeks.

date
A date in the format of YYYY-MM-DD.

fiftyTwoWkLow
as requested

The low price over the past 52 weeks.

double
A numeric type defining a number with fractional parts. (example: 2.14)

fiftyTwoWkLowDate
as requested

The date in which the low price was reached over the past 52 weeks.

date
A date in the format of YYYY-MM-DD.

avgVolume
as requested

The average year-to-date daily volume.

int
A numeric type defining a whole number. (example: 2)

sharesOutstanding
as requested

The total number of shares outstanding. In thousands

int
A numeric type defining a whole number. (example: 2)

dividendRateAnnual
as requested

The total dividend payout over one year.

float
A numeric type defining a number with fractional parts. (example: 2.14)

dividendYieldAnnual
as requested

The annual dividend divided by the current share price.

float
A numeric type defining a number with fractional parts. (example: 2.14)

exDividendDate
as requested

The last possible date to have owned shares of a stock and still be entitled to the associated dividend.

date
A date in the format of YYYY-MM-DD.

impliedVolatility
as requested

double
A numeric type defining a number with fractional parts. (example: 2.14)

twentyDayAvgVol
as requested

double
A numeric type defining a number with fractional parts. (example: 2.14)

month
as requested

Contract month returned for futures.

string
A sequence of characters. (example: GOOG)

year
as requested

Contract year returned for futures.

string
A sequence of characters. (example: GOOG)

expirationDate
as requested

The expiration date for the futures contract. Only returns a value for futures.

date
A date in the format of YYYY-MM-DD.

lastTradingDay
as requested

The last trading day of the futures contract. Only returns a value for futures.

string
A sequence of characters. (example: GOOG)

twelveMnthPct
as requested

double
A numeric type defining a number with fractional parts. (example: 2.14)

twelveMnthPctDate
as requested

date
A date in the format of YYYY-MM-DD.

preMarketPrice
as requested

The pre market price for the instrument

double
A numeric type defining a number with fractional parts. (example: 2.14)

preMarketNetChange
as requested

The pre market net change for the instrument

double
A numeric type defining a number with fractional parts. (example: 2.14)

preMarketPercentChange
as requested

The pre market percent change for the instrument

double
A numeric type defining a number with fractional parts. (example: 2.14)

preMarketTimestamp
as requested

The pre market price for the instrument

dateTime
A date and time in the format of YYYY-MM-DD HH:MI:SS<TIMEZONE_OFFSET>.

afterHoursPrice
as requested

The after hour price for the instrument

double
A numeric type defining a number with fractional parts. (example: 2.14)

afterHoursNetChange
as requested

The after hour net change for the instrument

double
A numeric type defining a number with fractional parts. (example: 2.14)

afterHoursPercentChange
as requested

The after hour percent change for the instrument

double
A numeric type defining a number with fractional parts. (example: 2.14)

afterHoursTimestamp
as requested

The after hour price for the instrument

dateTime
A date and time in the format of YYYY-MM-DD HH:MI:SS<TIMEZONE_OFFSET>.

averageWeeklyVolume
as requested

The average volume for the last five trading days.

int
A numeric type defining a whole number. (example: 2)

averageMonthlyVolume
as requested

The average one month volume.

int
A numeric type defining a whole number. (example: 2)

averageQuarterlyVolume
as requested

The average 3 month volume.

int
A numeric type defining a whole number. (example: 2)

exchangeMargin
as requested

The margin maintenance required for the future.

string
A sequence of characters. (example: GOOG)

oneMonthHigh
as requested

The highest price over the last month.

double
A numeric type defining a number with fractional parts. (example: 2.14)

oneMonthHighDate
as requested

The date when the high price was reached over the last month.

date
A date in the format of YYYY-MM-DD.

oneMonthLow
as requested

The lowest price over the last month.

double
A numeric type defining a number with fractional parts. (example: 2.14)

oneMonthLowDate
as requested

The date when the low price was reached over the last month.

date
A date in the format of YYYY-MM-DD.

threeMonthHigh
as requested

The highest price over the last 3 months.

double
A numeric type defining a number with fractional parts. (example: 2.14)

threeMonthHighDate
as requested

The date when the high price was reached over the last 3 months.

date
A date in the format of YYYY-MM-DD.

threeMonthLow
as requested

The lowest price over the last 3 months.

double
A numeric type defining a number with fractional parts. (example: 2.14)

threeMonthLowDate
as requested

The date when the low price was reached over the last 3 months.

date
A date in the format of YYYY-MM-DD.

sixMonthHigh
as requested

The highest price over the last 6 months.

double
A numeric type defining a number with fractional parts. (example: 2.14)

sixMonthHighDate
as requested

The date when the high price was reached over the last 6 months.

date
A date in the format of YYYY-MM-DD.

sixMonthLow
as requested

The lowest price over the last 6 months.

double
A numeric type defining a number with fractional parts. (example: 2.14)

sixMonthLowDate
as requested

The date when the low price was reached over the last 6 months.

date
A date in the format of YYYY-MM-DD.

exchange
as requested

Exchange code for the marketplace where the financial instruments are listed.

string
A sequence of characters. (example: GOOG)

weeklyClose
as requested

The end-of-day last price the instrument traded this week.

double
A numeric type defining a number with fractional parts. (example: 2.14)

weeklyPreviousClose
as requested

The last price the instrument traded at last week.

double
A numeric type defining a number with fractional parts. (example: 2.14)

weeklyPreviousHigh
as requested

The high price the instrument traded at last week.

double
A numeric type defining a number with fractional parts. (example: 2.14)

weeklyPreviousLow
as requested

The low price the instrument traded at last week.

double
A numeric type defining a number with fractional parts. (example: 2.14)

monthlyClose
as requested

The end-of-day last price the instrument traded this month.

double
A numeric type defining a number with fractional parts. (example: 2.14)

monthlyPreviousClose
as requested

The last price the instrument traded at last month.

double
A numeric type defining a number with fractional parts. (example: 2.14)

monthlyPreviousHigh
as requested

The high price the instrument traded at last month.

double
A numeric type defining a number with fractional parts. (example: 2.14)

monthlyPreviousLow
as requested

The low price the instrument traded at last month.

double
A numeric type defining a number with fractional parts. (example: 2.14)

Status Code Responses

200

Success

400

Bad Request

The request was invalid, please see the message for more information.

500

Internal Server Error

Something is not working correctly, please contact support.

JSON

GET

GET https://ondemand.websol.barchart.com/getQuote.json?apikey=YOUR_API_KEY&symbols=AAPL%2CGOOG&fields=fiftyTwoWkHigh%2CfiftyTwoWkHighDate%2CfiftyTwoWkLow%2CfiftyTwoWkLowDate
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getQuote.json
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&symbols=AAPL%2CGOOG&fields=fiftyTwoWkHigh%2CfiftyTwoWkHighDate%2CfiftyTwoWkLow%2CfiftyTwoWkLowDate

Response

{
    "status": {
        "code": 200,
        "message": "Success."
    },
    "results": [
        {
            "symbol": "AAPL",
            "name": "Apple Inc",
            "dayCode": "B",
            "serverTimestamp": "2018-11-12T15:13:50-06:00",
            "mode": "i",
            "lastPrice": 194.15,
            "tradeTimestamp": "2018-11-12T15:58:49-06:00",
            "netChange": -10.319999999999993,
            "percentChange": -5.05,
            "unitCode": "2",
            "open": 199,
            "high": 199.85,
            "low": 193.79,
            "close": 0,
            "numTrades": 213197,
            "dollarVolume": 8204771668.8086,
            "flag": "",
            "volume": 47635603,
            "previousVolume": 34357699,
            "fiftyTwoWkHigh": 233.47,
            "fiftyTwoWkHighDate": "2018-10-03",
            "fiftyTwoWkLow": 150.24,
            "fiftyTwoWkLowDate": "2018-02-09"
        },
        {
            "symbol": "GOOG",
            "name": "Alphabet Class C",
            "dayCode": "B",
            "serverTimestamp": "2018-11-12T15:13:50-06:00",
            "mode": "i",
            "lastPrice": 1039.27,
            "tradeTimestamp": "2018-11-12T15:58:49-06:00",
            "netChange": -26.88000000000011,
            "percentChange": -2.52,
            "unitCode": "2",
            "open": 1061.39,
            "high": 1062.12,
            "low": 1031,
            "close": 0,
            "numTrades": 5322,
            "dollarVolume": 884885357.5703,
            "flag": "",
            "volume": 1243490,
            "previousVolume": 1343200,
            "fiftyTwoWkHigh": 1273.89,
            "fiftyTwoWkHighDate": "2018-07-27",
            "fiftyTwoWkLow": 980.64,
            "fiftyTwoWkLowDate": "2018-03-28"
        }
    ]
}

XML

GET

GET https://ondemand.websol.barchart.com/getQuote.xml?apikey=YOUR_API_KEY&symbols=AAPL%2CGOOG&fields=fiftyTwoWkHigh%2CfiftyTwoWkHighDate%2CfiftyTwoWkLow%2CfiftyTwoWkLowDate
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getQuote.xml
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&symbols=AAPL%2CGOOG&fields=fiftyTwoWkHigh%2CfiftyTwoWkHighDate%2CfiftyTwoWkLow%2CfiftyTwoWkLowDate

Response


<?xml version="1.0" encoding="utf-8"?>
 <getQuote>
  <status>
   <code>200</code>
   <message>Success.</message>
  </status>
  <item>
   <symbol>AAPL</symbol>
   <name>Apple Inc</name>
   <dayCode>B</dayCode>
   <serverTimestamp>2018-11-12T15:13:50-06:00</serverTimestamp>
   <mode>i</mode>
   <lastPrice>194.15</lastPrice>
   <tradeTimestamp>2018-11-12T15:58:50-06:00</tradeTimestamp>
   <netChange>-10.32</netChange>
   <percentChange>-5.05</percentChange>
   <unitCode>2</unitCode>
   <open>199</open>
   <high>199.85</high>
   <low>193.79</low>
   <close>0</close>
   <numTrades>213197</numTrades>
   <dollarVolume>8204771668.8086</dollarVolume>
   <flag></flag>
   <volume>47635803</volume>
   <previousVolume>34357699</previousVolume>
   <fiftyTwoWkHigh>233.47</fiftyTwoWkHigh>
   <fiftyTwoWkHighDate>2018-10-03</fiftyTwoWkHighDate>
   <fiftyTwoWkLow>150.24</fiftyTwoWkLow>
   <fiftyTwoWkLowDate>2018-02-09</fiftyTwoWkLowDate>
  </item>
  <item>
   <symbol>GOOG</symbol>
   <name>Alphabet Class C</name>
   <dayCode>B</dayCode>
   <serverTimestamp>2018-11-12T15:13:50-06:00</serverTimestamp>
   <mode>i</mode>
   <lastPrice>1039.27</lastPrice>
   <tradeTimestamp>2018-11-12T15:58:49-06:00</tradeTimestamp>
   <netChange>-26.88</netChange>
   <percentChange>-2.52</percentChange>
   <unitCode>2</unitCode>
   <open>1061.39</open>
   <high>1062.12</high>
   <low>1031</low>
   <close>0</close>
   <numTrades>5322</numTrades>
   <dollarVolume>884885357.5703</dollarVolume>
   <flag></flag>
   <volume>1243490</volume>
   <previousVolume>1343200</previousVolume>
   <fiftyTwoWkHigh>1273.89</fiftyTwoWkHigh>
   <fiftyTwoWkHighDate>2018-07-27</fiftyTwoWkHighDate>
   <fiftyTwoWkLow>980.64</fiftyTwoWkLow>
   <fiftyTwoWkLowDate>2018-03-28</fiftyTwoWkLowDate>
  </item>
 </getQuote>

CSV

GET

GET https://ondemand.websol.barchart.com/getQuote.csv?apikey=YOUR_API_KEY&symbols=AAPL%2CGOOG&fields=fiftyTwoWkHigh%2CfiftyTwoWkHighDate%2CfiftyTwoWkLow%2CfiftyTwoWkLowDate
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getQuote.csv
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&symbols=AAPL%2CGOOG&fields=fiftyTwoWkHigh%2CfiftyTwoWkHighDate%2CfiftyTwoWkLow%2CfiftyTwoWkLowDate

Response

symbol,name,dayCode,serverTimestamp,mode,lastPrice,tradeTimestamp,netChange,percentChange,unitCode,open,high,low,close,numTrades,dollarVolume,flag,volume,previousVolume,fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate
"AAPL","Apple Inc","B","2018-11-12T15:13:50-06:00","i","194.15","2018-11-12T15:58:50-06:00","-10.32","-5.05","2","199","199.85","193.79","0","213197","8204771668.8086","","47635803","34357699","233.47","2018-10-03","150.24","2018-02-09"
"GOOG","Alphabet Class C","B","2018-11-12T15:13:50-06:00","i","1039.27","2018-11-12T15:58:49-06:00","-26.88","-2.52","2","1061.39","1062.12","1031","0","5322","884885357.5703","","1243490","1343200","1273.89","2018-07-27","980.64","2018-03-28"

PHP

<?php

$ondemand = new SoapClient('https://ondemand.websol.barchart.com/service?wsdl');

$params = [
    'apikey' => 'YOUR_API_KEY',
    'symbols' => 'AAPL,GOOG',
    'fields' => 'fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate',
];

$result = $ondemand->getQuote($params);
var_dump($result);

Classic ASP

Dim ondemand
Dim result

Set ondemand = Server.CreateObject("MSSOAP.SoapClient30")
ondemand.ClientProperty("ServerHTTPRequest") = True
ondemand.MSSoapInit("https://ondemand.websol.barchart.com/service?wsdl")

Set result = ondemand.getQuote("YOUR_API_KEY", "AAPL,GOOG", "fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate")

Perl

use SOAP::Lite;
use SOAP::WSDL;

my $ondemand = SOAP::Lite
    -> service('https://ondemand.websol.barchart.com/service?wsdl');

my $result = $ondemand->getQuote('YOUR_API_KEY', 'AAPL,GOOG', 'fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate');

print $result;

Python

from suds.client import Client
ondemand = Client('https://ondemand.websol.barchart.com/service?wsdl')

result = client.service.getQuote('YOUR_API_KEY', 'AAPL,GOOG', 'fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate')

print result

Ruby

require 'savon'

ondemand = Savon.client(wsdl: 'https://ondemand.websol.barchart.com/service?wsdl')

response = ondemand.call(
    :getQuote,
    message: {
        apikey: 'YOUR_API_KEY',
        symbols: 'AAPL,GOOG',
        fields: 'fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate',
    }
)

response.body

getQuote API

Contact Us to Get Access

Inputs

symbols required

fields optional

only optional

Outputs

Status Code Responses

JSON

XML

CSV

PHP

Classic ASP

Perl

Python

Ruby

APIs

Data Coverage

Support

Case Studies

Contact

About

Contact:

(312) 566-9235

solutions@barchart.com