Python Client

Benzinga’s Python Client Library’s Documentation

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:

pip install benzinga

Alternatively, the package can be installed by using:

pip3 install benzinga

Once you have successfully installed the package, you can either import the Financial Data module, for quantitative financial data:

from benzinga import financial_data

or you can import the Benzinga News Data module, if you’re looking into financial news:

from benzinga import news_data

Your 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

1. Initiating the class:

from benzinga import financial_data
api_key = "testkey892834789s9s8abshtuy"
fin = financial_data.Benzinga(api_key)

2. A sample test run to get ratings on a stock. (Returns a JSON object):

stock_ratings = fin.ratings()

3. 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

1. Initiating the class:

from benzinga import news_data
api_key = "testkey892834789s9s8abshtuy"
paper = news_data.News(api_key)

2. A sample test run to get general news. (Returns a JSON Object)

stories = paper.news()

3. 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:

paper.output(stories)

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

fin.bars()

Public Method: Benzinga Bars looks at detailed price values over a period of time.

Arguments

company_tickers · str · required

date_from · str · required

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.

date_to · str

“YYYY-MM-DD”

interval · str · default: "5M"

1MONTH, 1W, 1D, 1H, 15M, 5M

Returns

open, high, low, close, volume, time, dateTime

Delayed Quote

fin.delayed_quote()

Public Method: Benzinga Quote looks at many different attributes of the ticker like high, low, close etc

Arguments

company_tickers · str · required

Returns

date, previousClose, change, changePercent, fiftyTwoWeekHigh, fiftyTwoWeekLow, currency, last, tradingHalted, volume, previousCloseDate

Dividends

fin.dividends()

Public Method: Benzinga Dividends looks at the relevant dividend information for a company.

Arguments

page · int

page offset

pagesize · int

limit of results returned

date_asof · str

“YYYY-MM-DD”

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

company_tickers · str

importance · int

not tested yet

date_sort · str

Dividend date field to sort on (ex, payable, record)

updated_params · int64

Records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.

div_yield_operation · str

To filter the div yield by for eg. gt, gte, eq, lte, lt. Not tested

div_yield · int

Div yield amount fo filter by. 1 for 100% or above.

Returns

the id, date, updated, ticker, name, exchange, frequency, dividend, dividend prior, dividend type, dividend yield, ex-dividend date, payable date, record date, importance

Ratings

fin.ratings()

Public Method: Benzinga Ratings looks at ratings from different firms

Arguments

page · int

page offset

pagesize · int

limit of results returned

date_asof · str

“YYYY-MM-DD”

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

company_tickers · str

importance · int

not tested yet.

date_sort · str

Ratings date field to sort on

updated_params · int64

records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.

action · str

Options are: Downgrades, Maintains, Reinstates, Reiterates, Upgrades, Assumes, Initiates Coverage On, Terminates Coverage On, Removes, Suspends, Firm Dissolved

Returns

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

fin.earnings()

Public Method: Benzinga Earnings looks at the quarterly earnings reports for different companies.

Arguments

page · int

page offset

pagesize · int

limit of results returned

date_asof · str

“YYYY-MM-DD”

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

company_tickers · str

importance · int

not tested yet.

date_sort · str

Earnings date field to sort on

updated_params · int64

records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.

Returns

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

fin.splits()

Public Method: Benzinga Splits looks at the stock splits calendar data

Arguments

page · int

page offset

pagesize · int

limit of results returned

date_asof · str

“YYYY-MM-DD”

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

company_tickers · str

importance · int

not tested yet.

date_sort · str

Splits date field to sort on

updated_params · int64

records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.

Returns

id, updated, date, time, ticker, exchange, importance, ratio, optionable, date_ex, date_recorded, date_distribution

Economics

fin.economics()

Public Method: Benzinga Economics looks at different economic events in a country.

Arguments

page · int

page offset

pagesize · int

limit of results returned

date_asof · str

“YYYY-MM-DD”

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

importance · int

not tested yet.

date_sort · str

Economics date field to sort on

updated_params · int64

records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.

country · str

