Corporate Logos v2.0 JWT API Reference

Free Trial ➡

The Benzinga Corporate Logo API is designed to be flexible with client sizing requirements. It supports JWT based authentication.

API Endpoint
https://jwtapi.benzinga.com/api/v2/logos
Response Content-Types

application/json

Schemes

https

Version

2.0.0

Authentication

Bearer authentication

JWT, Refer Benzinga JWT for more information. For JWT, we recommend using RS256. You may generate sample JWT using https://jwt.io/. You need to send us public/private key depending upon which algorithm you are using. We will add that public/private key on our side, so it will verify signature generated. Also, you need to send us the value of iss (issuer) value of payload.
Note: Prepend Bearer to your actual jwt when you authorize here to test.

Type:
apiKey
Name:
Authorization
In:
header

Playground

Endpoints

GET /search

Search logos for market securities/companies

Parameters

NameTypeLocationDescription
acceptstring , x ∈ { application/json (default) }header

Specifies return format

search_keysstring[]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_typestring , x ∈ { symbol (default) , cik , cusip }query

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

fieldsstring[]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_autobooleanquery

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

composite_radiusintegerquery

Apply a radius to the composite image.

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

scalestringquery

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

CodeModelDescription
200 OKdata

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

GET /sync

Bulk sync logos.

Parameters

NameTypeLocationDescription
acceptstring , x ∈ { application/json (default) }header

Specifies return format

updated_sinceinteger (int64)query

Last updated unix timestamp, UTC

fieldsstring[]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_autobooleanquery

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

composite_radiusintegerquery

Apply a radius to the composite image.

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

scalestringquery

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

pageintegerquery

Page offset.

pagesizeintegerquery

Number of results returned. Default 100

Responses

CodeModelDescription
200 OKdata

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

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.

PropertyTypeDescription
idstring

Reference request error ID. (You can use this for reporting to Benzinga team.)

codestring

The error status

valuestring

Details for the error state

Structure (JSON)
{
  "id": "string",
  "code": "string",
  "value": "string"
}

data: object

PropertyTypeDescription
idstring

Record identifier

search_keystring

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

created_atstring (RFC3339/ISO8601)

Created timestamp, UTC

updated_atstring (RFC3339/ISO8601)

Last updated timestamp, UTC

colorsobject-
colors.background_lightstring (#000/#abc000)

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

colors.background_darkstring (#000/#abc000)

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

filesobject-
files.logo_lightstring

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

files.logo_darkstring

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

files.logo_vector_lightstring

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

files.logo_vector_darkstring

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

files.mark_lightstring

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

files.mark_darkstring

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

files.mark_composite_lightstring

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

files.mark_composite_darkstring

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

files.mark_vector_lightstring

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

files.mark_vector_darkstring

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

securitiesobject[]-
securities[].exchangestring

Exchange on which the security is listed

securities[].symbolstring

Ticker symbol for the security

securities[].namestring

Name of security or company

securities[].cikstring

CIK

securities[].cusipstring

CUSIP

securities[].isinstring

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

PropertyTypeDescription
background_lightstring (#000/#abc000)

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

background_darkstring (#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

PropertyTypeDescription
logo_lightstring

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

logo_darkstring

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

logo_vector_lightstring

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

logo_vector_darkstring

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

mark_lightstring

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

mark_darkstring

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

mark_composite_lightstring

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

mark_composite_darkstring

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

mark_vector_lightstring

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

mark_vector_darkstring

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.

PropertyTypeDescription
exchangestring

Exchange on which the security is listed

symbolstring

Ticker symbol for the security

namestring

Name of security or company

cikstring

CIK

cusipstring

CUSIP

isinstring

ISIN

Structure (JSON)
[
  {
    "exchange": "string",
    "symbol": "string",
    "name": "string",
    "cik": "string",
    "cusip": "string",
    "isin": "string"
  }
]