Skip to main content
POST
companies.brandmark.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

Bare website domain, without a path or protocol.

Required string length: 1 - 253
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
name
string

Brand name.

Required string length: 1 - 256
ticker
string

Stock ticker, including an exchange suffix when needed.

Required string length: 1 - 32
Pattern: ^[A-Z0-9][A-Z0-9.:-]{0,31}$
isin
string

Twelve-character securities identifier; its check digit is not verified.

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.-]{0,31}$
merchantDescriptor
string

Merchant descriptor; available only when this selector is enabled.

Required string length: 1 - 1024
size
integer
default:800

Rendered image size in pixels, 1 to 800. Default 800.

Required range: 1 <= x <= 800
format
enum<string>
default:png

Rendered file format. Default png.

Available options:
png,
jpg,
webp
theme
enum<string>
default:light

Rendered image theme. Default light.

Available options:
light,
dark

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.