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

# Brand Retrieve



## OpenAPI

````yaml https://api.notte.cc/openapi.json post /data/brand/retrieve
openapi: 3.1.0
info:
  title: Notte API
  description: >-
    Notte API is a REST API that allows you to interact with Notte. It is used
    to create cloud browser sessions, scrape webpages, and run web ai agents to
    act on your behalf on the internet.
  version: 1.9.8
  x-logo:
    url: https://www.notte.cc/images/logo/logo-white.png
servers: []
security: []
tags:
  - name: agents
    description: Web AI agents (start, stop, status, replay, etc.)
  - name: sessions
    description: Session management (start, stop, status, etc.)
  - name: debug
    description: Session debugging tools (replay,logs, recording, etc.)
  - name: page
    description: Page operations withing a session (observe, step, scrape, etc.)
  - name: storage
    description: File storage interface (upload, download, list, etc.)
  - name: network
    description: Network requests/responses withing a session (intercept, etc.)
  - name: vaults
    description: >-
      Vault & Credentials management (create/delete vaults, create/delete
      credentials, etc.)
  - name: personas
    description: Persona management (create, delete, list emails, list sms, etc.)
  - name: scrape
    description: >-
      Webpage scraping (scrape, screenshot, etc.) with automatic session
      management.
  - name: health
    description: Health check endpoint.
  - name: usage
    description: Usage logs (usage, logs, etc.)
  - name: audit
    description: Audit trail of account and workspace changes.
  - name: functions
    description: Functions management (create, delete, list, etc.)
paths:
  /data/brand/retrieve:
    post:
      tags:
        - Data APIs
        - data
      summary: Brand Retrieve
      operationId: brand_retrieve
      parameters:
        - name: x-notte-request-origin
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Notte-Request-Origin
        - name: x-notte-sdk-version
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Notte-Sdk-Version
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/BrandByDomain'
                - $ref: '#/components/schemas/BrandByName'
                - $ref: '#/components/schemas/BrandByEmail'
                - $ref: '#/components/schemas/BrandByTicker'
                - $ref: '#/components/schemas/BrandByDirectUrl'
                - $ref: '#/components/schemas/BrandByTransaction'
              discriminator:
                propertyName: type
                mapping:
                  by_domain: '#/components/schemas/BrandByDomain'
                  by_name: '#/components/schemas/BrandByName'
                  by_email: '#/components/schemas/BrandByEmail'
                  by_ticker: '#/components/schemas/BrandByTicker'
                  by_direct_url: '#/components/schemas/BrandByDirectUrl'
                  by_transaction: '#/components/schemas/BrandByTransaction'
              title: Request
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
      x-codeSamples:
        - lang: Python
          source: |-
            import os

            import requests

            response = requests.post(
                "https://api.notte.cc/data/brand/retrieve",
                headers={"Authorization": f"Bearer {os.environ['NOTTE_API_KEY']}"},
                json={"type": "by_domain", "domain": "stripe.com"},
                timeout=330,
            )
            response.raise_for_status()
            print(response.json())
          label: python
        - lang: TypeScript
          source: >-
            const response = await
            fetch("https://api.notte.cc/data/brand/retrieve", {
              method: "POST",
              headers: {
                Authorization: `Bearer ${process.env.NOTTE_API_KEY}`,
                "Content-Type": "application/json",
              },
              body: JSON.stringify({
                "type": "by_domain",
                "domain": "stripe.com"
              }),
              signal: AbortSignal.timeout(330_000),
            });

            if (!response.ok) throw new Error(await response.text());

            console.log(await response.json());
          label: node
        - lang: Curl
          source: >-
            curl --fail-with-body --max-time 330 --request POST
            https://api.notte.cc/data/brand/retrieve \
              --header "Authorization: Bearer $NOTTE_API_KEY" \
              --header 'Content-Type: application/json' \
              --data '{
              "type": "by_domain",
              "domain": "stripe.com"
            }'
          label: curl
