Benzinga.com Calendar API v2

Transcription

1 Benzinga.com Calendar API v2 Abstract This document proves an outline to the Benzinga.com API access to Calendar Data. Connection Connect using the following URL structure: <Calendar Type>?<Parameters> Authentication Parameters [token] = <unique API token key> // unique api key given to partner Data Data will be proved in XML or JSON form. Upon success, it will return event data for specific calendars. XML or JSON may be selected by passing the proper header. XML is current default. JSON Header: Accept: application/json Endpoints: Example: &parameters[tickers]=F&token= KEY api/v2/calendar/divends Divend Calendar Data Options

2 size The number of results returned. Default 50. Limit The to query for calendar data. Shorthand for _from and _to if they are _from _to _sort Default sort is by the announced Options are: announced ex payable record importance The importance level to filter by. Uses Greater Than or Equal To the importance indicated. divend_yield The divend yield amount to filter by. Defaults to using Equal To the amount indicated. 1 = 100% divend_yield_operation Specifies how to filter using divend yield. Defaults to Equal To. Takes gt, gte, eq, lte, lt as options, which perform Greater Than, Greater Than or Equal To, Equal To, Less Than or Equal To, and Less Than filters respectively. api/v2/calendar/ratings Ratings Calendar Data

3 Options size The number of results returned. Default 50. Limit The to query for calendar data. Shorthand for _from and _to if they are _from _to tickers Optional. Multiple ticker may be separated by a comma importance The importance level to filter by. Uses Greater Than or Equal To the importance indicated. action The type of action to match. Actions include (and may change): Upgrades Maintains Initiates Coverage on Lowers Raises Downgrades Terminates Coverage on api/v2/calendar/earnings Earnings Calendar Data

4 Options size The number of results returned. Default 50. Limit The to query for calendar data. Shorthand for _from and _to if they are _from _to tickers Optional. Multiple ticker may be separated by a comma importance The importance level to filter by. Uses Greater Than or Equal To the importance indicated. eps_surprise_percent The eps surprise percent to filter by. Give in the form of a number ( 34.6% =>34.6). Uses Greater Than or Equal To the surprise percent indicated. revenue_surprise_percent The revenue surprise percent to filter by. Give in the form of a number ( 34.6% =>34.6). Uses Greater Than or Equal To the surprise percent indicated. api/v2/calendar/economics Economics Calendar Data Options size

5 The number of results returned. Default 50. Limit The to query for calendar data. Shorthand for _from and _to if they are _from _to country The country code to filter by. Multiple countries may be separate by a,. To get Non USA data, specify INTERNATIONAL. importance The importance level to filter by. Uses Greater Than or Equal To the importance indicated. api/v2/calendar/economics latest by event Economics Calendar Data Filtered by the Events Name column. Shows latest 5 items. Options event The event name to filter by country The country code to filter by api/v2/calendar/guance Guance Calendar Data

6 Options size The number of results returned. Default 50. Limit The to query for calendar data. Shorthand for _from and _to if they are _from _to tickers Optional. Multiple ticker may be separated by a comma importance The importance level to filter by. Uses Greater Than or Equal To the importance indicated. api/v2/calendar/ipos IPO Calendar Data Options size The number of results returned. Default 50. Limit 1000.

7 The to query for calendar data. Shorthand for _from and _to if they are _from _to Data Definitions DIVIDENDS (type: divends) // Last stamp, UTC // Announced Date on Calendar, YYYY MM DD // Announced Time on Calendar, 24hr format ticker // Ticker Symbol (F, MSFT, etc...) exchange // Exchange (NYSE, NASDAQ, etc...) frequency // Frequency of the divend divend // Divend value divend_prior // Period prior divend value divend_type // Type of divend divend_yield // Yield of divend ex_divend_ // Divend Ex Date payable_ // Divend Payable Date record_ // Divend Recorded Date importance // 0 5 Subjective Basis of How Important Event is to Market EARNINGS (type: earnings) // Last stamp, UTC

8 _confirmed ticker exchange name period period_year eps eps_est eps_prior revenue revenue_est importance // Date on Calendar, YYYY MM DD // Time on Calendar, 24hr format // If the earnings release has been confirmed. 1=Yes, 0=No // Ticker Symbol (F, MSFT, etc...) // Exchange (NYSE, NASDAQ, etc...) // Name of Company // Period (Q1,Q2...) // Period Year // Adjusted EPS // Adjusted EPS Consensus Analyst Estimate // Adjusted EPS from Prior Period // Revenue // Revenue Consensus Analyst Estimate // 0 5 Subjective Basis of How Important Event is to Market ECONOMICS (type: economics) // Last stamp, UTC // Date on Calendar, YYYY MM DD // Time on Calendar, 24hr format stamp // Unix stamp country // Country Code (US, CA, etc...) event_name // Economic Event event_period // Period of Time (Q1, September, Third Week of August,...) period_year // Period Year actual // Actual Data Point consensus // Consensus Estimate prior // Data Point for Prior Period importance // 0 5 Subjective Basis of How Important Event is to Market description // Event Description GUIDANCE (type: guance) // Last stamp, UTC // Date on Calendar, YYYY MM DD // Time on Calendar, 24hr format ticker // Ticker Symbol (F, MSFT, etc...) exchange // Exchange (NYSE, NASDAQ, etc...) name // Company Name

9 period period_year eps eps_est eps_prior revenue revenue_est revenue_prior importance // Period (Q1, Q2, FY12, FY13..) // Period Year // Adjusted EPS Guance // Adjusted EPS Consensus Estimate // Prior Period EPS // Revenue Guance // Consensus Revenue Estimate // Prior Revenue // 0 5 Subjective Basis of How Important Event is to Market IPO (type: ipos) // Last stamp, UTC // Date of the IPO, YYYY MM DD // Initial Time of the IPO, 24hr format ticker // Ticker Symbol (F, MSFT, etc...) exchange // Exchange (NYSE, NASDAQ, etc...) name // Company Name estimate_range // Range of Pricing initial_pricing // Initial Pricing initial_shares // Initial Shares open_ // IPO actual open opened_at // IPO open price underwriters // Underwriters url // URL with additional information RATINGS (type: ratings) // Last stamp, UTC // Date on Calendar, YYYY MM DD // Time on Calendar, 24hr format ticker // Ticker Symbol (F, MSFT, etc...) exchange // Exchange (NYSE, NASDAQ, etc...) name // Company Name analyst // Analyst Firm action_pt // Action on Price Target (Raises, Lowers) action_company // Action on Company (Upgrades, Downgrades...) ptpo // PTPO rating_prior // Prior Rating

10 pt_prior rating_current pt_current importance // Prior Price Target // Current Rating // Current Price Target // 0 5 Subjective Basis of How Important Event is to Market