curl --request POST \
--url https://api.context.dev/v1/brand/retrieve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "by_domain",
"domain": "stripe.com"
}
'{
"cache_metadata": {
"status": "hit",
"age_ms": 1
},
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"partial": true,
"status": "<string>",
"brand": {
"domain": "<string>",
"title": "<string>",
"description": "<string>",
"slogan": "<string>",
"colors": [
{
"hex": "<string>",
"name": "<string>",
"source": "site"
}
],
"logos": [
{
"url": "<string>",
"mode": "light",
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"resolution": {
"width": 123,
"height": 123,
"aspect_ratio": 123
},
"type": "icon"
}
],
"backdrops": [
{
"url": "<string>",
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"resolution": {
"width": 123,
"height": 123,
"aspect_ratio": 123
}
}
],
"socials": [
{
"type": "x",
"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>"
},
"employees": {
"range": "1 to 10",
"exact": 123
},
"is_nsfw": true,
"email": "<string>",
"phone": "<string>",
"industries": {
"eic": [
{
"industry": "Aerospace & Defense",
"subindustry": "Defense Systems & Military Hardware"
}
]
},
"links": {
"careers": "<string>",
"privacy": "<string>",
"terms": "<string>",
"contact": "<string>",
"blog": "<string>",
"pricing": "<string>"
},
"primary_language": "afrikaans"
},
"code": 123,
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"message": "<string>",
"error_code": "INTERNAL_ERROR",
"required_permission": "logs:read",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"message": "<string>",
"error_code": "INTERNAL_ERROR",
"required_permission": "logs:read",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"message": "<string>",
"error_code": "INTERNAL_ERROR",
"required_permission": "logs:read",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"message": "<string>",
"error_code": "INTERNAL_ERROR",
"required_permission": "logs:read",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"error_code": "RATE_LIMITED",
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}Retrieve Brand Data
Enrich signups, CRM records, and transactions with logos, colors, descriptions, socials, and industry data.
curl --request POST \
--url https://api.context.dev/v1/brand/retrieve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "by_domain",
"domain": "stripe.com"
}
'{
"cache_metadata": {
"status": "hit",
"age_ms": 1
},
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"partial": true,
"status": "<string>",
"brand": {
"domain": "<string>",
"title": "<string>",
"description": "<string>",
"slogan": "<string>",
"colors": [
{
"hex": "<string>",
"name": "<string>",
"source": "site"
}
],
"logos": [
{
"url": "<string>",
"mode": "light",
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"resolution": {
"width": 123,
"height": 123,
"aspect_ratio": 123
},
"type": "icon"
}
],
"backdrops": [
{
"url": "<string>",
"colors": [
{
"hex": "<string>",
"name": "<string>"
}
],
"resolution": {
"width": 123,
"height": 123,
"aspect_ratio": 123
}
}
],
"socials": [
{
"type": "x",
"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>"
},
"employees": {
"range": "1 to 10",
"exact": 123
},
"is_nsfw": true,
"email": "<string>",
"phone": "<string>",
"industries": {
"eic": [
{
"industry": "Aerospace & Defense",
"subindustry": "Defense Systems & Military Hardware"
}
]
},
"links": {
"careers": "<string>",
"privacy": "<string>",
"terms": "<string>",
"contact": "<string>",
"blog": "<string>",
"pricing": "<string>"
},
"primary_language": "afrikaans"
},
"code": 123,
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"message": "<string>",
"error_code": "INTERNAL_ERROR",
"required_permission": "logs:read",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"message": "<string>",
"error_code": "INTERNAL_ERROR",
"required_permission": "logs:read",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"message": "<string>",
"error_code": "INTERNAL_ERROR",
"required_permission": "logs:read",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"message": "<string>",
"error_code": "INTERNAL_ERROR",
"required_permission": "logs:read",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}{
"message": "<string>",
"error_code": "RATE_LIMITED",
"request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
"key_metadata": {
"credits_consumed": 123,
"credits_remaining": 123
}
}Authorizations
Bearer authentication header of the form Bearer <API_KEY>. Keys have full access by default.
Body
- By domain
- By name
- By email
- By stock
- By direct URL
- By transaction
Exactly one lookup type must be provided.
Discriminator for domain-based brand retrieval.
by_domain Domain name to retrieve brand data for (e.g., 'stripe.com').
3Language to force for the retrieved brand data.
afrikaans, albanian, amharic, arabic, armenian, assamese, aymara, azeri, basque, belarusian, bengali, bosnian, bulgarian, burmese, cantonese, catalan, cebuano, chinese, corsican, croatian, czech, danish, dutch, english, esperanto, estonian, farsi, fijian, finnish, french, galician, georgian, german, greek, guarani, gujarati, haitian-creole, hausa, hawaiian, hebrew, hindi, hmong, hungarian, icelandic, igbo, indonesian, irish, italian, japanese, javanese, kannada, kazakh, khmer, kinyarwanda, korean, kurdish, kyrgyz, lao, latin, latvian, lingala, lithuanian, luxembourgish, macedonian, malagasy, malay, malayalam, maltese, maori, marathi, mongolian, nepali, norwegian, odia, oromo, pashto, pidgin, polish, portuguese, punjabi, quechua, romanian, russian, samoan, scottish-gaelic, serbian, sesotho, shona, sindhi, sinhala, slovak, slovene, somali, spanish, sundanese, swahili, swedish, tagalog, tajik, tamil, tatar, telugu, thai, tibetan, tigrinya, tongan, tswana, turkish, turkmen, ukrainian, urdu, uyghur, uzbek, vietnamese, welsh, wolof, xhosa, yiddish, yoruba, zulu Optional parameter to optimize the API call for maximum speed. When set to true, the API will skip time-consuming operations for faster response at the cost of less comprehensive data.
Maximum age in milliseconds for cached brand data before the API performs a hard refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms) are clamped to 1 year.
Optional request deadline and behavior on timeout. For GET requests, use timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded timeoutOpts object.
Show child attributes
Show child attributes
Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
201 - 50["production", "team-alpha"]
Response
Successful response
Cache outcome for this response. Composite responses are hits only when every cache-controlled fetch contributing to the output was a hit; age_ms is the oldest contributing hit.
Show child attributes
Show child attributes
Unique id of this API call, also sent in the X-Request-Id response header. Quote it when contacting support about a failed request.
"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"
True when the timeout ended processing and this response contains the usable data completed so far. Unfinished fields are omitted.
Status of the response, e.g., 'ok'
Detailed brand information
Show child attributes
Show child attributes
HTTP status code
Credit usage, included whenever a valid API key is provided.
Show child attributes
Show child attributes
Was this page helpful?