getSymbolLookUp API

getSymbolLookUp

The getSymbolLookUp API provides a list of all instruments based on the keyword being passed.

View All APIs

First Name^*

Last Name^*

Email Address^*

Phone^*

Company^*

Role^*

Industry^*

Country^*

What you are looking for?^*

Please provide as much information as possible (e.g. exchanges, markets or other data sources), the APIs you are interested in (e.g. getQuote, getHistory, getChart, getCorporateActions, etc.), and your use case.

Here are some examples: Example #1, Example #2, Example #3.

By submitting this form you are opting in to receive email communications from Barchart for related product, service or company information, updates and announcements. You can unsubscribe at anytime. View our Privacy Policy.

Inputs

keyword^required

The keyword on which the search needs to be made.

Type

string (A sequence of characters. (example: GOOG))

Example

AA

limit^optional

The number of results to be returned.

Type

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

Default

exchanges^optional

Valid exchange code. Multiple exchanges can be passed separated by a comma.

Type

list-enum (A comma or semi-colon delimited string that must match a list of valid possible values.)

Valid Values

AMEX, CBOT, CBOTM, CME, COMEX, COMEX, FOREX, GBLX, ICE, ICEFI, ICEUS, WCE, CADFUNDS, FUND, INDEX, INDEX-CBOE, INDEX-DOW, INDEX-NQ, INDEX-NY, INDEX-SP, INDEX-TSX, IOM, IMM, KCBT, LCE, MIAX, NASDAQ, OTHER OTC, RATES, RATE, NYMEX, NYMI, NYSE, NLIF, TSX, TSX-V, NEO, SECTOR, CNSX, LIFFE, EUIDX, EUREX, BMF, MATIF, CXMI, CXMI, HKFE, SPECIAL, INDEX-RL, MATBA, NCDEX, ASX, ROFEX, OTC-BB, SIMEX, CZCE, CROSS, BSE, MNTRL, ECON, TOCOM, MEFF, ENDEX, SAFEX, TIFFE, CASH, MCX, NZX, MDEX, DGCX, NSE, CBOE, GME, OMX, CFE, TURK, TFEX, TAIWA, SHFE, DCE, BATS, LSE, LME, EEX, CFFEX, JPX, SFE, KFE, CRYPTO, GRBIDS, AGIDX_B_COU, AGIDX_B_CRD, AGIDX_B_NAT, AGIDX_B_REG, AGIDX_B_STA, AGIDX_P_COU, AGIDX_P_CRD, AGIDX_P_NAT, AGIDX_P_REG, AGIDX_P_STA, MTIDX_P_NAT_SY, C3, CXE, EURNXT_EQ_BE, EURNXT_EQ_FR, EURNXT_EQ_NL, EURNXT_EQ_PT, AGYIELD, CMDTY_STATS, CSTATS_BARCHART, CSTATS_BHUGHES, CSTATS_CFTC, CSTATS_ENGCORPS, CSTATS_EUSTAT, CSTATS_STATCAN, CSTATS_USBEA, CSTATS_USBLS, CSTATS_USCB, CSTATS_USDA, CSTATS_USEIA, CMENRF, CMENRF_IDX, CMENWF, CMMTPM, AGYIELD_BIW, SCB_BIOFUEL_EU, SCB_BIOFUEL_US, SCB_ETHANOL, SMALL, AGIDX_B_FCST, MER_ORG_GRN, MER_ORG_IMP, CSTATS_IBGE, PRM_GLB_BIO, PRM_LOW_CAR, AGYIELD_SA, CSTATS_CONAB, EEX_POWER, EEX_GAS, SGCOM, SGXFX, SGXNZ, SGIDX, BALTIC, AMEX, NASDAQ, NYSE

moreBestMatches^optional

To get additional best match results.

Type

boolean (A logical type representing the truth of a value as 'true' or 'false'.)

moreBestMatchLimit^optional

The number of additional best match results that should be returned.

Type

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

Default

fields^optional

The fields requested.

Type

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

Example

type

Outputs

symbol
always returned

The symbol for the instrument.

string
A sequence of characters. (example: GOOG)

name
always returned

The name of the instrument.

string
A sequence of characters. (example: GOOG)

exchange
always returned

The type and exchange of the instrument.

string
A sequence of characters. (example: GOOG)

type
as requested

The type of instrument.

string
A sequence of characters. (example: GOOG)

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/getSymbolLookUp.json?apikey=YOUR_API_KEY&keyword=AA&fields=type
Host: ondemand.websol.barchart.com

POST

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

apikey=YOUR_API_KEY&keyword=AA&fields=type

Response

