GET /v1/profile

GET /v1/profile

Returns the static company profile for a symbol: name, sector, industry, country, website, employee count, and the full set of cross-system identifiers.

Request

GET /v1/profile?symbol=AAPL HTTP/1.1
Host: api.oneapi.finance
Authorization: Bearer oa_live_<your_key>

Query parameters

Param	Type	Required	Notes
symbol	string	yes	Single symbol.
exchange	string	no	Disambiguate cross-listed tickers.

Response

{
  "symbol": "AAPL",
  "name": "Apple Inc.",
  "exchange": "NASDAQ",
  "sector": "Technology",
  "industry": "Consumer Electronics",
  "description": "Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide.",
  "website": "https://www.apple.com",
  "ceo": "Tim Cook",
  "employees": 161000,
  "country": "US",
  "address": "One Apple Park Way, Cupertino, CA 95014, United States",
  "phone": "+1-408-996-1010",
  "isin": "US0378331005",
  "figi": "BBG000B9XRY4",
  "cik": "0000320193"
}

Field reference

Field	Type	Notes
symbol	string	Normalized to uppercase.
name	string | null	Display name of the issuer.
exchange	string | null	Canonical exchange code.
sector	string | null	GICS-style sector.
industry	string | null	GICS-style industry.
description	string | null	Plain-text business description.
website	string | null	Primary corporate URL.
ceo	string | null	Most recent disclosed CEO name.
employees	integer | null	Most recent disclosed headcount.
country	string | null	ISO 3166-1 alpha-2 country code.
address	string | null	Free-form mailing address.
phone	string | null	Free-form phone.
isin	string | null	ISO 6166.
figi	string | null	OpenFIGI/Bloomberg.
cik	string | null	SEC CIK. US issuers only.

The wire-format model is oneapi_core.responses.profile.ProfileResponse.

Profile data refreshes roughly weekly. Identifier fields (isin, figi, cik) are essentially static once resolved.

Examples

curl

curl -H "Authorization: Bearer oa_live_..." \
  "https://api.oneapi.finance/v1/profile?symbol=AAPL"

Python

import httpx, os

r = httpx.get(
    "https://api.oneapi.finance/v1/profile",
    params={"symbol": "AAPL"},
    headers={"Authorization": f"Bearer {os.environ['ONEAPI_KEY']}"},
    timeout=10.0,
)
r.raise_for_status()
profile = r.json()
print(profile["name"], profile["sector"], profile["isin"])

JavaScript

const r = await fetch(
  "https://api.oneapi.finance/v1/profile?symbol=AAPL",
  { headers: { Authorization: `Bearer ${process.env.ONEAPI_KEY}` } },
);
const profile = await r.json();
console.log(profile.name, profile.sector, profile.isin);

Errors

Status	code	When
401	unauthenticated	Missing or invalid API key.
404	not_found	Symbol unknown.
429	rate_limit	See rate limits.
502	upstream_failure	All sources failed.

See also

• Instruments concept — what each identifier means.
• GET /v1/symbol_search — fuzzy lookup by name or identifier.