Retrieve Brand by Ticker
Look up brand data using a stock ticker symbol.
Endpoint: GET /v1/brand/retrieve-by-ticker
Credits: 10 per request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ticker | string | Yes | Stock ticker symbol (e.g., AAPL, GOOG, MSFT) |
Response Schema
{
"data": {
"id": "...",
"domain": "apple.com",
"title": "Apple",
"description": "Apple designs, manufactures, and markets smartphones, personal computers, and accessories.",
"logos": { "primary": "...", "favicon": "..." },
"colors": { "primary": "#000000" },
"industries": ["Consumer Electronics"],
"socialLinks": { "twitter": "https://twitter.com/Apple" }
},
"_meta": {}
}Code Examples
cURL
curl -X GET "https://api.orsa.dev/v1/brand/retrieve-by-ticker?ticker=AAPL" \
-H "Authorization: Bearer YOUR_API_KEY"TypeScript
const { data: brand } = await client.brand.retrieveByTicker({
ticker: 'AAPL',
});
console.log(brand.title); // "Apple"
console.log(brand.domain); // "apple.com"
console.log(brand.industries); // ["Consumer Electronics"]Python
res = client.brand.retrieve_by_ticker(ticker="AAPL")
brand = res["data"]
print(brand["title"]) # "Apple"
print(brand["domain"]) # "apple.com"
print(brand["industries"]) # ["Consumer Electronics"]Error Codes
| Code | Status | Description |
|---|---|---|
INPUT_VALIDATION_ERROR | 400 | Missing or empty ticker parameter |
UNAUTHORIZED | 401 | Missing or invalid API key |
NOT_FOUND | 404 | No brand found for the given ticker symbol |
RATE_LIMITED | 429 | Rate limit exceeded |
USAGE_EXCEEDED | 402 | Insufficient credits |
Notes
- Ticker symbols are case-insensitive (
aaplandAAPLboth work). - Only brands that have been indexed with ticker data will return results. If you know the domain, use Retrieve by Domain instead.