Skip to main content
Server path: /benzinga-reference | Type: Application | PCID required: Yes

Tools

ToolDescription
benzinga_reference_get_consensus_ratings_1Returns analyst ratings data]
benzinga_reference_get_gov_usa_congress_tradesReturns government trades data
benzinga_reference_get_logosLogos for market securities
benzinga_reference_get_logos_searchSearch logos for market securities/companies
benzinga_reference_get_logos_syncBulk sync logos.
benzinga_reference_get_sec_insider_transactions_filingsReturns insider transactions data (SEC Form 4)

benzinga_reference_get_consensus_ratings_1

Returns analyst ratings data] Parameters:
ParameterTypeRequiredDefaultDescription
pagesizeintegerNoNumber of results returned. Limit 1000
parameters[date_from]stringNoDate to query from point in time.
parameters[date_to]stringNoDate to query to point in time.
parameters[tickers]stringNoOne ticker symbol to query the aggregate for. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use “parameters[securities]” instead). Ignored by the Economics endpoint. Maximum 1 ticker.
simplifybooleanNoTo simplify the aggregate ratings to only BUY, SELL, HOLD, default will return all ratings (STRONG_BUY, BUY, HOLD, SELL, STRONG_SELL).
aggregate_typestringNoTo aggregate the ratings by either number or percentage.

benzinga_reference_get_gov_usa_congress_trades

Returns government trades data Parameters:
ParameterTypeRequiredDefaultDescription
chamberstringNoSpecific chamber of congress, either House or Senate. Defaults to all of congress.
datestringNoDate to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest.
date_fromstringNoDate to query from point in time.
date_tostringNoDate to query to point in time.
fieldsstring[]NoA comma (,) separated list of returned fields.
pagesizeintegerNoNumber of results returned. Limit 1000
pageintegerNoPage offset.
search_keysstringNoOne or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities.
updated_sincenumberNoRecords last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates.

benzinga_reference_get_logos

Logos for market securities Parameters:
ParameterTypeRequiredDefaultDescription
symbolsstringYesA list of ticker symbols separated by a comma (,). Limit 50 tickers per request.
filtersstringNoA list of client-specific filters to be applied. Filters are separated by a comma (,).

Search logos for market securities/companies Parameters:
ParameterTypeRequiredDefaultDescription
search_keysstring[]YesA 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_typestringNoThe type of identifier being searched. Supported types are currently a security symbol and CIK.
fieldsstring[]YesA comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API.
composite_autobooleanNoIf no image exists, generate a fill image based on the company name and background color.
composite_radiusintegerNoApply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle.
scalestringNoSpecified 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

benzinga_reference_get_logos_sync

Bulk sync logos. Parameters:
ParameterTypeRequiredDefaultDescription
updated_sinceintegerNoLast updated unix timestamp, UTC
fieldsstring[]YesA comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API.
composite_autobooleanNoIf no image exists, generate a fill image based on the company name and background color.
composite_radiusintegerNoApply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle.
scalestringNoSpecified 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
pageintegerNoPage offset.
pagesizeintegerNoNumber of results returned. Default 100

benzinga_reference_get_sec_insider_transactions_filings

Returns insider transactions data (SEC Form 4) Parameters:
ParameterTypeRequiredDefaultDescription
datestringNoDate to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest.
date_fromstringNoDate to query from point in time.
date_tostringNoDate to query to point in time.
fieldsstring[]NoA comma (,) separated list of returned fields.
pagesizeintegerNoNumber of results returned. Limit 1000
pageintegerNoPage offset.
search_keysstringNoOne or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities.
search_keys_typestringNoThe type of identifier being searched. Supported types are currently a security symbol, accession number and filing id.
updated_sincenumberNoRecords last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates.