> ## Documentation Index > Fetch the complete documentation index at: https://deepline.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Context.dev: Contextdev Get Brand Retrieve > Retrieve brand data by domain. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost. Retrieve brand data by domain. > [!NOTE] > > Tool ID: `contextdev_get_brand_retrieve` ## Run this action Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing. ```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} import { Deepline } from 'deepline'; const deepline = await Deepline.connect(); const result = await deepline.tools.execute( 'contextdev_get_brand_retrieve', { "domain": "example.com", "name": "Example", "ticker": "example" }, ); console.log(result.toolResponse.raw); ``` ### CLI ```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} deepline tools execute contextdev_get_brand_retrieve --input '{ "domain": "example.com", "name": "Example", "ticker": "example" }' --json ``` ## Example response The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response. ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} { "data": { "status": "example", "brand": { "domain": "example.com", "title": "VP of Engineering", "description": "Example description" }, "code": 123 } } ``` Use `deepline describe contextdev_get_brand_retrieve --json` for the latest machine-readable contract. ## Input reference Retrieve logos, backdrops, colors, industry, description, and more from any domain | Name | Type | Required | Default | Details | | - | - | - | - | - | | `payload.domain` | `string` | No | — | Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cannot be used with name or ticker parameters. Minimum length: 3. | | `payload.name` | `string` | No | — | Company name to retrieve brand data for (e.g., 'Apple Inc'). Cannot be used with domain or ticker parameters. Minimum length: 3. Maximum length: 30. | | `payload.ticker` | `string` | No | — | Stock ticker symbol to retrieve brand data for (e.g., 'AAPL'). Cannot be used with domain or name parameters. Minimum length: 1. Maximum length: 15. Pattern: `^[A-Za-z0-9.]+$`. | | `payload.ticker_exchange` | `"AMEX" \| "AMS" \| "AQS" \| "ASX" \| "ATH" \| "BER" \| "BME" \| "BRU" \| "BSE" \| "BUD" \| "BUE" \| "BVC" \| "CBOE" \| "CNQ" \| "CPH" \| "DFM" \| "DOH" \| "DUB" \| "DUS" \| "DXE" \| "EGX" \| "FSX" \| "HAM" \| "HEL" \| "HKSE" \| "HOSE" \| "ICE" \| "IOB" \| "IST" \| "JKT" \| "JNB" \| "JPX" \| "KLS" \| "KOE" \| "KSC" \| "KUW" \| "LIS" \| "LSE" \| "MCX" \| "MEX" \| "MIL" \| "MUN" \| "NASDAQ" \| "NEO" \| "NSE" \| "NYSE" \| "NZE" \| "OSL" \| "OTC" \| "PAR" \| "PNK" \| "PRA" \| "RIS" \| "SAO" \| "SAU" \| "SES" \| "SET" \| "SGO" \| "SHH" \| "SHZ" \| "SIX" \| "STO" \| "STU" \| "TAI" \| "TAL" \| "TLV" \| "TSX" \| "TSXV" \| "TWO" \| "VIE" \| "WSE" \| "XETRA"` | No | — | Stock exchange code. Allowed: `AMEX`, `AMS`, `AQS`, `ASX`, `ATH`, `BER`, `BME`, `BRU`, `BSE`, `BUD`, `BUE`, `BVC`, `CBOE`, `CNQ`, `CPH`, `DFM`, `DOH`, `DUB`, `DUS`, `DXE`, `EGX`, `FSX`, `HAM`, `HEL`, `HKSE`, `HOSE`, `ICE`, `IOB`, `IST`, `JKT`, `JNB`, `JPX`, `KLS`, `KOE`, `KSC`, `KUW`, `LIS`, `LSE`, `MCX`, `MEX`, `MIL`, `MUN`, `NASDAQ`, `NEO`, `NSE`, `NYSE`, `NZE`, `OSL`, `OTC`, `PAR`, `PNK`, `PRA`, `RIS`, `SAO`, `SAU`, `SES`, `SET`, `SGO`, `SHH`, `SHZ`, `SIX`, `STO`, `STU`, `TAI`, `TAL`, `TLV`, See the live schema for the complete constraint. | | `payload.force_language` | `"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"` | No | — | Language to force for the retrieved brand data. Allowed: `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`, See the live schema for the complete constraint. | | `payload.maxSpeed` | `boolean` | No | `false` | Optional parameter to optimize the API call for maximum speed. Works with all three lookup methods. | | `payload.maxAgeMs` | `integer` | No | `7776000000` | Maximum age in milliseconds for cached brand data before the API performs a hard refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) are clamped to 1 day. values above 1 year (31536000000 ms) are clamped to 1 year. | | `payload.timeoutMS` | `integer` | No | — | Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes). Minimum: 1000. Maximum: 300000. | | `payload.tags` | `array` | No | — | Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters. Maximum items: 20. |
Show raw input schema ### Input JSON Schema ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} { "type": "object", "description": "Retrieve logos, backdrops, colors, industry, description, and more from any domain", "properties": { "domain": { "type": "string", "description": "Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cannot be used with name or ticker parameters.", "minLength": 3 }, "name": { "type": "string", "description": "Company name to retrieve brand data for (e.g., 'Apple Inc'). Cannot be used with domain or ticker parameters.", "minLength": 3, "maxLength": 30 }, "ticker": { "type": "string", "description": "Stock ticker symbol to retrieve brand data for (e.g., 'AAPL'). Cannot be used with domain or name parameters.", "minLength": 1, "maxLength": 15, "pattern": "^[A-Za-z0-9.]+$" }, "ticker_exchange": { "type": "string", "description": "Stock exchange code.", "enum": [ "AMEX", "AMS", "AQS", "ASX", "ATH", "BER", "BME", "BRU", "BSE", "BUD", "BUE", "BVC", "CBOE", "CNQ", "CPH", "DFM", "DOH", "DUB", "DUS", "DXE", "EGX", "FSX", "HAM", "HEL", "HKSE", "HOSE", "ICE", "IOB", "IST", "JKT", "JNB", "JPX", "KLS", "KOE", "KSC", "KUW", "LIS", "LSE", "MCX", "MEX", "MIL", "MUN", "NASDAQ", "NEO", "NSE", "NYSE", "NZE", "OSL", "OTC", "PAR", "PNK", "PRA", "RIS", "SAO", "SAU", "SES", "SET", "SGO", "SHH", "SHZ", "SIX", "STO", "STU", "TAI", "TAL", "TLV", "TSX", "TSXV", "TWO", "VIE", "WSE", "XETRA" ] }, "force_language": { "type": [ "string", "null" ], "description": "Language to force for the retrieved brand data.", "enum": [ "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" ] }, "maxSpeed": { "type": "boolean", "description": "Optional parameter to optimize the API call for maximum speed. Works with all three lookup methods.", "default": false }, "maxAgeMs": { "type": [ "integer", "null" ], "description": "Maximum age in milliseconds for cached brand data before the API performs a hard refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 year.", "default": 7776000000 }, "timeoutMS": { "type": "integer", "description": "Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).", "minimum": 1000, "maximum": 300000 }, "tags": { "type": "array", "description": "Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.", "maxItems": 20, "items": { "type": "string", "minLength": 1, "maxLength": 50 } } }, "required": [], "additionalProperties": false } ```
## Output reference | Name | Type | Required | Default | Details | | - | - | - | - | - | | `result.data` | `object` | Yes | — | — | | `result.data.status` | `string` | No | — | — | | `result.data.brand` | `object` | No | — | — | | `result.data.brand.domain` | `string` | No | — | — | | `result.data.brand.title` | `string` | No | — | — | | `result.data.brand.description` | `string` | No | — | — | | `result.data.brand.slogan` | `string` | No | — | — | | `result.data.brand.colors` | `array` | No | — | — | | `result.data.brand.colors[].hex` | `string` | No | — | — | | `result.data.brand.colors[].name` | `string` | No | — | — | | `result.data.brand.logos` | `array` | No | — | — | | `result.data.brand.logos[].url` | `string` | No | — | — | | `result.data.brand.logos[].mode` | `"light" \| "dark" \| "has_opaque_background"` | No | — | Allowed: `light`, `dark`, `has_opaque_background`. | | `result.data.brand.logos[].colors` | `array` | No | — | — | | `result.data.brand.logos[].colors[].hex` | `string` | No | — | — | | `result.data.brand.logos[].colors[].name` | `string` | No | — | — | | `result.data.brand.logos[].resolution` | `object` | No | — | — | | `result.data.brand.logos[].resolution.width` | `integer` | No | — | — | | `result.data.brand.logos[].resolution.height` | `integer` | No | — | — | | `result.data.brand.logos[].resolution.aspect_ratio` | `number` | No | — | — | | `result.data.brand.logos[].type` | `"icon" \| "logo"` | No | — | Allowed: `icon`, `logo`. | | `result.data.brand.backdrops` | `array` | No | — | — | | `result.data.brand.backdrops[].url` | `string` | No | — | — | | `result.data.brand.backdrops[].colors` | `array` | No | — | — | | `result.data.brand.backdrops[].colors[].hex` | `string` | No | — | — | | `result.data.brand.backdrops[].colors[].name` | `string` | No | — | — | | `result.data.brand.backdrops[].resolution` | `object` | No | — | — | | `result.data.brand.backdrops[].resolution.width` | `integer` | No | — | — | | `result.data.brand.backdrops[].resolution.height` | `integer` | No | — | — | | `result.data.brand.backdrops[].resolution.aspect_ratio` | `number` | No | — | — | | `result.data.brand.socials` | `array` | No | — | — | | `result.data.brand.socials[].type` | `"x" \| "facebook" \| "instagram" \| "linkedin" \| "youtube" \| "pinterest" \| "tiktok" \| "dribbble" \| "github" \| "behance" \| "snapchat" \| "whatsapp" \| "telegram" \| "line" \| "discord" \| "twitch" \| "vimeo" \| "imdb" \| "tumblr" \| "flickr" \| "giphy" \| "medium" \| "spotify" \| "soundcloud" \| "tripadvisor" \| "yelp" \| "producthunt" \| "reddit" \| "crunchbase" \| "appstore" \| "playstore"` | No | — | Allowed: `x`, `facebook`, `instagram`, `linkedin`, `youtube`, `pinterest`, `tiktok`, `dribbble`, `github`, `behance`, `snapchat`, `whatsapp`, `telegram`, `line`, `discord`, `twitch`, `vimeo`, `imdb`, `tumblr`, `flickr`, `giphy`, `medium`, `spotify`, `soundcloud`, `tripadvisor`, `yelp`, `producthunt`, `reddit`, `crunchbase`, `appstore`, `playstore`. | | `result.data.brand.socials[].url` | `string` | No | — | — | | `result.data.brand.address` | `object` | No | — | — | | `result.data.brand.address.street` | `string` | No | — | — | | `result.data.brand.address.city` | `string` | No | — | — | | `result.data.brand.address.country` | `string` | No | — | — | | `result.data.brand.address.country_code` | `string` | No | — | — | | `result.data.brand.address.state_province` | `string` | No | — | — | | `result.data.brand.address.state_code` | `string` | No | — | — | | `result.data.brand.address.postal_code` | `string` | No | — | — | | `result.data.brand.stock` | `object` | No | — | — | | `result.data.brand.stock.ticker` | `string` | No | — | — | | `result.data.brand.stock.exchange` | `string` | No | — | — | | `result.data.brand.employees` | `object` | No | — | — | | `result.data.brand.employees.range` | `"1 to 10" \| "11 to 50" \| "51 to 200" \| "201 to 500" \| "501 to 1000" \| "1001 to 5000" \| "5001 to 10000" \| "10001+"` | No | — | Allowed: `1 to 10`, `11 to 50`, `51 to 200`, `201 to 500`, `501 to 1000`, `1001 to 5000`, `5001 to 10000`, `10001+`. | | `result.data.brand.employees.exact` | `integer` | No | — | — | | `result.data.brand.is_nsfw` | `boolean` | No | — | — | | `result.data.brand.email` | `string` | No | — | — | | `result.data.brand.phone` | `string` | No | — | — | The table shows the first 50 fields. Use the live contract below for every field. > [!NOTE] > > This output schema is too large for an inline display. Read the complete live contract with `deepline describe contextdev_get_brand_retrieve --json`. ## Deepline cost * Pricing model: `provider_usage` (provider usage). * Estimated Deepline credits: `0.01` per pricing unit. ## Related documentation * [Context.dev provider guide](https://deepline.com/docs/providers/contextdev/guide.md) * [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md) * [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md) * [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.