Skip to main content
POST
brand.identity.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
domain
string

Website domain.

ticker
string

Stock ticker, including an exchange suffix.

Required string length: 1 - 32
Pattern: ^[A-Z0-9][A-Z0-9.:-]*$
isin
string

Securities identifier.

Required string length: 1 - 12
Pattern: ^[A-Z]{2}[A-Z0-9]{9}[0-9]$
cryptoSymbol
string

Cryptocurrency symbol.

Required string length: 1 - 32
Pattern: ^[A-Z0-9][A-Z0-9.-]*$
cachedOnly
boolean
default:false

Use indexed data only; a miss does not queue a crawl.

allowAdultContent
boolean

Explicitly allow brands for adult content.

includePalette
boolean
default:false

Include measured website and mark colors.

Response

The result

name
string
required

Brand display name.

Required string length: 1 - 2000
domain
any
required

Resolved website domain.

colors
object[]
required

Brand colors; website roles are present only when measured.

Maximum array length: 128
fonts
object[]
required

Curated typography, not measured website font stacks.

Maximum array length: 20
assets
object[]
required

Logo and image metadata; no downloads.

Maximum array length: 100
socials
object[]
required

Public links.

Maximum array length: 20
description
string

Short brand description.

Required string length: 1 - 2000
longDescription
string

Long brand description.

Required string length: 1 - 10000
claimed
boolean

Whether the owner claimed the profile.

adultContent
boolean

Whether the brand is for adult content.

company
object

Public company information.

palette
object

Observed palette data.

financialIdentifiers
object

Public financial identifiers.

companyKind
string

Company structure.

Required string length: 1 - 64
employeeRange
object

Employee range, never an exact count.