Corporate Logos v2.0 API Reference

The Benzinga Corporate Logo API is designed to be flexible with client sizing requirements.

API Endpoint

https://api.benzinga.com/api/v2/logos

Response Content-Types

application/json

Schemes

https

Version

2.0.0

Authentication

`token` authentication

Type:: apiKey
Name:: token
In:: query

Playground

Endpoints

GET /search

Search logos for market securities/companies

Parameters

Name	Type	Location	Description
`accept`	string , x ∈ { application/json (default) }	header	Specifies return format
`search_keys`	string[]	query	A comma (,) separated list of search identifiers. Identifiers are based on the `search_type` field. Limit 100 per request. Example: F,AAPL
`search_keys_type`	string , x ∈ { symbol (default) , cik , cusip }	query	The type of identifier being searched. Supported types are currently a security symbol and CIK.
`fields`	string[]	query	A comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API.
`composite_auto`	boolean	query	If no image exists, generate a fill image based on the company name and background color.
`composite_radius`	integer	query	Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle.
`scale`	string	query	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

Responses

Code	Model	Description
`200 OK`	data	Successful response

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"
      }
    ]
  }
]


token

GET /sync

Bulk sync logos.

Parameters

Name	Type	Location	Description
`accept`	string , x ∈ { application/json (default) }	header	Specifies return format
`updated_since`	integer (int64)	query	Last updated unix timestamp, UTC
`fields`	string[]	query	A comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API.
`composite_auto`	boolean	query	If no image exists, generate a fill image based on the company name and background color.
`composite_radius`	integer	query	Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle.
`scale`	string	query	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
`page`	integer	query	Page offset.
`pagesize`	integer	query	Number of results returned. Default 100

Responses

Code	Model	Description
`200 OK`	data	Successful response

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"
      }
    ]
  }
]


token

Models

ok: boolean

Return status indicating the status of the result (OK if true, ERROR if false)

Structure (JSON)

"boolean"

errors: object

Error result if status is NOT ok.

Property	Type	Description
`id`	string	Reference request error ID. (You can use this for reporting to Benzinga team.)
`code`	string	The error status
`value`	string	Details for the error state

Structure (JSON)

{
  "id": "string",
  "code": "string",
  "value": "string"
}

data: object

Property	Type	Description
`id`	string	Record identifier
`search_key`	string	The identifying search term, ex. cik or symbol value(s). If search was not used, not value will be returned.
`created_at`	string (RFC3339/ISO8601)	Created timestamp, UTC
`updated_at`	string (RFC3339/ISO8601)	Last updated timestamp, UTC
`colors`	object	-
`colors.background_light`	string (#000/#abc000)	Background color in HEX format to use in a white/light theme.
`colors.background_dark`	string (#000/#abc000)	Background color in HEX format to use in a dark theme.
`files`	object	-
`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.
`securities`	object[]	-
`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

Structure (JSON)

{
  "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"
    }
  ]
}

colors: object

Property	Type	Description
`background_light`	string (#000/#abc000)	Background color in HEX format to use in a white/light theme.
`background_dark`	string (#000/#abc000)	Background color in HEX format to use in a dark theme.

Structure (JSON)

{
  "background_light": "string (#000/#abc000)",
  "background_dark": "string (#000/#abc000)"
}

files: object

Property	Type	Description
`logo_light`	string	URI of company logo for use in a white/light theme. Image file type of PNG.
`logo_dark`	string	URI of company logo for use in a dark theme. Image file type of PNG.
`logo_vector_light`	string	URI of company logo for use in a white/light theme. Vector file type of SVG.
`logo_vector_dark`	string	URI of company logo for use in a dark theme. Vector file type of SVG.
`mark_light`	string	URI of company mark for use in a white/light theme. Image file type of PNG.
`mark_dark`	string	URI of company mark for use in a dark theme. Image file type of PNG.
`mark_composite_light`	string	URI of composite image with the company mark for use in a light/white theme.
`mark_composite_dark`	string	URI of composite image with the company mark for use in a dark theme.
`mark_vector_light`	string	URI of company mark for use in a white/light theme. Vector file type of SVG.
`mark_vector_dark`	string	URI of company mark for use in a dark theme. Vector file type of SVG.

Structure (JSON)

{
  "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: object[]

object

A security object. Only included with sync operations.

Property	Type	Description
`exchange`	string	Exchange on which the security is listed
`symbol`	string	Ticker symbol for the security
`name`	string	Name of security or company
`cik`	string	CIK
`cusip`	string	CUSIP
`isin`	string	ISIN

Structure (JSON)

[
  {
    "exchange": "string",
    "symbol": "string",
    "name": "string",
    "cik": "string",
    "cusip": "string",
    "isin": "string"
  }
]

Documentation

Corporate Logos v2.0 API Reference

API Endpoint

Response Content-Types

Schemes

Version

Authentication

token authentication

Playground

Endpoints

GET /search

Parameters

Responses

Response (200 OK)

GET /sync

Parameters

Responses

Response (200 OK)

Models

ok: boolean

Structure (JSON)

errors: object

Structure (JSON)

data: object

Structure (JSON)

colors: object

Structure (JSON)

files: object

Structure (JSON)

securities: object[]

Structure (JSON)

`token` authentication