|
| 1 | +# n8n-nodes-branddev |
| 2 | + |
| 3 | +This is an n8n community node that lets you interact with the [Brand.dev API](https://brand.dev) in your n8n workflows. |
| 4 | + |
| 5 | +Brand.dev provides comprehensive brand data including logos, colors, fonts, screenshots, styleguides, and company information for millions of brands worldwide. |
| 6 | + |
| 7 | +[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/sustainable-use-license/) workflow automation platform. |
| 8 | + |
| 9 | +[Installation](#installation) | [Operations](#operations) | [Credentials](#credentials) | [Compatibility](#compatibility) | [Resources](#resources) |
| 10 | + |
| 11 | +## Installation |
| 12 | + |
| 13 | +Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation. |
| 14 | + |
| 15 | +For the n8n desktop app, go to **Settings** > **Community Nodes** and search for `n8n-nodes-branddev`. |
| 16 | + |
| 17 | +## Operations |
| 18 | + |
| 19 | +This node supports the following resources and operations: |
| 20 | + |
| 21 | +### Brand |
| 22 | +- **Retrieve by Domain** - Get brand information by domain name |
| 23 | + - Returns logos, colors, fonts, company info, social media, and more |
| 24 | + - Supports 50+ languages via `force_language` parameter |
| 25 | + - Optional speed optimization for faster responses |
| 26 | + - Configurable timeout (1-300,000ms) |
| 27 | + |
| 28 | +- **Retrieve by Company Name** - Search for a company by name and retrieve brand data |
| 29 | + - Fuzzy search for company names (3-30 characters) |
| 30 | + - Returns comprehensive brand data |
| 31 | + |
| 32 | +- **Retrieve by Email** - Extract domain from email and retrieve brand data |
| 33 | + - Excludes free email providers (gmail.com, yahoo.com, etc.) |
| 34 | + - Blocks disposable email addresses |
| 35 | + |
| 36 | +- **Retrieve by Stock Ticker** - Look up company by stock ticker symbol |
| 37 | + - Supports 30+ global stock exchanges (NASDAQ, NYSE, LSE, JPX, HKSE, etc.) |
| 38 | + - Configurable exchange via `ticker_exchange` parameter |
| 39 | + |
| 40 | +- **Retrieve by ISIN** - Look up company by International Securities Identification Number |
| 41 | + - Global securities identification |
| 42 | + - Returns full brand data |
| 43 | + |
| 44 | +### Industry Classification (NAICS) |
| 45 | +- **Classify Brand** - Get NAICS (North American Industry Classification System) codes for any brand |
| 46 | + - Accepts domain or company name as input |
| 47 | + - Returns 1-10 NAICS codes with confidence scores |
| 48 | + - Configurable min/max results |
| 49 | + - Supports detailed 6-digit NAICS codes |
| 50 | + |
| 51 | +### Screenshot / Styleguide |
| 52 | +- **Take Screenshot** - Capture a viewport or full-page screenshot of any website |
| 53 | + - Viewport or full-page screenshots |
| 54 | + - Specific page types (login, pricing, careers, contact, blog, etc.) |
| 55 | + - Quality vs speed optimization |
| 56 | + - Returns high-quality screenshot URL |
| 57 | + |
| 58 | +- **Extract Styleguide** - Extract comprehensive design system including colors, typography, spacing, shadows, and components |
| 59 | + - Color palettes with usage statistics |
| 60 | + - Typography scales and font information |
| 61 | + - Spacing and sizing systems |
| 62 | + - Box shadows and border radius values |
| 63 | + - Component patterns and styles |
| 64 | + |
| 65 | +- **Extract Fonts** - Get detailed font information including families, usage statistics, and fallbacks |
| 66 | + - Font family detection |
| 67 | + - Usage statistics (element count, word count) |
| 68 | + - Fallback chains |
| 69 | + - Font weights and styles |
| 70 | + |
| 71 | +## Credentials |
| 72 | + |
| 73 | +To use this node, you need a Brand.dev API key: |
| 74 | + |
| 75 | +1. Sign up for a free account at [Brand.dev](https://brand.dev) |
| 76 | +2. Navigate to your [API settings](https://brand.dev/dashboard/settings/api) |
| 77 | +3. Generate a new API key (starts with `sk_live_...`) |
| 78 | +4. In n8n, create new credentials: |
| 79 | + - Go to **Credentials** > **New** |
| 80 | + - Search for "Brand.dev API" |
| 81 | + - Paste your API key |
| 82 | + |
| 83 | +The node will automatically test the credentials by making a test request to the Brand.dev API. |
| 84 | + |
| 85 | +## Compatibility |
| 86 | + |
| 87 | +This node has been tested with: |
| 88 | +- n8n version 1.0.0 and above |
| 89 | +- Requires n8n-workflow as a peer dependency |
| 90 | + |
| 91 | +## Usage |
| 92 | + |
| 93 | +### Example: Get Brand Logos and Colors |
| 94 | + |
| 95 | +1. Add the Brand.dev node to your workflow |
| 96 | +2. Select **Brand** as the resource |
| 97 | +3. Choose **Retrieve by Domain** operation |
| 98 | +4. Enter a domain (e.g., `stripe.com`) |
| 99 | +5. The node returns comprehensive brand data including: |
| 100 | + - Logos (SVG, PNG formats with different variations) |
| 101 | + - Brand colors (primary, accent, background) |
| 102 | + - Company information |
| 103 | + - Social media links |
| 104 | + |
| 105 | +### Example: Take Website Screenshots |
| 106 | + |
| 107 | +1. Select **Screenshot / Styleguide** as the resource |
| 108 | +2. Choose **Take Screenshot** operation |
| 109 | +3. Enter a domain and optionally enable full-page screenshot |
| 110 | +4. Get a high-quality screenshot URL |
| 111 | + |
| 112 | +### Tips |
| 113 | + |
| 114 | +- Use the **Additional Fields** to customize API requests with optional parameters |
| 115 | +- Combine with other n8n nodes to enrich your data pipelines |
| 116 | +- The node supports n8n's usable as AI tool feature for AI-powered workflows |
| 117 | + |
| 118 | +## Resources |
| 119 | + |
| 120 | +- [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/) |
| 121 | +- [Brand.dev API Documentation](https://docs.brand.dev) |
| 122 | +- [Brand.dev API Reference](https://docs.brand.dev/api-reference) |
| 123 | +- [GitHub Repository](https://github.com/nikhilrado/brand-dev-n8n) |
| 124 | + |
| 125 | +## License |
| 126 | + |
| 127 | +MIT |
0 commit comments