GET
/
search

Authorizations

token
string
queryrequired

Headers

accept
enum<string>
default: application/json

Specifies return format

Available options:
application/json

Query Parameters

search_keys
string[]
required

A comma (,) separated list of search identifiers. Identifiers are based on the search_type field. Limit 100 per request.

Example: F,AAPL

Logos can also be queried with format <EXCHANGE>:<SYMBOL> i.e. NYSE:ARI

search_keys_type
enum<string>
default: symbol

The type of identifier being searched. Supported types are currently a security symbol and CIK.

Available options:
symbol,
cik,
cusip,
isin
fields
enum<string>[]
required

A comma (,) separated list of returned fields.

Example: mark_light,background_light

Would return ONLY the mark_light, background_light values from the API.

Available options:
logo_light,
logo_dark,
logo_vector_light,
logo_vector_dark,
mark_light,
mark_dark,
mark_vector_light,
mark_vector_dark,
mark_composite_light,
mark_composite_dark
composite_auto
boolean
default: false

If no image exists, generate a fill image based on the company name and background color.

composite_radius
integer
default: 0

Apply a radius to the composite image.

Default value is 0. Maximum value is 50 (50%) which will result in a circle.

scale
string

Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to contain.

Scale will be applied to: logo_light, logo_dark, mark_light, mark_dark, mark_composite_light, mark_composite_dark

Example: 300x600

Response

200 - application/json
id
string

Record identifier

search_key
string
required

The identifying search term, ex. cik or symbol value(s). If search was not used, not value will be returned.

created_at
string
required

Created timestamp, UTC

updated_at
string
required

Last updated timestamp, UTC

colors
object
files
object
required
securities
object[]

Was this page helpful?

Corporate Logos v2.0 API ReferenceGET Sync