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

# Brand API batch

> Send up to 100 identifiers. Get one result per identifier, in the order you sent them. Each identifier is answered the way `GET /v2/brands/{identifier}` answers it.

One difference: a batch never crawls while you wait. A brand that is not indexed yet is queued for indexing and answered `202`. Request it again later.

Each identifier answered `200` uses one API credit. Every other result is free, `404` included. An identifier repeated in one request is charged once.

Available on paid plans and with prepaid credits. Authenticate with an API key sent as `Authorization: Bearer <key>`.

<Note>
  Send up to 100 identifiers. Get one result per identifier, in the order you
  sent them, each answered the way `GET /v2/brands/{identifier}` answers it.

  A batch never crawls while you wait. A brand that is not indexed yet is
  queued for indexing and answered `202`. Request it again later.

  Each identifier answered `200` uses one API credit. Every other result is
  free, `404` included, and an identifier repeated in one request is charged
  once. Available on paid plans and with prepaid credits. See
  [Batch lookups](/brand-api/overview#batch-lookups).
</Note>


## OpenAPI

````yaml POST /v2/brands/batch
openapi: 3.0.1
info:
  title: Brandfetch API
  description: >-
    Our APIs help you personalize your customer journey through unique branded
    experiences.
  license:
    name: MIT
  version: 1.0.0
  contact:
    name: Brandfetch Support
    url: https://brandfetch.com
    email: support@brandfetch.io
servers:
  - url: https://api.brandfetch.io
security: []
paths:
  /v2/brands/batch:
    post:
      tags:
        - brands
      summary: Get up to 100 brands in one request
      description: >-
        Send up to 100 identifiers. Get one result per identifier, in the order
        you sent them. Each identifier is answered the way `GET
        /v2/brands/{identifier}` answers it.


        One difference: a batch never crawls while you wait. A brand that is not
        indexed yet is queued for indexing and answered `202`. Request it again
        later.


        Each identifier answered `200` uses one API credit. Every other result
        is free, `404` included. An identifier repeated in one request is
        charged once.


        Available on paid plans and with prepaid credits. Authenticate with an
        API key sent as `Authorization: Bearer <key>`.
      operationId: getBrandBatch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - identifiers
              properties:
                identifiers:
                  type: array
                  minItems: 1
                  maxItems: 100
                  description: >-
                    The brands to look up. A string is read as the `identifier`
                    of `GET /v2/brands/{identifier}`: a domain, website URL,
                    email address, brand ID, ticker or ISIN. An object names the
                    identifier's type, as `GET /v2/brands/{type}/{identifier}`
                    does. An exchange-suffixed ticker sent as a string, such as
                    `bhp.ax`, is read as a domain: send it as `{ "type":
                    "ticker", "value": "BHP.AX" }`.
                  items:
                    oneOf:
                      - type: string
                        minLength: 1
                        maxLength: 2048
                        example: nike.com
                      - type: object
                        additionalProperties: false
                        required:
                          - type
                          - value
                        properties:
                          type:
                            type: string
                            enum:
                              - domain
                              - ticker
                              - isin
                              - crypto
                              - brandId
                          value:
                            type: string
                            minLength: 1
                            maxLength: 2048
                        example:
                          type: ticker
                          value: NKE
                  example:
                    - nike.com
                    - https://www.spotify.com/about
                    - type: ticker
                      value: NKE
                cachedOnly:
                  type: boolean
                  default: false
                  description: >-
                    Answer from the index alone. A brand that is not indexed is
                    answered `204` and is not queued, and a ticker, ISIN or
                    crypto symbol that is not indexed is not resolved. A `204`
                    is free.
                allowNsfw:
                  type: boolean
                  description: >-
                    As `allowNsfw` on `GET /v2/brands/{identifier}`. Not set by
                    default.
                palette:
                  type: boolean
                  default: false
                  description: >-
                    As `palette` on `GET /v2/brands/{identifier}`: add each
                    brand's `palette`.
      responses:
        '200':
          description: One result per identifier, in the order you sent them.
          headers:
            x-api-key-quota:
              description: Your organization's API credit quota for the current period.
              schema:
                type: integer
            x-api-key-approximate-usage:
              description: >-
                Credits used this period, including the ones this request uses.
                Usage is counted asynchronously, so the figure trails your
                latest requests slightly.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      required:
                        - identifier
                        - status
                      properties:
                        identifier:
                          description: >-
                            The identifier you sent, with surrounding whitespace
                            removed.
                          oneOf:
                            - type: string
                            - type: object
                        status:
                          type: integer
                          enum:
                            - 200
                            - 202
                            - 204
                            - 400
                            - 404
                            - 413
                            - 500
                            - 504
                          description: >-
                            - `200` — `brand` holds the brand.

                            - `202` — the brand is not indexed yet and is queued
                            for indexing (`code`: `crawl_queued`). Request it
                            again later. Free.

                            - `204` — with `cachedOnly`, the brand is not
                            indexed. Nothing is queued. Free.

                            - `400` — not a valid identifier. `message` says
                            why. Free.

                            - `404` — no brand can be returned for the
                            identifier. `message` gives the reason. Free.

                            - `413` — the brand did not fit in this response
                            (`code`: `response_too_large`). Request it again in
                            a smaller batch. Free.

                            - `500` — the identifier could not be looked up.
                            Request it again. Free.

                            - `504` — the identifier could not be looked up in
                            time (`code`: `timeout`). Request it again. Free.
                        brand:
                          $ref: '#/components/schemas/BrandResponse'
                        code:
                          type: string
                          enum:
                            - crawl_queued
                            - response_too_large
                            - timeout
                        message:
                          type: string
        '400':
          description: >-
            The request body is malformed: `identifiers` is missing, empty or
            longer than 100, an item is neither a string nor a `{ type, value }`
            object, or the body has a property the API does not take. `message`
            names the problem. Nothing is charged.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '401':
          description: No API key was sent, or the `Authorization` header is malformed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '403':
          description: >-
            The API key is unknown or revoked, or your organization has no API
            credits. With `x-bf-error: paid_plan_required`, your organization is
            on the free plan and holds no prepaid credits.
          headers:
            x-bf-error:
              description: Why the request was refused.
              schema:
                type: string
                enum:
                  - paid_plan_required
        '429':
          description: >-
            Your organization has fewer API credits left than this request could
            use. `required` is the number of identifiers that could be charged.
            `remaining` is what is left. Send fewer identifiers, or add credits.
            Nothing is charged. The same status is returned when the request
            throughput limit is exceeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Not enough API credits remain for this batch.
                  quota:
                    type: integer
                  used:
                    type: integer
                  remaining:
                    type: integer
                  required:
                    type: integer
      security:
        - bearerAuth: []
components:
  schemas:
    BrandResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the brand
          nullable: false
        name:
          type: string
          description: Brand name
          nullable: true
        domain:
          type: string
          description: Brand website URL
          nullable: false
        claimed:
          type: boolean
          description: >-
            Set to true if the owner of the brand claimed its brand profile on
            [Brandfetch](https://brandfetch.com)
          nullable: false
        description:
          type: string
          description: Brand description
          nullable: true
        longDescription:
          type: string
          description: Brand long description
          nullable: true
        links:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Name of the social media platform
                nullable: false
                enum:
                  - twitter
                  - facebook
                  - instagram
                  - github
                  - youtube
                  - linkedin
                  - crunchbase
              url:
                type: string
                description: URL of the social media profile
                nullable: false
          description: Social media links of the brand
          nullable: false
        logos:
          type: array
          items:
            type: object
            properties:
              theme:
                type: string
                description: >-
                  See logo theme. Possible values:

                  - **dark**: A dark logo should be displayed on a light
                  background (e.g. #ffffff)

                  - **light**: A light logo should be displayed on a dark
                  background (e.g. #000000)
                nullable: true
                enum:
                  - dark
                  - light
                  - null
              formats:
                type: array
                items:
                  $ref: '#/components/schemas/Format'
                description: A list of format objects containing files in different formats
                nullable: false
              tags:
                type: array
                items:
                  type: string
                description: >-
                  What the image is. Brandfetch tags a brand's icon and logo;
                  one that is no longer the brand's main icon or logo keeps its
                  tags and is listed with type `other`. Possible values:

                  - **photographic**: The image is a photograph, or a logo shown
                  on one, such as a sign or a vehicle.

                  - **portrait**: The image is a photograph mainly of one or
                  more people. An image tagged `portrait` is also tagged
                  `photographic`.

                  - **illustration**: The image is a drawing, painting, cartoon
                  or 3D render that is not a logo.

                  - **screenshot**: The image is a screenshot or mockup of
                  software, a website, an app or a device screen. Logos only.

                  - **text**: The image is a flyer, poster, advert, social media
                  post, infographic, document or menu. Logos only.

                  - **pattern**: The image is an abstract background, texture,
                  gradient or pattern with no subject. Icons only.

                  - **placeholder**: The image is a default avatar, a blank or
                  single-colour image, or a "no image" graphic.

                  - **wordmark**: The logo is the brand's name set in type, with
                  no separate symbol.

                  - **lettermark**: The logo is initials, a monogram or a single
                  letter.

                  - **symbol**: The logo is a symbol alone, without text.

                  - **combination**: The logo pairs a symbol with the name.

                  - **emblem**: The logo's text sits inside a badge, seal or
                  crest.


                  The mark types, `wordmark` to `emblem`, go only on an image
                  that is mainly a logo, one at most. A tag is assigned only
                  when the image clearly is one, so an image without a tag can
                  still be any of these. Logos and icons that Brandfetch has not
                  refreshed since October 2026 may carry fewer tags, or none.
                  Brandfetch may add values.
                nullable: false
              type:
                type: string
                description: >-
                  See logo type. Possible values:

                  - **icon**: The icon that is used on social profiles (e.g.
                  [Tesla's social
                  icon](https://cdn.brandfetch.io/tesla.com/icon))

                  - **logo**: The horizontal logo, seen on large surfaces (e.g.
                  [Tesla's
                  logo](https://asset.brandfetch.io/id2S-kXbuK/idAJ5NMLPG.svg))

                  - **symbol**: The universal mark that abstractly represents
                  the brand (e.g. [Tesla's T
                  symbol](https://asset.brandfetch.io/id2S-kXbuK/idM-t614MT.svg))

                  - **other**: Other is used to refer to any type of logo that
                  is not the primary one. (e.g. Amazon Kindle Logo)
                nullable: false
                enum:
                  - icon
                  - logo
                  - symbol
                  - other
          description: Logos, symbols & icons of the brand
          nullable: false
        colors:
          type: array
          items:
            type: object
            properties:
              hex:
                type: string
                description: Color HEX code
                nullable: false
              type:
                type: string
                description: >-
                  Type of the color. Possible values:

                  - **accent**: The main color that represents the brand (used
                  to draw attention e.g. call to action button)

                  - **dark**: The darker color of the brand (used for surfaces
                  or backgrounds)

                  - **light**: The lighter color of the brand (used for surfaces
                  or backgrounds)

                  - **brand**: The full-color scheme of the brand (used to
                  create color palettes users can pick from)
                nullable: false
                enum:
                  - accent
                  - dark
                  - light
                  - brand
              brightness:
                type: number
                description: >-
                  Color brightness. Calculated based on the standard formula
                  0.2126*R + 0.7152*G + 0.0722*B
                nullable: false
                format: float
          description: Accent, dark, light & palette colors of the brand
          nullable: false
        fonts:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Font family
                nullable: true
              type:
                type: string
                description: Font type
                nullable: false
                enum:
                  - title
                  - body
              origin:
                type: string
                description: >-
                  See font origin. Possible values:

                  - **google**: The font that's hosted on Google Font

                  - **custom**: The font that has been uploaded by the brand
                  itself

                  - **system**: The font that's already installed on the user's
                  operating system (see example)
                enum:
                  - google
                  - custom
                  - system
              originId:
                type: string
                description: Font origin ID
                nullable: true
              weights:
                type: array
                items:
                  type: object
                  properties: {}
          description: Title & body fonts of the brand
          nullable: false
        images:
          type: array
          items:
            type: object
            properties:
              formats:
                type: array
                items:
                  $ref: '#/components/schemas/Format'
                description: Available formats of the image
                nullable: false
              tags:
                type: array
                items:
                  type: string
                description: >-
                  What the image is. A banner that is no longer the brand's main
                  one keeps its tags and is listed with type `other`. Possible
                  values:

                  - **photographic**: The image is a photograph, or a logo shown
                  on one. Banners and pictures.

                  - **portrait**: The image is a photograph mainly of one or
                  more people. Banners and pictures. An image tagged `portrait`
                  is also tagged `photographic`.

                  - **illustration**: The image is a drawing, painting, cartoon
                  or 3D render that is not a logo. Banners and pictures.

                  - **screenshot**: The image is a screenshot or mockup of
                  software, a website, an app or a device screen. Pictures.

                  - **text**: The image is a flyer, poster, advert, social media
                  post, infographic, document or menu. Banners and pictures.

                  - **pattern**: The image is an abstract background, texture,
                  gradient or pattern with no subject. Banners.

                  - **placeholder**: The image is blank, a single colour, or a
                  "no image" graphic. Pictures.


                  A tag is assigned only when the image clearly is one, so an
                  image without a tag can still be any of these. Images that
                  Brandfetch has not refreshed since October 2026 have no tags.
                  Brandfetch may add values.
                nullable: false
              type:
                type: string
                description: >-
                  Image type. `picture` entries are images published on the
                  brand's own site and carry `pictureMetadata`. Their `tags` say
                  what each one is, such as a photograph, a screenshot or a
                  flyer.
                nullable: false
                enum:
                  - banner
                  - other
                  - picture
              pictureMetadata:
                type: object
                description: >-
                  Present on `picture` entries only. Lets you choose between a
                  brand's pictures without fetching the files first.
                properties:
                  score:
                    type: number
                    description: How representative of the brand we consider this picture
                    nullable: false
                  rank:
                    type: integer
                    description: >-
                      Position of this picture among the brand's pictures, by
                      descending score
                    nullable: false
                  naturalWidth:
                    type: integer
                    description: Intrinsic width of the image in pixels
                    nullable: false
                  naturalHeight:
                    type: integer
                    description: Intrinsic height of the image in pixels
                    nullable: false
                  alt:
                    type: string
                    description: Alt text published with the image on the brand's site
                    nullable: false
                  sourceUrl:
                    type: string
                    description: >-
                      URL of the image on the brand's own site. A `picture` can
                      arrive with an empty `formats` array, in which case this
                      is how you reach the image.
                    nullable: false
                  imageCategory:
                    type: string
                    description: Category we classified the image into
                    nullable: true
                  categoryConfidence:
                    type: number
                    description: Confidence in the assigned `imageCategory`
                    nullable: true
                nullable: false
          description: Banner, picture & other images of the brand
          nullable: false
        qualityScore:
          type: number
          description: >-
            Score between 0-1 which indicates the quality of the data for the
            given brand. Useful when you don't want to show lower quality brands
            to your users.


            Lower 3rd is poor quality, middle 3rd is OK quality, upper 3rd is
            high quality. Lower scores indicate that a brand is less likely to
            be "real". For example, where google.com will score high,
            my-random-blog.com will score between 0.3-0.4. The score factors in
            things like data-recency, whether the brand has been claimed, if it
            has been manually verified by our team, the brand's domain ranking
            on the web, as well as other factors.


            Don't rely on a fixed score for any given brand. The way we
            calculate this score may change over time as we add new factors, or
            tweak the weights of existing ones such that a score for a given
            brand may change. However, they will remain aligned such that scores
            divide quality into thirds: low, medium, high.
          nullable: false
        company:
          type: object
          properties:
            employees:
              type: integer
              description: >-
                1 employee, 2-10 employees, 11-50 employees, 51-200 employees,
                201-500 employees, 501-1,000 employees, 1,001-5,000 employees,
                5,001-10,000 employees, 10,001+ employees
              enum:
                - 1
                - 2
                - 11
                - 51
                - 201
                - 501
                - 1001
                - 5001
                - 10001
              nullable: true
            financialIdentifiers:
              type: object
              description: Object holding financial identifiers
              properties:
                isin:
                  type: array
                  description: List of ISIN codes
                  items:
                    type: string
                ticker:
                  type: array
                  description: List of Stock or ETF ticker
                  items:
                    type: string
              nullable: true
            foundedYear:
              type: integer
              description: The year the brand was founded
              nullable: true
            industries:
              type: array
              items:
                $ref: '#/components/schemas/Industry'
              description: >-
                An array of industries, sorted by descending `score`. A
                sub-industry carries its top-level industry in `parent`. See the
                full list of industries
                [here](https://docs.google.com/spreadsheets/d/1N44nMfVtPCFM4ebTcmRlqbyxjFtDAGVuqd0mh0dcOU0/edit?usp=sharing)
            kind:
              type: string
              description: Organizational Structure
              enum:
                - EDUCATIONAL
                - GOVERNMENT_AGENCY
                - NON_PROFIT
                - PARTNERSHIP
                - PRIVATELY_HELD
                - PUBLIC_COMPANY
                - SELF_EMPLOYED
                - SELF_OWNED
              nullable: true
            location:
              $ref: '#/components/schemas/Location'
          description: The company object returns firmographic data related to the brand
          nullable: false
        isNsfw:
          type: boolean
          description: true when the brand is for adult content, e.g. is not safe for work
          nullable: false
        urn:
          type: string
          description: Uniform Resource Name for the brand
          nullable: false
        palette:
          type: object
          nullable: true
          description: >-
            The brand's color palette. Present only when the request sets
            `palette=true` or `palette=1`. When a brand has no palette yet, the
            first request builds one from the brand's last crawl without a new
            render. Then `themes` and `onPairs` can be empty until the next
            crawl. When Brandfetch finds no color that it can defend as the
            brand's color, no color has the role `primary`.
          properties:
            colors:
              type: array
              items:
                type: object
                properties:
                  hex:
                    type: string
                    description: Color HEX code.
                    nullable: false
                  name:
                    type: string
                    description: >-
                      Name of the closest named color. Uses the same list as
                      `colors[].name`, so the same HEX code has the same name
                      everywhere.
                    nullable: true
                  role:
                    type: string
                    description: >-
                      What the color does for the brand. Possible values:
                      `primary`, `secondary`, `accent`, `background`, `surface`,
                      `text`, `muted`, `border`, `other`.
                    nullable: false
                  context:
                    type: string
                    description: >-
                      Where Brandfetch observed the color. `identity` for colors
                      of the brand's mark and identity, `interface` for colors
                      that structure its website, `both` for colors that do
                      both.
                    nullable: false
                  rank:
                    type: integer
                    description: >-
                      Position of the color in the palette, from 1. `null` for a
                      color that a theme, gradient, on-pair, or logo references
                      but that does not rank as a brand color.
                    nullable: true
                  member:
                    type: boolean
                    description: >-
                      `true` for a color listed only because a theme, gradient,
                      on-pair or logo references it. Absent on ranked colors.
                  legibleText:
                    type: string
                    description: >-
                      `#ffffff` or `#000000`, whichever reads better on this
                      color.
                    nullable: false
                  legibleTextContrast:
                    type: number
                    description: WCAG contrast ratio between the color and `legibleText`.
                    nullable: false
                  onColor:
                    type: string
                    description: >-
                      The text color that the brand's website places on this
                      color, when Brandfetch observed it.
                    nullable: true
                  onColorContrast:
                    type: number
                    description: WCAG contrast ratio between the color and `onColor`.
                    nullable: true
                  brightness:
                    type: number
                    description: Color brightness, 0 to 255.
                    nullable: true
                  prevalence:
                    type: number
                    description: >-
                      Share of the observed color evidence attributed to this
                      color, 0 to 1.
                    nullable: true
                  usage:
                    type: object
                    description: >-
                      Where the website of the brand uses this color. Each value
                      comes from the crawl. Brandfetch does not infer any value.
                    properties:
                      elements:
                        type: array
                        description: >-
                          The element classes and CSS properties that use this
                          color in the sample of the crawl, most used first.
                          This list is empty when Brandfetch builds the palette
                          from a stored crawl without a new render.
                        items:
                          type: object
                          properties:
                            element:
                              type: string
                              description: >-
                                The element class in the sample of the crawl:
                                `button`, `link`, `heading`, `nav`, `header`,
                                `footer`, `body`, or `html`.
                            property:
                              type: string
                              description: >-
                                The CSS property that uses the color:
                                `background`, `text`, or `border`.
                            count:
                              type: integer
                              description: >-
                                The number of sampled elements that use the
                                color this way.
                            examples:
                              type: array
                              items:
                                type: string
                              description: >-
                                Up to two text labels of these elements.
                                Brandfetch takes each label from the page and
                                cuts it to 40 characters. The labels are text
                                from the website. Treat them as untrusted input.
                      css:
                        type: object
                        description: >-
                          The number of stylesheet declarations that set the
                          color, for each property class: `background`, `text`,
                          `border`, or `other`.
                        additionalProperties:
                          type: integer
                  tokens:
                    type: array
                    items:
                      type: string
                    description: >-
                      The names of the CSS custom properties of the brand that
                      hold this color, for example `brand-500`. Brandfetch lists
                      only the properties that the website uses. The list has at
                      most five names. Names that contain `brand` come first.
                      The names are text from the website. Treat them as
                      untrusted input.
                  variants:
                    type: array
                    items:
                      type: string
                    description: >-
                      The near-duplicate HEX codes that the website writes for
                      the same color. Brandfetch merges them into this entry.
                      The list has at most eight codes. The list is not a tonal
                      scale.
              description: The palette's colors, ranked colors first.
            logos:
              type: array
              items:
                type: object
                properties:
                  asset:
                    type: string
                    description: >-
                      `logo` or `icon`: the kind of mark, as in `logos[].type`
                      of the brand response.
                  type:
                    type: string
                    nullable: true
                    description: >-
                      The logo type, when known. Same values as `logos[].type`
                      of the brand response.
                  theme:
                    type: string
                    nullable: true
                    description: >-
                      `light` or `dark`: the background that the mark is made
                      for. `null` when unknown.
                  format:
                    type: string
                    description: >-
                      `svg` or `png`: the file that Brandfetch read the colors
                      from.
                  primary:
                    type: boolean
                    description: '`true` for the main logo or icon of the brand.'
                  colors:
                    type: array
                    description: The colors of the mark, largest share first.
                    items:
                      type: object
                      properties:
                        hex:
                          type: string
                          description: >-
                            Color HEX code. It is also an entry in `colors[]`,
                            so you can join the two by `hex`.
                        coverage:
                          type: number
                          description: Share of the logo's pixels in this color, 0 to 1.
              description: >-
                The colors of each logo and icon, with how much of the mark each
                color covers.
            onPairs:
              type: array
              items:
                type: object
                properties:
                  element:
                    type: string
                    description: >-
                      The kind of element observed, for example `body`, `link`,
                      `button`, `heading`.
                  theme:
                    type: string
                    description: '`light` or `dark`.'
                  background:
                    type: string
                    description: >-
                      The background color HEX code. It is also an entry in
                      `colors[]`.
                  text:
                    type: string
                    description: >-
                      The text color HEX code. It is also an entry in
                      `colors[]`.
                  contrast:
                    type: number
                    description: WCAG contrast ratio between `background` and `text`.
                  wcag:
                    type: string
                    description: '`AAA`, `AA`, `AA-large` or `fail`.'
                  count:
                    type: integer
                    description: How many elements showed this pair.
              description: >-
                The background and text color pairs that Brandfetch observed on
                the brand's website, with their contrast. Empty for a palette
                built from a stored crawl without a new render.
            gradients:
              type: array
              items:
                type: object
                properties:
                  rank:
                    type: integer
                    description: Position of the gradient, from 1.
                  type:
                    type: string
                    description: '`linear`, `radial`, or `conic`.'
                  angle:
                    type: number
                    nullable: true
                    description: >-
                      The angle of a linear gradient, in degrees. `null` when
                      the stylesheet gives none.
                  stops:
                    type: array
                    description: The color stops, in order.
                    items:
                      type: object
                      properties:
                        hex:
                          type: string
                          description: Color HEX code. It is also an entry in `colors[]`.
                        position:
                          type: number
                          nullable: true
                          description: >-
                            Position of the stop, 0 to 1. `null` when the
                            stylesheet gives none.
                  css:
                    type: string
                    description: >-
                      The gradient as a CSS value, for example
                      `linear-gradient(90deg, #ff0000 0%, #0000ff 100%)`.
              description: >-
                Gradients from the brand's stylesheets that use a brand color,
                at most four. Every stop color is also an entry in `colors[]`,
                with `rank: null` when it is not a brand color.
            themes:
              type: object
              description: >-
                The `light` and `dark` themes that the website showed. A theme
                that Brandfetch did not observe is absent. A palette built from
                a stored crawl without a new render often has no themes.
              properties:
                light:
                  $ref: '#/components/schemas/PaletteTheme'
                dark:
                  $ref: '#/components/schemas/PaletteTheme'
    Format:
      type: object
      properties:
        src:
          type: string
          description: File source
        format:
          type: string
          enum:
            - svg
            - webp
            - png
            - jpeg
          description: File format
        height:
          type: integer
          nullable: true
          description: File height in pixels
        width:
          type: integer
          nullable: true
          description: File width in pixels
        size:
          type: integer
          description: File size in bytes
        background:
          type: string
          enum:
            - transparent
          nullable: true
          description: Indicates if the file has a transparent background
    Industry:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the industry
        score:
          type: number
          format: float
          description: >-
            Probability, between 0 and 1, that the brand belongs to this
            industry. A value of 1 marks an industry that was set rather than
            predicted, for example by a curator, an import or a content rule.
        slug:
          type: string
          description: URL friendly identifier
        name:
          type: string
          description: Name of the industry
        emoji:
          type: string
          description: An emoji for the industry
        parent:
          description: If the object is a sub-category, the parent industry
          items:
            $ref: '#/components/schemas/IndustryParent'
          nullable: true
    Location:
      type: object
      description: Company's headquarter information
      properties:
        city:
          type: string
          description: Headquarter city
          nullable: true
        country:
          type: string
          description: Headquarter country
          nullable: true
        countryCode:
          type: string
          description: Headquarter country code (ISO 3166-1 alpha-2)
          nullable: true
        region:
          type: string
          description: Headquarter region
          nullable: true
        state:
          type: string
          description: Headquarter state
          nullable: true
        subregion:
          type: string
          description: Headquarter subregion
          nullable: true
    PaletteTheme:
      type: object
      description: >-
        One theme of the brand's website. Each slot holds a color that the
        render of this theme showed. A slot that the render did not show is
        `null`. Every color is also an entry in `colors[]`.
      properties:
        background:
          type: string
          description: The page background color HEX code.
        surface:
          type: string
          nullable: true
          description: The color HEX code of cards and panels on the page background.
        text:
          type: string
          description: The body text color HEX code.
        muted:
          type: string
          nullable: true
          description: The color HEX code of secondary text.
        border:
          type: string
          nullable: true
          description: The color HEX code of borders and dividers.
        accent:
          type: string
          nullable: true
          description: The color HEX code of links and buttons in this theme.
        contrast:
          type: number
          description: WCAG contrast ratio between `background` and `text`.
    IndustryParent:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the industry
        slug:
          type: string
          description: URL friendly identifier
        name:
          type: string
          description: Name of the industry
        emoji:
          type: string
          description: An emoji for the industry
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.