Getting Started Benzinga’s Python client library focuses on financial data methods, that can be used for quantitative analysis, and on news data from Benzinga, that can help give meaningful insights that complement quantitative data.
The installation process varies depending on your python version and system used. The basic installation instructions are as follows:
Alternatively, the package can be installed by using:
Once you have successfully installed the package, you can either import the Financial Data module, for quantitative financial data:
from benzinga import financial_dataor you can import the Benzinga News Data module, if you’re looking into financial news:
from benzinga import news_dataYour Key Api Key To initiate a class, an API key is used, for authentication purposes. Contact us if you don’t yet have a key, we will take care of you!
Sample API Key (type: str) : “testkey892834789s9s8abshtuy”
Sample Test Financial Data Module
Initiating the class:
from benzinga import financial_dataapi_key = "testkey892834789s9s8abshtuy"
fin = financial_data. Benzinga( api_key)
A sample test run to get ratings on a stock. (Returns a JSON object):
stock_ratings = fin. ratings( )
Since fin.ratings() returns a JSON dict, for a better view of the dict, you can call the fin.output() method on the result. Example:
fin. output( stock_ratings)
Sample Test News Data Module
Initiating the class:
from benzinga import news_dataapi_key = "testkey892834789s9s8abshtuy"
paper = news_data. News( api_key)
A sample test run to get general news. (Returns a JSON Object)
Since fin.news() returns a JSON dict, for a better view of the dict, you can call the fin.output() method on the result. Example:
It is important to note that for both the Financial Data Module and the News Data Module, there are many optional parameters for the methods. Below is a detailed listing of possible methods for the Financial Data Module and the news Data Module, their method call names, arguments, and what they return.
Best Practices When possible, we highly recommend using updated parameters, particularly for ingestion of live data (as opposed to historical data). It shrinks the query universe much more efficiently than the other parameters, mitigating latency.
Financial Data methods Bars Public Method: Benzinga Bars looks at detailed price values over a period of time.
For date_from, you can enter YTD for the first trading day of the year. 1d, 5d or 1m. You can also enter the date from in the “YYYY-MM-DD” format.
1MONTH, 1W, 1D, 1H, 15M, 5M
open, high, low, close, volume, time, dateTime
Delayed Quote Public Method: Benzinga Quote looks at many different attributes of the ticker like high, low, close etc
date, previousClose, change, changePercent, fiftyTwoWeekHigh, fiftyTwoWeekLow, currency, last, tradingHalted, volume, previousCloseDate
Dividends Public Method: Benzinga Dividends looks at the relevant dividend information for a company.
limit of results returned
Dividend date field to sort on (ex, payable, record)
Records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.
To filter the div yield by for eg. gt, gte, eq, lte, lt. Not tested
Div yield amount fo filter by. 1 for 100% or above.
the id, date, updated, ticker, name, exchange, frequency, dividend, dividend prior, dividend type, dividend yield, ex-dividend date, payable date, record date, importance
Ratings Public Method: Benzinga Ratings looks at ratings from different firms
limit of results returned
Ratings date field to sort on
records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.
Options are: Downgrades, Maintains, Reinstates, Reiterates, Upgrades, Assumes, Initiates Coverage On, Terminates Coverage On, Removes, Suspends, Firm Dissolved
id, date, time, ticker, exchange, name, action_pt, action_company, rating_current, pt_current, rating_prior, pt_prior, url, importance, updated, url_calendar, url_news, analyst, analyst_name
Earnings Public Method: Benzinga Earnings looks at the quarterly earnings reports for different companies.
limit of results returned
Earnings date field to sort on
records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.
id, date, date confirmed, time, ticker, exchange, name, period, period_year, eps, eps_est, eps_prior, eps_surprise, eps_surprise_percent, revenue, revenue est, revenue_prior, revenue_surprise, revenue_surprise_percent, importance, updated
Splits Public Method: Benzinga Splits looks at the stock splits calendar data
limit of results returned
Splits date field to sort on
records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.
id, updated, date, time, ticker, exchange, importance, ratio, optionable, date_ex, date_recorded, date_distribution
Economics Public Method: Benzinga Economics looks at different economic events in a country.
limit of results returned
Economics date field to sort on
records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.
id, date, time, country, event_name, event_period, period_year, actual, actual_t consensus, consensus_t, prior, importance, updated, description
Guidance Public Method: Benzinga Guidance looks at different attributes like revenue guidance etc.
limit of results returned
Guidance date field to sort on
records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.
id, date, time, ticker, exchange, name, period, period_year, prelim, eps_guidance_est, eps_guidance_max, eps_guidance_min, eps_guidance_prior_max, eps_guidance_prior_min, revenue_guidance_est, revenue_guidance_max, revenue_guidance_min, revenue_guidance_prior_max , revenue_guidance_prior_min, importance, updated
IPO Public Method: Benzing IPO looks at initial public offering data for companies.
limit of results returned
note: new tickers may not return results right away as we do not automatically link them to the underlying company’s data. To obtain the most recent rows, send queries without this parameter specified.
IPO date field to sort on
records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.
id, date, time, ticker, exchange, name, pricing_date, currency, price_min, price_max, deal_status, ipo_type, insider_lockup_days, insider_lockup_date, offering_value, offering_shares, shares_outstanding, lead_underwriters, other_underwriters, underwriter_quiet_expiration_days, underwriter_quiet_expiration_date, notes, updated`
Conference Calls Public Method: Benzinga Conference calls looks at conference calls.
limit of results returned
Conference call date field to sort on
records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.
id, date, time, ticker, exchange, name, start_time, phone_num, international_line, reservation_num, access_code, webcast_url, importance, updated
Fundamentals Public Method: Benzinga Fundamentals looks at overall financial data for a company.
company, companyProfile, shareClass, earningReports, financialStatements, operation earning and valuation ratios, alphaBeta
Financials Public Method: Benzinga Financials looks at overall financial data like for a company.
select from (3M , 6M , 9M , 12M , 1Y)
select from (TTM, A, R,P)
company, financials such as balance sheet information, assets and liabilities
Valuation Ratios Public Method: Benzinga Valuation Ratios looks at overall financial data like for a company.
different attributes of the valuation ratios
Earning Ratios Public Method: Benzinga Earning Ratios
different attributes of the earning ratios
Operation Ratios Public Method: Benzinga Operation Ratios
different attributes of the operation ratios
Share Class Public Method: Benzinga Share Class
different attributes of the share class
Earning Reports Public Method: Benzinga Earning Reports looks at overall earning reports for a company.
different attributes of the earning reports
Alpha Beta Public Method: Benzinga Alpha Beta
different attributes of alphabeta
Company Profile Public Method: Benzinga Company Profile
different attributes of company profile
Company Public Method: Benzinga Company
different attributes of the company
Asset Classification fin.asset_classification()
Public Method: Benzinga Asset Classification
different attributes of the asset classification
Summary Public Method: Summary
different attributes of the summary
Logos Public Method: Benzinga Logos
different attributes of the logos
Options Activity Public Method: Benzinga Options Activity
different attributes for options activity
News Data News Public Method: Benzinga News
select from full, abstract, headline
”YYYY-MM-DD” The date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest.
The last updated unix timestamp (UTC) to pull and sort by.
The last published unix timestamp (UTC) to pull and sort by.
multiple channels separated by comma
Author, created, updated, title, teaser, body, url, image, channels, stocks, tags
Benzinga News
Benzinga Pro
