> ## Documentation Index
> Fetch the complete documentation index at: https://www.logo.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Describe a domain

> Structured brand data for any domain in one JSON response: name, description, brand colors, social profiles, and logo. Requires a secret key and a paid plan.



## OpenAPI

````yaml /openapi.json get /describe/{domain}
openapi: 3.1.0
info:
  title: Logo.dev API
  description: >-
    Logo.dev provides company and brand assets over HTTP. There are two surfaces
    with two different keys:


    - **Logo API** (`img.logo.dev`) returns a logo image directly. Authenticate
    with a **publishable key** via the `token` query parameter — safe for
    client-side use.

    - **REST APIs** (`api.logo.dev`) return JSON. Authenticate with a **secret
    key** via the `Authorization: Bearer` header — server-side only.


    Get your keys from the [dashboard](https://www.logo.dev/dashboard/api-keys).
  version: 1.0.0
  contact:
    name: Logo.dev Support
    email: support@logo.dev
    url: https://docs.logo.dev
servers:
  - url: https://api.logo.dev
    description: REST APIs (Brand Search, Brand Data)
security: []
tags:
  - name: Logo API
    description: >-
      Logo images by domain, ticker, crypto symbol, ISIN, or brand name. Served
      from img.logo.dev with a publishable key.
  - name: REST API
    description: JSON endpoints served from api.logo.dev with a secret key.
paths:
  /describe/{domain}:
    get:
      tags:
        - REST API
      summary: Describe a domain
      description: >-
        Returns structured brand data for a domain: name, description, brand
        colors, social profiles, logo, and a blurhash placeholder. Requires a
        secret key and a paid plan.
      operationId: describeDomain
      parameters:
        - name: domain
          in: path
          required: true
          description: Company domain to describe.
          schema:
            type: string
            examples:
              - sweetgreen.com
      responses:
        '200':
          description: Brand data for the domain.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandData'
              examples:
                sweetgreen:
                  value:
                    name: sweetgreen
                    domain: sweetgreen.com
                    description: >-
                      Simple, seasonal, healthy salads and grain bowls made
                      in-house from scratch.
                    indexed_at: '2025-03-10T11:36:23.885238001Z'
                    socials:
                      facebook: http://facebook.com/sweetgreen
                      instagram: https://www.instagram.com/sweetgreen/
                      twitter: https://x.com/sweetgreen
                    logo: >-
                      https://img.logo.dev/sweetgreen.com?token=LOGO_DEV_PUBLISHABLE_KEY
                    blurhash: UJPanPxr?Vj[oxazj@od_FWDDoodxrodagWD
                    colors:
                      - r: 228
                        g: 255
                        b: 85
                        hex: '#e4ff55'
                      - r: 10
                        g: 75
                        b: 43
                        hex: '#0a4b2b'
                      - r: 125
                        g: 173
                        b: 80
                        hex: '#7dad50'
                    is_profane: false
        '202':
          description: >-
            The domain isn't indexed yet — Logo.dev is fetching it. Retry in a
            few seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                lookingUp:
                  value:
                    msg: not found, looking up
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: No brand data found for the domain.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestError'
              examples:
                notFound:
                  value:
                    err: not found
      security:
        - secretKey: []
components:
  schemas:
    BrandData:
      type: object
      description: Structured brand data for a domain.
      properties:
        name:
          type: string
        domain:
          type: string
        description:
          type: string
        indexed_at:
          type: string
          format: date-time
        socials:
          $ref: '#/components/schemas/Socials'
        logo:
          type: string
          format: uri
        blurhash:
          type: string
          description: Compact blurred-placeholder string for the logo.
        colors:
          type: array
          description: Prominent colors, roughly ordered by prominence.
          items:
            $ref: '#/components/schemas/Color'
        is_profane:
          type: boolean
          description: Whether the brand content was flagged as potentially inappropriate.
      required:
        - name
        - domain
    Error:
      type: object
      properties:
        msg:
          type: string
          description: Human-readable error message.
      required:
        - msg
    RequestError:
      type: object
      description: >-
        Error shape returned by the Brand Search and Brand Data endpoints — note
        the `err` key, distinct from the Logo API's `msg`.
      properties:
        err:
          type: string
          description: Human-readable error message.
      required:
        - err
    Socials:
      type: object
      description: Detected social profiles. Only detected networks are present.
      properties:
        facebook:
          type: string
          format: uri
        github:
          type: string
          format: uri
        instagram:
          type: string
          format: uri
        linkedin:
          type: string
          format: uri
        pinterest:
          type: string
          format: uri
        reddit:
          type: string
          format: uri
        snapchat:
          type: string
          format: uri
        telegram:
          type: string
          format: uri
        tumblr:
          type: string
          format: uri
        twitter:
          type: string
          format: uri
        wechat:
          type: string
          format: uri
        whatsapp:
          type: string
          format: uri
        youtube:
          type: string
          format: uri
      additionalProperties:
        type: string
    Color:
      type: object
      description: A prominent brand color.
      properties:
        r:
          type: integer
          minimum: 0
          maximum: 255
        g:
          type: integer
          minimum: 0
          maximum: 255
        b:
          type: integer
          minimum: 0
          maximum: 255
        hex:
          type: string
          examples:
            - '#e4ff55'
      required:
        - r
        - g
        - b
        - hex
  responses:
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            invalid:
              value:
                msg: invalid api token
            missing:
              value:
                msg: missing api token
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: Secret key (`sk_...`). Server-side only. Used for the REST APIs.

````