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
{
"success": true,
"data": {
"name": "Apple",
"domain": "apple.com",
"description": "Apple designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide.",
"logos": [
{
"url": "https://cdn.orsa.dev/logos/apple-dark.svg",
"type": "svg",
"theme": "dark",
"width": 80,
"height": 80
}
],
"colors": ["#000000", "#F5F5F7", "#0071E3"],
"fonts": ["SF Pro Display", "SF Pro Text"],
"industry": "Consumer Electronics",
"stock_ticker": "AAPL",
"socials": {
"twitter": "https://twitter.com/Apple",
"youtube": "https://youtube.com/@Apple"
}
},
"credits_used": 10,
"request_id": "c3d4e5f6-a7b8-9012-cdef-123456789012"
}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 brand = await client.brand.retrieveByTicker({
ticker: 'AAPL',
});
console.log(brand.name); // "Apple"
console.log(brand.domain); // "apple.com"
console.log(brand.industry); // "Consumer Electronics"Python
brand = client.brand.retrieve_by_ticker(ticker="AAPL")
print(brand.name) # "Apple"
print(brand.domain) # "apple.com"
print(brand.industry) # "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). - Supports US exchanges (NYSE, NASDAQ) and major international exchanges.
- Maximum ticker length is 10 characters.
- Only brands that have been indexed with ticker data will return results. If you know the domain, use Retrieve by Domain instead.