GET Search

Search logos for market securities/companies and funds

Response (200 OK)

[
  {
    "id": "string",
    "search_key": "string",
    "created_at": "string (RFC3339/ISO8601)",
    "updated_at": "string (RFC3339/ISO8601)",
    "colors": {
      "background_light": "string (#000/#abc000)",
      "background_dark": "string (#000/#abc000)"
    },
    "files": {
      "logo_light": "string",
      "logo_dark": "string",
      "logo_vector_light": "string",
      "logo_vector_dark": "string",
      "mark_light": "string",
      "mark_dark": "string",
      "mark_composite_light": "string",
      "mark_composite_dark": "string",
      "mark_vector_light": "string",
      "mark_vector_dark": "string"
    },
    "securities": [
      {
        "exchange": "string",
        "symbol": "string",
        "name": "string",
        "cik": "string",
        "cusip": "string",
        "isin": "string"
      }
    ]
  }
]

Authorizations

token

string

query

required

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

Successful response

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

files

object

required

Show child attributes

files.logo_light

string

URI of company logo for use in a white/light theme. Image file type of PNG.

files.logo_dark

string

URI of company logo for use in a dark theme. Image file type of PNG.

files.logo_vector_light

string

URI of company logo for use in a white/light theme. Vector file type of SVG.

files.logo_vector_dark

string

URI of company logo for use in a dark theme. Vector file type of SVG.

files.mark_light

string

URI of company mark for use in a white/light theme. Image file type of PNG.

files.mark_dark

string

URI of company mark for use in a dark theme. Image file type of PNG.

files.mark_composite_light

string

URI of composite image with the company mark for use in a light/white theme.

files.mark_composite_dark

string

URI of composite image with the company mark for use in a dark theme.

files.mark_vector_light

string

URI of company mark for use in a white/light theme. Vector file type of SVG.

files.mark_vector_dark

string

URI of company mark for use in a dark theme. Vector file type of SVG.

id

string

Record identifier

colors

object

Show child attributes

colors.background_light

string

Background color in HEX format to use in a white/light theme.

colors.background_dark

string

Background color in HEX format to use in a dark theme.

securities

object[]

A security object. Only included with sync operations.

Show child attributes

securities.exchange

string

Exchange on which the security is listed

securities.symbol

string

Ticker symbol for the security

securities.name

string

Name of security or company

securities.cik

string

CIK

securities.cusip

string

CUSIP

securities.isin

string

ISIN