BrandDev
Retrieve brand data by stock ticker (e.g. AAPL, TSLA, etc.)
GET
/
brand
/
retrieve-by-ticker
import BrandDev from 'brand.dev';
const client = new BrandDev({
apiKey: process.env['BRAND_DEV_API_KEY'], // This is the default and can be omitted
});
async function main() {
const response = await client.brand.retrieveByTicker({ ticker: 'ticker' });
console.log(response.brand);
}
main();
{
"status": "<string>",
"brand": {
"domain": "<string>",
"title": "<string>",
"description": "<string>",
"slogan": "<string>",
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"logos": [
{
"url": "<string>",
"mode": "<string>",
"group": 123,
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"resolution": {
"width": 123,
"height": 123
}
}
],
"backdrops": [
{
"url": "<string>",
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"resolution": {
"width": 123,
"height": 123
}
}
],
"socials": [
{
"type": "<string>",
"url": "<string>"
}
],
"address": {
"street": "<string>",
"city": "<string>",
"country": "<string>",
"country_code": "<string>",
"state_province": "<string>",
"state_code": "<string>",
"postal_code": "<string>"
},
"stock": {
"ticker": "<string>",
"exchange": "<string>"
},
"fonts": [
{
"usage": "<string>",
"name": "<string>"
}
]
},
"code": 123
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
Response
200
application/json
Successful response
The response is of type object
.
Was this page helpful?
import BrandDev from 'brand.dev';
const client = new BrandDev({
apiKey: process.env['BRAND_DEV_API_KEY'], // This is the default and can be omitted
});
async function main() {
const response = await client.brand.retrieveByTicker({ ticker: 'ticker' });
console.log(response.brand);
}
main();
{
"status": "<string>",
"brand": {
"domain": "<string>",
"title": "<string>",
"description": "<string>",
"slogan": "<string>",
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"logos": [
{
"url": "<string>",
"mode": "<string>",
"group": 123,
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"resolution": {
"width": 123,
"height": 123
}
}
],
"backdrops": [
{
"url": "<string>",
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"resolution": {
"width": 123,
"height": 123
}
}
],
"socials": [
{
"type": "<string>",
"url": "<string>"
}
],
"address": {
"street": "<string>",
"city": "<string>",
"country": "<string>",
"country_code": "<string>",
"state_province": "<string>",
"state_code": "<string>",
"postal_code": "<string>"
},
"stock": {
"ticker": "<string>",
"exchange": "<string>"
},
"fonts": [
{
"usage": "<string>",
"name": "<string>"
}
]
},
"code": 123
}
Assistant
Responses are generated using AI and may contain mistakes.