US Stocks Instruments
The US instruments file lists every US stock and ETF available on Upstox. Use it to find the instrument_key for the US Stocks APIs, and to check whether a stock can be traded and bought in fractions.
US instruments are not included in the Indian BOD files. The US Stocks APIs accept only instrument keys from this file, and return UDAPI1300 for any other key.
JSON file
The file is gzipped JSON and is refreshed daily, in the same way as the Indian BOD files.
Sample JSON object
{
"instrument_key": "US_EQ|AAPL",
"segment": "US_EQ",
"exchange": "US",
"foreign_exchange": "NASDAQ",
"trading_symbol": "AAPL",
"name": "Apple Inc.",
"lot_size": 1,
"tick_size": 5.0,
"fractionable": true,
"tradable": true,
"status": "active",
"is_etf": false
}
Fields
| Field | Type | Description |
|---|---|---|
| instrument_key | string | Unique key of the stock, in the format US_EQ|<SYMBOL>. Use it in every US Stocks API call. |
| segment | string | Always US_EQ. |
| exchange | string | Always US. |
| foreign_exchange | string | US exchange where the stock is listed, for example NASDAQ. |
| trading_symbol | string | Ticker symbol of the stock. |
| name | string | Company or fund name. |
| lot_size | number | Always 1. |
| tick_size | number | Kept for parity with the Indian BOD files. For US order prices, follow the price precision rules instead. |
| fractionable | boolean | true when the stock can be bought in fractional quantities or by USD amount. |
| tradable | boolean | false when the stock is listed but cannot currently be traded. Orders for it return UDAPI1301. |
| status | string | Listing status of the stock, for example active. |
| is_etf | boolean | true for an exchange-traded fund. |
Only stocks with fractionable: true accept a fractional quantity or an amount. For other stocks, send a whole-share quantity, or the order is rejected with UDAPI1304 or UDAPI1306.