Brand.dev - Brand Intelligence API

Setup

Read your credentials from ~/.gooseworks/credentials.json:

export GOOSEWORKS_API_KEY=$(python3 -c "import json;print(json.load(open('$HOME/.gooseworks/credentials.json'))['api_key'])")
export GOOSEWORKS_API_BASE=$(python3 -c "import json;print(json.load(open('$HOME/.gooseworks/credentials.json')).get('api_base','https://api.gooseworks.ai'))")

If ~/.gooseworks/credentials.json does not exist, tell the user to run: npx gooseworks login

All endpoints use Bearer auth: -H "Authorization: Bearer $GOOSEWORKS_API_KEY"

Extract comprehensive brand information from any domain - logos, colors, fonts, and more.

Capabilities

• Extract fonts from website: Extract font information from a brand’s website including font families, usage statistics, fallbacks, and element/word counts
• Identify brand from transaction data: Endpoint specially designed for platforms that want to identify transaction data by the transaction title
• Retrieve NAICS code for any brand: Endpoint to classify any brand into a 2022 NAICS code
• Retrieve brand data by email address: Retrieve brand information using an email address while detecting disposable and free email addresses
• Retrieve simplified brand data by domain: Returns a simplified version of brand data containing only essential information: domain, title, colors, logos, and backdrops
• Retrieve brand data by ISIN: Retrieve brand information using an ISIN (International Securities Identification Number)
• Extract products from a brand's website: Beta feature: Extract product information from a brand’s website
• Retrieve brand data by domain: Retrieve logos, backdrops, colors, industry, description, and more from any domain
• Retrieve brand data by company name: Retrieve brand information using a company name
• Retrieve brand data by stock ticker: Retrieve brand information using a stock ticker symbol
• Extract design system and styleguide from website: Automatically extract comprehensive design system information from a brand’s website including colors, typography, spacing, shadows, and UI components
• Take screenshot of website: Capture a screenshot of a website
• Query website data using AI: Use AI to extract specific data points from a brand’s website

Usage

Extract fonts from website

Extract font information from a brand’s website including font families, usage statistics, fallbacks, and element/word counts.

Parameters:

• domain* (string) - Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated.
• timeoutMS (integer) - 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).

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/fonts","query":{"domain":"vercel.com"}}'

Identify brand from transaction data

Endpoint specially designed for platforms that want to identify transaction data by the transaction title.

Parameters:

• transaction_info* (string) - Transaction information to identify the brand
• force_language (string) - Optional parameter to force the language of the retrieved brand data.
• maxSpeed (boolean) - 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.
• country_gl (string) - Optional country code (GL parameter) to specify the country. This affects the geographic location used for search queries.
• city (string) - Optional city name to prioritize when searching for the brand.
• mcc (string) - Optional Merchant Category Code (MCC) to help identify the business category/industry.
• phone (number) - Optional phone number from the transaction to help verify brand match.
• timeoutMS (integer) - 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).

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/transaction_identifier","query":{"transaction_title":"STRIPE%20PAYMENT"}}'

Retrieve NAICS code for any brand

Endpoint to classify any brand into a 2022 NAICS code.

Parameters:

• input* (string) - Brand domain or title to retrieve NAICS code for. If a valid domain is provided in input, it will be used for classification, otherwise, we will search for the brand using the provided title.
• timeoutMS (integer) - 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).
• minResults (integer) - Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
• maxResults (integer) - Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5.

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/naics","query":{"input":"openai.com"}}'

Retrieve brand data by email address

Retrieve brand information using an email address while detecting disposable and free email addresses. This endpoint extracts the domain from the email address and returns brand data for that domain. Disposable and free email addresses (like gmail.com, yahoo.com) will throw a 422 error.

Parameters:

• email* (string<email>) - Email address to retrieve brand data for (e.g., 'contact@example.com'). The domain will be extracted from the email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email addresses are not allowed.
• force_language (string) - Optional parameter to force the language of the retrieved brand data.
• maxSpeed (boolean) - 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.
• timeoutMS (integer) - 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).

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-by-email","query":{"email":"john@stripe.com"}}'

Retrieve simplified brand data by domain

Returns a simplified version of brand data containing only essential information: domain, title, colors, logos, and backdrops. This endpoint is optimized for faster responses and reduced data transfer.

Parameters:

• domain* (string) - Domain name to retrieve simplified brand data for
• timeoutMS (integer) - 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).

curl -s -X POST $GOOSEWORKS_API_BASE/v1/proxy/orthogonal/run \
  -H "Authorization: Bearer $GOOSEWORKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"api":"brand-dev","path":"/v1/brand/retrieve-simplified","query":{"domain":"notion.so"}}'

Retrieve brand data by ISIN

Retrieve brand information using an ISIN (International Securities Identification Number). This endpoint looks up the company associated with the ISIN and returns its brand data.

Parameters:

• isin* (string) - ISIN (In