Stocks · Reference and fundamentals
Stocks ticker details
Company details for a stock symbol.
GET
/v1/stocks/ticker-detailsstocksTickerDetailsDescribes the company behind a symbol: name, description, listing date, market capitalization, shares outstanding, industry classification (SIC code and text) with an approximate market sector, employees, headquarters and website. Market capitalization is the latest close times weighted shares outstanding and is refreshed daily.
Example request
curl -sS --get "https://api.ordermap.si/v1/stocks/ticker-details" \
-H "Authorization: Bearer $ORDERMAP_API_KEY" \
--data-urlencode symbol=AAPLconst params = new URLSearchParams({
symbol: "AAPL",
});
const res = await fetch(`https://api.ordermap.si/v1/stocks/ticker-details?${params}`, {
headers: { Authorization: `Bearer ${process.env.ORDERMAP_API_KEY}` },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data, meta } = await res.json();
console.log(data, meta.coverage);Set ORDERMAP_API_KEY to your key. Replace the dates with a recent trading date.
Parameters
1 parameter, 1 required.
| Parameter | Type and limits | Description |
|---|---|---|
symbolqueryrequired | stringat most 11 characterspattern ^[A-Za-z]{1,6}(\.[A-Za-z0-9]{1,4})?$ | Ticker symbol, for example AAPL. |
Response
| Status | Meaning | Body |
|---|---|---|
200 | Successful response. | Schema below |
400 | Invalid, unknown or repeated parameters, or an invalid cursor. | Error object |
401 | Missing or invalid API key. | Error object |
403 | The plan, dataset release or account state does not allow this request. | Error object |
422 | The request is valid but no data exists for it. | Error object |
429 | Rate limit, burst limit or cooldown; wait Retry-After seconds.Retry-After | Error object |
500 | Internal error. | Error object |
503 | Data temporarily unavailable; retry after Retry-After seconds.Retry-After | Error object |
504 | The request timed out. | Error object |
Authenticated responses carry the X-RateLimit-* headers (see rate limits); 429 and 503 add Retry-After.
200 response body
dataobjectrequiredCompany details.32 fields insideactivebooleanrequiredThe security is actively traded.addressobject | nullrequiredHeadquarters address.5 fields insideaddress1string | nullFirst address line.address2string | nullSecond address line.citystring | nullCity.postal_codestring | nullPostal code.statestring | nullState.
cikstring | nullrequiredSEC central index key.composite_figistring | nullrequiredComposite FIGI identifier.currencystring | nullrequiredTrading currency, ISO 4217.delisted_timestampinteger | nullunix-msrequiredLast time the security traded, when delisted. Unix epoch milliseconds (UTC).descriptionstring | nullrequiredWhat the company does.homepage_urlstring | nullrequiredCompany website.list_datestring | nulldaterequiredFirst public listing date.localestringrequiredLocale of the listing.marketstringrequiredMarket the security trades in.market_capnumber | nullrequiredMarket capitalization in dollars.namestringrequiredRegistered company name.phone_numberstring | nullrequiredCompany phone number.primary_exchangestring | nullrequiredMarket identifier code of the primary listing exchange.round_lotnumber | nullrequiredRound lot size.sectorstring | nullrequiredApproximate market sector derived from the SIC code.share_class_figistring | nullrequiredShare class FIGI identifier.share_class_shares_outstandingnumber | nullrequiredShares outstanding of this share class.sic_codestring | nullrequiredStandard industrial classification code.sic_descriptionstring | nullrequiredText of the SIC code.symbolstringrequiredTicker symbol.ticker_rootstring | nullrequiredRoot of the symbol, BRK for BRK.B.ticker_suffixstring | nullrequiredShare class suffix of the symbol, B for BRK.B.total_employeesnumber | nullrequiredApproximate number of employees.typestring | nullrequiredSecurity type, for example CS.weighted_shares_outstandingnumber | nullrequiredShares outstanding with every share class converted to this class.
metaobjectrequiredMeta object
Example response
{
"data": {
"active": true,
"address": {
"address1": "One Apple Park Way",
"address2": null,
"city": "Cupertino",
"postal_code": "95014",
"state": "CA"
},
"cik": "0000320193",
"composite_figi": "BBG000B9XRY4",
"currency": "USD",
"delisted_timestamp": null,
"description": "Designs and sells consumer electronics, software and services.",
"homepage_url": "https://www.apple.com",
"list_date": "1980-12-12",
"locale": "us",
"market": "stocks",
"market_cap": 3500000000000,
"name": "Apple Inc.",
"phone_number": "(408) 996-1010",
"primary_exchange": "XNAS",
"round_lot": 100,
"sector": "Information Technology",
"share_class_figi": "BBG001S5N8V8",
"share_class_shares_outstanding": 14900000000,
"sic_code": "3571",
"sic_description": "ELECTRONIC COMPUTERS",
"symbol": "AAPL",
"ticker_root": "AAPL",
"ticker_suffix": null,
"total_employees": 164000,
"type": "CS",
"weighted_shares_outstanding": 14900000000
},
"meta": {
"as_of": 1760659200123,
"coverage": {
"complete": true
},
"delay_ms": 0,
"delayed": false,
"request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
"source": "sip"
}
}Values are illustrative. Missing values are null, never 0.