{
    "status": {
        "code": 200,
        "message": "Success."
    },
    "results": [
        {
            "symbol": "AA",
            "name": "Alcoa Corp",
            "exchange": "Stocks - NYSE",
            "type": "Stocks"
        },
        {
            "symbol": "AAPL",
            "name": "Apple Inc",
            "exchange": "Stocks - NASDAQ",
            "type": "Stocks"
        },
        {
            "symbol": "AAL",
            "name": "American Airlines Gp",
            "exchange": "Stocks - NASDAQ",
            "type": "Stocks"
        },
        {
            "symbol": "FICO",
            "name": "Fair Isaac and Company",
            "exchange": "Stocks - NYSE",
            "type": "Stocks"
        },
        {
            "symbol": "AAM25",
            "name": "US$\/Argentine Peso June 2025",
            "exchange": "Futures - ROFEX",
            "type": "Futures"
        },
        {
            "symbol": "JAAA",
            "name": "Janus AAA Clo ETF",
            "exchange": "ETF - AMEX",
            "type": "ETF"
        },
        {
            "symbol": "MAA",
            "name": "Mid-America Apartment Communities",
            "exchange": "Stocks - NYSE",
            "type": "Stocks"
        },
        {
            "symbol": "AAP",
            "name": "Advance Auto Parts Inc",
            "exchange": "Stocks - NYSE",
            "type": "Stocks"
        },
        {
            "symbol": "AAN25",
            "name": "US$\/Argentine Peso July 2025",
            "exchange": "Futures - ROFEX",
            "type": "Futures"
        },
        {
            "symbol": "PAAS",
            "name": "Pan Amer Silver Corp",
            "exchange": "Stocks - NYSE",
            "type": "Stocks"
        }
    ]
}

XML

GET

GET https://ondemand.websol.barchart.com/getSymbolLookUp.xml?apikey=YOUR_API_KEY&keyword=AA&fields=type
Host: ondemand.websol.barchart.com

POST

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

apikey=YOUR_API_KEY&keyword=AA&fields=type

Response

<?xml version="1.0" encoding="utf-8"?>
<getSymbolLookUp>
  <status>
    <code>200</code>
    <message>Success.</message>
  </status>
  <item>
    <symbol>AA</symbol>
    <name>Alcoa Corp</name>
    <exchange>Stocks - NYSE</exchange>
    <type>Stocks</type>
  </item>
  <item>
    <symbol>AAPL</symbol>
    <name>Apple Inc</name>
    <exchange>Stocks - NASDAQ</exchange>
    <type>Stocks</type>
  </item>
  <item>
    <symbol>AAL</symbol>
    <name>American Airlines Gp</name>
    <exchange>Stocks - NASDAQ</exchange>
    <type>Stocks</type>
  </item>
  <item>
    <symbol>FICO</symbol>
    <name>Fair Isaac and Company</name>
    <exchange>Stocks - NYSE</exchange>
    <type>Stocks</type>
  </item>
  <item>
    <symbol>AAM25</symbol>
    <name>US$/Argentine Peso June 2025</name>
    <exchange>Futures - ROFEX</exchange>
    <type>Futures</type>
  </item>
  <item>
    <symbol>JAAA</symbol>
    <name>Janus AAA Clo ETF</name>
    <exchange>ETF - AMEX</exchange>
    <type>ETF</type>
  </item>
  <item>
    <symbol>MAA</symbol>
    <name>Mid-America Apartment Communities</name>
    <exchange>Stocks - NYSE</exchange>
    <type>Stocks</type>
  </item>
  <item>
    <symbol>AAP</symbol>
    <name>Advance Auto Parts Inc</name>
    <exchange>Stocks - NYSE</exchange>
    <type>Stocks</type>
  </item>
  <item>
    <symbol>AAN25</symbol>
    <name>US$/Argentine Peso July 2025</name>
    <exchange>Futures - ROFEX</exchange>
    <type>Futures</type>
  </item>
  <item>
    <symbol>PAAS</symbol>
    <name>Pan Amer Silver Corp</name>
    <exchange>Stocks - NYSE</exchange>
    <type>Stocks</type>
  </item>
</getSymbolLookUp>

CSV

GET

GET https://ondemand.websol.barchart.com/getSymbolLookUp.csv?apikey=YOUR_API_KEY&keyword=AA&fields=type
Host: ondemand.websol.barchart.com

POST

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

apikey=YOUR_API_KEY&keyword=AA&fields=type

Response

symbol,name,exchange,type
"AA","Alcoa Corp","Stocks - NYSE","Stocks"
"AAPL","Apple Inc","Stocks - NASDAQ","Stocks"
"AAL","American Airlines Gp","Stocks - NASDAQ","Stocks"
"FICO","Fair Isaac and Company","Stocks - NYSE","Stocks"
"AAM25","US$/Argentine Peso June 2025","Futures - ROFEX","Futures"
"JAAA","Janus AAA Clo ETF","ETF - AMEX","ETF"
"MAA","Mid-America Apartment Communities","Stocks - NYSE","Stocks"
"AAP","Advance Auto Parts Inc","Stocks - NYSE","Stocks"
"AAN25","US$/Argentine Peso July 2025","Futures - ROFEX","Futures"
"PAAS","Pan Amer Silver Corp","Stocks - NYSE","Stocks"

PHP

<?php

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

$params = [
    'apikey' => 'YOUR_API_KEY',
    'keyword' => 'AA',
    'fields' => 'type',
];

$result = $ondemand->getSymbolLookUp($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.getSymbolLookUp("YOUR_API_KEY", "AA", "type")

Perl

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

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

my $result = $ondemand->getSymbolLookUp('YOUR_API_KEY', 'AA', 'type');

print $result;

Python

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

result = ondemand.service.getSymbolLookUp('YOUR_API_KEY', 'AA', 'type')

print(result)

Ruby

require 'savon'

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

response = ondemand.call(
    :getSymbolLookUp,
    message: {
        apikey: 'YOUR_API_KEY',
        keyword: 'AA',
        fields: 'type',
    }
)

response.body