Skip to main content
POST
brand.assets.list

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.

kinds
enum<string>[]

Kinds to include.

Required array length: 1 - 6 elements

Asset kind.

Available options:
icon,
logo,
symbol,
other,
banner,
picture
limit
integer
default:25

Maximum assets.

Required range: 1 <= x <= 25
includeFiles
boolean
default:false

Copy available supported raster images.

assetSize
integer
default:800

Exact source width for copies.

Required range: 16 <= x <= 800
assetFormat
enum<string>
default:png

Copy format.

Available options:
png,
jpg,
webp

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.