3 digit country code

Returns

id, date, time, country, event_name, event_period, period_year, actual, actual_t consensus, consensus_t, prior, importance, updated, description

Guidance

fin.guidance()

Public Method: Benzinga Guidance looks at different attributes like revenue guidance etc.

Arguments

page · int

page offset

pagesize · int

limit of results returned

date_asof · str

“YYYY-MM-DD”

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

company_tickers · str

importance · int

not tested yet.

date_sort · str

Guidance date field to sort on

updated_params · int64

records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.

country · str

3 digit country code

Returns

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

fin.ipo()

Public Method: Benzing IPO looks at initial public offering data for companies.

Arguments

page · int

page offset

pagesize · int

limit of results returned

date_asof · str

“YYYY-MM-DD”

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

company_tickers · str

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.

date_sort · str

IPO date field to sort on

updated_params · int64

records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.

Returns

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

fin.conference_calls()

Public Method: Benzinga Conference calls looks at conference calls.

Arguments

page · int

page offset

pagesize · int

limit of results returned

date_asof · str

“YYYY-MM-DD”

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

company_tickers · str

date_sort · str

Conference call date field to sort on

updated_params · int64

records last updated unix time stamp. Forces the sort order to be greater or equal to the time stamp indicated.

country · str

3 digit country code

Returns

id, date, time, ticker, exchange, name, start_time, phone_num, international_line, reservation_num, access_code, webcast_url, importance, updated

Fundamentals

fin.fundamentals()

Public Method: Benzinga Fundamentals looks at overall financial data for a company.

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

company, companyProfile, shareClass, earningReports, financialStatements, operation earning and valuation ratios, alphaBeta

Financials

fin.financials()

Public Method: Benzinga Financials looks at overall financial data like for a company.

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

period · str

select from (3M , 6M , 9M , 12M , 1Y)

reporttype · str · default: "A"

select from (TTM, A, R,P)

Returns

company, financials such as balance sheet information, assets and liabilities

Valuation Ratios

fin.valuation_ratios()

Public Method: Benzinga Valuation Ratios looks at overall financial data like for a company.

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of the valuation ratios

Earning Ratios

fin.earning_ratios()

Public Method: Benzinga Earning Ratios

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of the earning ratios

Operation Ratios

fin.operation_ratios()

Public Method: Benzinga Operation Ratios

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of the operation ratios

Share Class

fin.share_class()

Public Method: Benzinga Share Class

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of the share class

Earning Reports

fin.earning_reports()

Public Method: Benzinga Earning Reports looks at overall earning reports for a company.

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of the earning reports

Alpha Beta

fin.alpha_beta()

Public Method: Benzinga Alpha Beta

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of alphabeta

Company Profile

fin.company_profile()

Public Method: Benzinga Company Profile

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of company profile

Company

fin.company()

Public Method: Benzinga Company

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of the company

Asset Classification

fin.asset_classification()

Public Method: Benzinga Asset Classification

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of the asset classification

Summary

fin.summary()

Public Method: Summary

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of the summary

Logos

fin.logos()

Public Method: Benzinga Logos

Arguments

company_tickers · str · required

date_asof · str

“YYYY-MM-DD”

Returns

different attributes of the logos

Options Activity

fin.options_activity()

Public Method: Benzinga Options Activity

Arguments

company_tickers · str · required

pagesize · int

Limit is set to 1000

page · int

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

Returns

different attributes for options activity

News Data

News

fin.news()

Public Method: Benzinga News

Arguments

pagesize · int · default: "15"

page · int · default: "0"

display_output · str

select from full, abstract, headline

base_date · str

“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.

date_from · str

“YYYY-MM-DD”

date_to · str

“YYYY-MM-DD”

updated_since · str

The last updated unix timestamp (UTC) to pull and sort by.

published_since · str

The last published unix timestamp (UTC) to pull and sort by.

company_tickers · str

channel · str

multiple channels separated by comma

Returns

Author, created, updated, title, teaser, body, url, image, channels, stocks, tags

---

Benzinga News

Benzinga Pro