components:
  schemas:
    BrandByDomain:
      properties:
        timeoutOpts:
          anyOf:
            - $ref: '#/components/schemas/BrandTimeout'
            - type: 'null'
        tags:
          items:
            type: string
            maxLength: 50
            minLength: 1
          type: array
          maxItems: 20
          title: Tags
        force_language:
          anyOf:
            - type: string
              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
            - type: 'null'
          title: Force Language
        maxSpeed:
          type: boolean
          title: Maxspeed
          default: false
        maxAgeMs:
          type: integer
          title: Maxagems
          default: 7776000000
        type:
          type: string
          const: by_domain
          title: Type
        domain:
          type: string
          minLength: 3
          title: Domain
      additionalProperties: false
      type: object
      required:
        - type
        - domain
      title: BrandByDomain
    BrandByName:
      properties:
        timeoutOpts:
          anyOf:
            - $ref: '#/components/schemas/BrandTimeout'
            - type: 'null'
        tags:
          items:
            type: string
            maxLength: 50
            minLength: 1
          type: array
          maxItems: 20
          title: Tags
        force_language:
          anyOf:
            - type: string
              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
            - type: 'null'
          title: Force Language
        maxSpeed:
          type: boolean
          title: Maxspeed
          default: false
        maxAgeMs:
          type: integer
          title: Maxagems
          default: 7776000000
        type:
          type: string
          const: by_name
          title: Type
        name:
          type: string
          maxLength: 30
          minLength: 3
          title: Name
        country_gl:
          anyOf:
            - type: string
              enum:
                - af
                - al
                - dz
                - as
                - ad
                - ao
                - ai
                - aq
                - ag
                - ar
                - am
                - aw
                - au
                - at
                - az
                - bs
                - bh
                - bd
                - bb
                - by
                - be
                - bz
                - bj
                - bm
                - bt
                - bo
                - ba
                - bw
                - bv
                - br
                - io
                - bn
                - bg
                - bf
                - bi
                - kh
                - cm
                - ca
                - cv
                - ky
                - cf
                - td
                - cl
                - cn
                - cx
                - cc
                - co
                - km
                - cg
                - cd
                - ck
                - cr
                - ci
                - hr
                - cu
                - cy
                - cz
                - dk
                - dj
                - dm
                - do
                - ec
                - eg
                - sv
                - gq
                - er
                - ee
                - et
                - fk
                - fo
                - fj
                - fi
                - fr
                - gf
                - pf
                - tf
                - ga
                - gm
                - ge
                - de
                - gh
                - gi
                - gr
                - gl
                - gd
                - gp
                - gu
                - gt
                - gn
                - gw
                - gy
                - ht
                - hm
                - va
                - hn
                - hk
                - hu
                - is
                - in
                - id
                - ir
                - iq
                - ie
                - il
                - it
                - jm
                - jp
                - jo
                - kz
                - ke
                - ki
                - kp
                - kr
                - kw
                - kg
                - la
                - lv
                - lb
                - ls
                - lr
                - ly
                - li
                - lt
                - lu
                - mo
                - mk
                - mg
                - mw
                - my
                - mv
                - ml
                - mt
                - mh
                - mq
                - mr
                - mu
                - yt
                - mx
                - fm
                - md
                - mc
                - mn
                - ms
                - ma
                - mz
                - mm
                - na
                - nr
                - np
                - nl
                - an
                - nc
                - nz
                - ni
                - ne
                - ng
                - nu
                - nf
                - mp
                - 'no'
                - om
                - pk
                - pw
                - ps
                - pa
                - pg
                - py
                - pe
                - ph
                - pn
                - pl
                - pt
                - pr
                - qa
                - re
                - ro
                - ru
                - rw
                - sh
                - kn
                - lc
                - pm
                - vc
                - ws
                - sm
                - st
                - sa
                - sn
                - rs
                - sc
                - sl
                - sg
                - sk
                - si
                - sb
                - so
                - za
                - gs
                - es
                - lk
                - sd
                - sr
                - sj
                - sz
                - se
                - ch
                - sy
                - tw
                - tj
                - tz
                - th
                - tl
                - tg
                - tk
                - to
                - tt
                - tn
                - tr
                - tm
                - tc
                - tv
                - ug
                - ua
                - ae
                - gb
                - us
                - um
                - uy
                - uz
                - vu
                - ve
                - vn
                - vg
                - vi
                - wf
                - eh
                - ye
                - zm
                - zw
            - type: 'null'
          title: Country Gl
      additionalProperties: false
      type: object
      required:
        - type
        - name
      title: BrandByName
    BrandByEmail:
      properties:
        timeoutOpts:
          anyOf:
            - $ref: '#/components/schemas/BrandTimeout'
            - type: 'null'
        tags:
          items:
            type: string
            maxLength: 50
            minLength: 1
          type: array
          maxItems: 20
          title: Tags
        force_language:
          anyOf:
            - type: string
              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
            - type: 'null'
          title: Force Language
        maxSpeed:
          type: boolean
          title: Maxspeed
          default: false
        maxAgeMs:
          type: integer
          title: Maxagems
          default: 7776000000
        type:
          type: string
          const: by_email
          title: Type
        email:
          type: string
          minLength: 1
          title: Email
      additionalProperties: false
      type: object
      required:
        - type
        - email
      title: BrandByEmail
    BrandByTicker:
      properties:
        timeoutOpts:
          anyOf:
            - $ref: '#/components/schemas/BrandTimeout'
            - type: 'null'
        tags:
          items:
            type: string
            maxLength: 50
            minLength: 1
          type: array
          maxItems: 20
          title: Tags
        force_language:
          anyOf:
            - type: string
              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
            - type: 'null'
          title: Force Language
        maxSpeed:
          type: boolean
          title: Maxspeed
          default: false
        maxAgeMs:
          type: integer
          title: Maxagems
          default: 7776000000
        type:
          type: string
          const: by_ticker
          title: Type
        ticker:
          type: string
          maxLength: 15
          minLength: 1
          pattern: ^[A-Za-z0-9.]+$
          title: Ticker
        ticker_exchange:
          type: string
          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
          title: Ticker Exchange
          default: NASDAQ
      additionalProperties: false
      type: object
      required:
        - type
        - ticker
      title: BrandByTicker
    BrandByDirectUrl:
      properties:
        timeoutOpts:
          anyOf:
            - $ref: '#/components/schemas/BrandTimeout'
            - type: 'null'
        tags:
          items:
            type: string
            maxLength: 50
            minLength: 1
          type: array
          maxItems: 20
          title: Tags
        type:
          type: string
          const: by_direct_url
          title: Type
        direct_url:
          type: string
          title: Direct Url
      additionalProperties: false
      type: object
      required:
        - type
        - direct_url
      title: BrandByDirectUrl
    BrandByTransaction:
      properties:
        timeoutOpts:
          anyOf:
            - $ref: '#/components/schemas/BrandTimeout'
            - type: 'null'
        tags:
          items:
            type: string
            maxLength: 50
            minLength: 1
          type: array
          maxItems: 20
          title: Tags
        force_language:
          anyOf:
            - type: string
              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
            - type: 'null'
          title: Force Language
        maxSpeed:
          type: boolean
          title: Maxspeed
          default: false
        type:
          type: string
          const: by_transaction
          title: Type
        transaction_info:
          type: string
          maxLength: 500
          minLength: 3
          title: Transaction Info
        country_gl:
          anyOf:
            - type: string
              enum:
                - af
                - al
                - dz
                - as
                - ad
                - ao
                - ai
                - aq
                - ag
                - ar
                - am
                - aw
                - au
                - at
                - az
                - bs
                - bh
                - bd
                - bb
                - by
                - be
                - bz
                - bj
                - bm
                - bt
                - bo
                - ba
                - bw
                - bv
                - br
                - io
                - bn
                - bg
                - bf
                - bi
                - kh
                - cm
                - ca
                - cv
                - ky
                - cf
                - td
                - cl
                - cn
                - cx
                - cc
                - co
                - km
                - cg
                - cd
                - ck
                - cr
                - ci
                - hr
                - cu
                - cy
                - cz
                - dk
                - dj
                - dm
                - do
                - ec
                - eg
                - sv
                - gq
                - er
                - ee
                - et
                - fk
                - fo
                - fj
                - fi
                - fr
                - gf
                - pf
                - tf
                - ga
                - gm
                - ge
                - de
                - gh
                - gi
                - gr
                - gl
                - gd
                - gp
                - gu
                - gt
                - gn
                - gw
                - gy
                - ht
                - hm
                - va
                - hn
                - hk
                - hu
                - is
                - in
                - id
                - ir
                - iq
                - ie
                - il
                - it
                - jm
                - jp
                - jo
                - kz
                - ke
                - ki
                - kp
                - kr
                - kw
                - kg
                - la
                - lv
                - lb
                - ls
                - lr
                - ly
                - li
                - lt
                - lu
                - mo
                - mk
                - mg
                - mw
                - my
                - mv
                - ml
                - mt
                - mh
                - mq
                - mr
                - mu
                - yt
                - mx
                - fm
                - md
                - mc
                - mn
                - ms
                - ma
                - mz
                - mm
                - na
                - nr
                - np
                - nl
                - an
                - nc
                - nz
                - ni
                - ne
                - ng
                - nu
                - nf
                - mp
                - 'no'
                - om
                - pk
                - pw
                - ps
                - pa
                - pg
                - py
                - pe
                - ph
                - pn
                - pl
                - pt
                - pr
                - qa
                - re
                - ro
                - ru
                - rw
                - sh
                - kn
                - lc
                - pm
                - vc
                - ws
                - sm
                - st
                - sa
                - sn
                - rs
                - sc
                - sl
                - sg
                - sk
                - si
                - sb
                - so
                - za
                - gs
                - es
                - lk
                - sd
                - sr
                - sj
                - sz
                - se
                - ch
                - sy
                - tw
                - tj
                - tz
                - th
                - tl
                - tg
                - tk
                - to
                - tt
                - tn
                - tr
                - tm
                - tc
                - tv
                - ug
                - ua
                - ae
                - gb
                - us
                - um
                - uy
                - uz
                - vu
                - ve
                - vn
                - vg
                - vi
                - wf
                - eh
                - ye
                - zm
                - zw
            - type: 'null'
          title: Country Gl
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
        mcc:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: 'null'
          title: Mcc
        phone:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: 'null'
          title: Phone
        high_confidence_only:
          type: boolean
          title: High Confidence Only
          default: false
      additionalProperties: false
      type: object
      required:
        - type
        - transaction_info
      title: BrandByTransaction
    BrandResponse:
      properties:
        status:
          type: string
          const: ok
          title: Status
          default: ok
        code:
          type: integer
          const: 200
          title: Code
          default: 200
        brand:
          anyOf:
            - $ref: '#/components/schemas/BrandProfile'
            - type: 'null'
        cache_metadata:
          $ref: '#/components/schemas/BrandCacheMetadata'
        request_id:
          type: string
          title: Request Id
        partial:
          type: boolean
          title: Partial
          default: false
        key_metadata:
          anyOf:
            - $ref: '#/components/schemas/BrandKeyMetadata'
            - type: 'null'
      additionalProperties: false
      type: object
      required:
        - brand
      title: BrandResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    BrandTimeout:
      properties:
        milliseconds:
          type: integer
          maximum: 300000
          minimum: 1000
          title: Milliseconds
        behavior:
          type: string
          enum:
            - fail
            - return-partial
          title: Behavior
          default: fail
      additionalProperties: false
      type: object
      required:
        - milliseconds
      title: BrandTimeout
    BrandProfile:
      properties:
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        slogan:
          anyOf:
            - type: string
            - type: 'null'
          title: Slogan
        colors:
          items:
            $ref: '#/components/schemas/BrandColor'
          type: array
          title: Colors
        logos:
          items:
            $ref: '#/components/schemas/BrandLogo'
          type: array
          title: Logos
        backdrops:
          items:
            $ref: '#/components/schemas/BrandImage'
          type: array
          title: Backdrops
        socials:
          items:
            $ref: '#/components/schemas/BrandSocial'
          type: array
          title: Socials
        address:
          anyOf:
            - $ref: '#/components/schemas/BrandAddress'
            - type: 'null'
        stock:
          anyOf:
            - $ref: '#/components/schemas/BrandStock'
            - type: 'null'
        employees:
          anyOf:
            - $ref: '#/components/schemas/BrandEmployees'
            - type: 'null'
        is_nsfw:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Nsfw
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
        industries:
          anyOf:
            - $ref: '#/components/schemas/BrandIndustries'
            - type: 'null'
        links:
          anyOf:
            - $ref: '#/components/schemas/BrandLinks'
            - type: 'null'
        primary_language:
          anyOf:
            - type: string
              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
            - type: 'null'
          title: Primary Language
      additionalProperties: false
      type: object
      title: BrandProfile
    BrandCacheMetadata:
      properties:
        status:
          type: string
          enum:
            - hit
            - miss
            - zdr
          title: Status
        age_ms:
          type: integer
          minimum: 0
          title: Age Ms
      additionalProperties: false
      type: object
      required:
        - status
        - age_ms
      title: BrandCacheMetadata
    BrandKeyMetadata:
      properties:
        credits_consumed:
          type: integer
          title: Credits Consumed
        credits_remaining:
          type: integer
          title: Credits Remaining
      additionalProperties: false
      type: object
      required:
        - credits_consumed
        - credits_remaining
      title: BrandKeyMetadata
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    BrandColor:
      properties:
        hex:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
          title: Hex
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        source:
          type: string
          enum:
            - site
            - logo
          title: Source
      additionalProperties: false
      type: object
      required:
        - hex
        - source
      title: BrandColor
    BrandLogo:
      properties:
        url:
          type: string
          title: Url
        colors:
          items:
            $ref: '#/components/schemas/Color'
          type: array
          title: Colors
        resolution:
          anyOf:
            - $ref: '#/components/schemas/ImageResolution'
            - type: 'null'
        mode:
          anyOf:
            - type: string
              enum:
                - light
                - dark
                - has_opaque_background
            - type: 'null'
          title: Mode
        type:
          type: string
          enum:
            - icon
            - logo
          title: Type
      additionalProperties: false
      type: object
      required:
        - url
        - type
      title: BrandLogo
    BrandImage:
      properties:
        url:
          type: string
          title: Url
        colors:
          items:
            $ref: '#/components/schemas/Color'
          type: array
          title: Colors
        resolution:
          anyOf:
            - $ref: '#/components/schemas/ImageResolution'
            - type: 'null'
      additionalProperties: false
      type: object
      required:
        - url
      title: BrandImage
    BrandSocial:
      properties:
        type:
          type: string
          enum:
            - 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
          title: Type
        url:
          type: string
          title: Url
      additionalProperties: false
      type: object
      required:
        - type
        - url
      title: BrandSocial
    BrandAddress:
      properties:
        street:
          anyOf:
            - type: string
            - type: 'null'
          title: Street
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
        country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Code
        state_province:
          anyOf:
            - type: string
            - type: 'null'
          title: State Province
        state_code:
          anyOf:
            - type: string
            - type: 'null'
          title: State Code
        postal_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Postal Code
      additionalProperties: false
      type: object
      title: BrandAddress
    BrandStock:
      properties:
        ticker:
          anyOf:
            - type: string
            - type: 'null'
          title: Ticker
        exchange:
          anyOf:
            - type: string
            - type: 'null'
          title: Exchange
      additionalProperties: false
      type: object
      title: BrandStock
    BrandEmployees:
      properties:
        range:
          anyOf:
            - type: string
              enum:
                - 1 to 10
                - 11 to 50
                - 51 to 200
                - 201 to 500
                - 501 to 1000
                - 1001 to 5000
                - 5001 to 10000
                - 10001+
            - type: 'null'
          title: Range
        exact:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Exact
      additionalProperties: false
      type: object
      title: BrandEmployees
    BrandIndustries:
      properties:
        eic:
          items:
            $ref: '#/components/schemas/BrandIndustry'
          type: array
          title: Eic
      additionalProperties: false
      type: object
      title: BrandIndustries
    BrandLinks:
      properties:
        careers:
          anyOf:
            - type: string
            - type: 'null'
          title: Careers
        privacy:
          anyOf:
            - type: string
            - type: 'null'
          title: Privacy
        terms:
          anyOf:
            - type: string
            - type: 'null'
          title: Terms
        contact:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact
        blog:
          anyOf:
            - type: string
            - type: 'null'
          title: Blog
        pricing:
          anyOf:
            - type: string
            - type: 'null'
          title: Pricing
      additionalProperties: false
      type: object
      title: BrandLinks
    Color:
      properties:
        hex:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
          title: Hex
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
      additionalProperties: false
      type: object
      required:
        - hex
      title: Color
    ImageResolution:
      properties:
        width:
          type: integer
          exclusiveMinimum: 0
          title: Width
        height:
          type: integer
          exclusiveMinimum: 0
          title: Height
        aspect_ratio:
          type: number
          exclusiveMinimum: 0
          title: Aspect Ratio
      additionalProperties: false
      type: object
      required:
        - width
        - height
        - aspect_ratio
      title: ImageResolution
    BrandIndustry:
      properties:
        industry:
          type: string
          enum:
            - Aerospace & Defense
            - Technology
            - Finance
            - Healthcare
            - Retail & E-commerce
            - Entertainment
            - Education
            - Government & Nonprofit
            - Industrial & Energy
            - Automotive & Transportation
            - Lifestyle & Leisure
            - Luxury & Fashion
            - News & Media
            - Sports
            - Real Estate & PropTech
            - Legal & Compliance
            - Telecommunications
            - Agriculture & Food
            - Professional Services & Agencies
            - Chemicals & Materials
            - Logistics & Supply Chain
            - Hospitality & Tourism
            - Construction & Built Environment
            - Consumer Packaged Goods (CPG)
          title: Industry
        subindustry:
          type: string
          enum:
            - Defense Systems & Military Hardware
            - Aerospace Manufacturing
            - Avionics & Navigation Technology
            - Subsea & Naval Defense Systems
            - Space & Satellite Technology
            - Defense IT & Systems Integration
            - Software (B2B)
            - Software (B2C)
            - Cloud Infrastructure & DevOps
            - Cybersecurity
            - Artificial Intelligence & Machine Learning
            - Data Infrastructure & Analytics
            - Hardware & Semiconductors
            - Fintech Infrastructure
            - eCommerce & Marketplace Platforms
            - Developer Tools & APIs
            - Web3 & Blockchain
            - XR & Spatial Computing
            - Banking & Lending
            - Investment Management & WealthTech
            - Insurance & InsurTech
            - Payments & Money Movement
            - Accounting, Tax & Financial Planning Tools
            - Capital Markets & Trading Platforms
            - Financial Infrastructure & APIs
            - Credit Scoring & Risk Management
            - Cryptocurrency & Digital Assets
            - BNPL & Alternative Financing
            - Healthcare Providers & Services
            - Pharmaceuticals & Drug Development
            - Medical Devices & Diagnostics
            - Biotechnology & Genomics
            - Digital Health & Telemedicine
            - Health Insurance & Benefits Tech
            - Clinical Trials & Research Platforms
            - Mental Health & Wellness
            - Healthcare IT & EHR Systems
            - Consumer Health & Wellness Products
            - Online Marketplaces
            - Direct-to-Consumer (DTC) Brands
            - Retail Tech & Point-of-Sale Systems
            - Omnichannel & In-Store Retail
            - E-commerce Enablement & Infrastructure
            - Subscription & Membership Commerce
            - Social Commerce & Influencer Platforms
            - Fashion & Apparel Retail
            - Food, Beverage & Grocery E-commerce
            - Streaming Platforms (Video, Music, Audio)
            - Gaming & Interactive Entertainment
            - Creator Economy & Influencer Platforms
            - Film, TV & Production Studios
            - Events, Venues & Live Entertainment
            - Virtual Worlds & Metaverse Experiences
            - K-12 Education Platforms & Tools
            - Higher Education & University Tech
            - Online Learning & MOOCs
            - Test Prep & Certification
            - Corporate Training & Upskilling
            - Tutoring & Supplemental Learning
            - Education Management Systems (LMS/SIS)
            - Language Learning
            - Creator-Led & Cohort-Based Courses
            - Special Education & Accessibility Tools
            - Government Technology & Digital Services
            - Civic Engagement & Policy Platforms
            - International Development & Humanitarian Aid
            - Philanthropy & Grantmaking
            - Nonprofit Operations & Fundraising Tools
            - Public Health & Social Services
            - Education & Youth Development Programs
            - Environmental & Climate Action Organizations
            - Legal Aid & Social Justice Advocacy
            - Municipal & Infrastructure Services
            - Manufacturing & Industrial Automation
            - Energy Production (Oil, Gas, Nuclear)
            - Renewable Energy & Cleantech
            - Utilities & Grid Infrastructure
            - Industrial IoT & Monitoring Systems
            - Construction & Heavy Equipment
            - Mining & Natural Resources
            - Environmental Engineering & Sustainability
            - Energy Storage & Battery Technology
            - Automotive OEMs & Vehicle Manufacturing
            - Electric Vehicles (EVs) & Charging Infrastructure
            - Mobility-as-a-Service (MaaS)
            - Fleet Management
            - Public Transit & Urban Mobility
            - Autonomous Vehicles & ADAS
            - Aftermarket Parts & Services
            - Telematics & Vehicle Connectivity
            - Aviation & Aerospace Transport
            - Maritime Shipping
            - Fitness & Wellness
            - Beauty & Personal Care
            - Home & Living
            - Dating & Relationships
            - Hobbies, Crafts & DIY
            - Outdoor & Recreational Gear
            - Events, Experiences & Ticketing Platforms
            - Designer & Luxury Apparel
            - Accessories, Jewelry & Watches
            - Footwear & Leather Goods
            - Beauty, Fragrance & Skincare
            - Fashion Marketplaces & Retail Platforms
            - Sustainable & Ethical Fashion
            - Resale, Vintage & Circular Fashion
            - Fashion Tech & Virtual Try-Ons
            - Streetwear & Emerging Luxury
            - Couture & Made-to-Measure
            - News Publishing & Journalism
            - Advertising, Adtech & Media Buying
            - Digital Media & Content Platforms
            - Broadcasting (TV & Radio)
            - Podcasting & Audio Media
            - News Aggregators & Curation Tools
            - Independent & Creator-Led Media
            - Newsletters & Substack-Style Platforms
            - Political & Investigative Media
            - Trade & Niche Publications
            - Media Monitoring & Analytics
            - Professional Teams & Leagues
            - Sports Media & Broadcasting
            - Sports Betting & Fantasy Sports
            - Fitness & Athletic Training Platforms
            - Sportswear & Equipment
            - Esports & Competitive Gaming
            - Sports Venues & Event Management
            - Athlete Management & Talent Agencies
            - Sports Tech & Performance Analytics
            - Youth, Amateur & Collegiate Sports
            - Real Estate Marketplaces
            - Property Management Software
            - Rental Platforms
            - Mortgage & Lending Tech
            - Real Estate Investment Platforms
            - Law Firms & Legal Services
            - Legal Tech & Automation
            - Regulatory Compliance
            - E-Discovery & Litigation Tools
            - Contract Management
            - Governance, Risk & Compliance (GRC)
            - IP & Trademark Management
            - Legal Research & Intelligence
            - Compliance Training & Certification
            - Whistleblower & Ethics Reporting
            - Mobile & Wireless Networks (3G/4G/5G)
            - Broadband & Fiber Internet
            - Satellite & Space-Based Communications
            - Network Equipment & Infrastructure
            - Telecom Billing & OSS/BSS Systems
            - VoIP & Unified Communications
            - Internet Service Providers (ISPs)
            - Edge Computing & Network Virtualization
            - IoT Connectivity Platforms
            - Precision Agriculture & AgTech
            - Crop & Livestock Production
            - Food & Beverage Manufacturing & Processing
            - Food Distribution
            - Restaurants & Food Service
            - Agricultural Inputs & Equipment
            - Sustainable & Regenerative Agriculture
            - Seafood & Aquaculture
            - Management Consulting
            - Marketing & Advertising Agencies
            - Design, Branding & Creative Studios
            - IT Services & Managed Services
            - Staffing, Recruiting & Talent
            - Accounting & Tax Firms
            - Public Relations & Communications
            - Business Process Outsourcing (BPO)
            - Professional Training & Coaching
            - Specialty Chemicals
            - Commodity & Petrochemicals
            - Polymers, Plastics & Rubber
            - Coatings, Adhesives & Sealants
            - Industrial Gases
            - Advanced Materials & Composites
            - Battery Materials & Energy Storage
            - Electronic Materials & Semiconductor Chemicals
            - Agrochemicals & Fertilizers
            - Freight & Transportation Tech
            - Last-Mile Delivery
            - Warehouse Automation
            - Supply Chain Visibility Platforms
            - Logistics Marketplaces
            - Shipping & Freight Forwarding
            - Cold Chain Logistics
            - Reverse Logistics & Returns
            - Cross-Border Trade Tech
            - Transportation Management Systems (TMS)
            - Hotels & Accommodation
            - Vacation Rentals & Short-Term Stays
            - Restaurant Tech & Management
            - Travel Booking Platforms
            - Tourism Experiences & Activities
            - Cruise Lines & Marine Tourism
            - Hospitality Management Systems
            - Event & Venue Management
            - Corporate Travel Management
            - Travel Insurance & Protection
            - Construction Management Software
            - BIM/CAD & Design Tools
            - Construction Marketplaces
            - Equipment Rental & Management
            - Building Materials & Procurement
            - Construction Workforce Management
            - Project Estimation & Bidding
            - Modular & Prefab Construction
            - Construction Safety & Compliance
            - Smart Building Technology
            - Food & Beverage CPG
            - Home & Personal Care CPG
            - CPG Analytics & Insights
            - Direct-to-Consumer CPG Brands
            - CPG Supply Chain & Distribution
            - Private Label Manufacturing
            - CPG Retail Intelligence
            - Sustainable CPG & Packaging
            - Beauty & Cosmetics CPG
            - Health & Wellness CPG
          title: Subindustry
      additionalProperties: false
      type: object
      required:
        - industry
        - subindustry
      title: BrandIndustry
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: token

````

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