BenzingaBenzinga.com Calendar API v2

BenzingaBenzinga.com  Calendar API v2  Abstract  This document provides an outline to the Benzinga.com API access to Calendar Data.  Connection    Co...
Author: Julie Miller
5 downloads 1 Views 216KB Size
BenzingaBenzinga.com  Calendar API v2  Abstract  This document provides an outline to the Benzinga.com API access to Calendar Data. 

Connection    Connect using the following URL structure:    http://api.benzinga.com/api/v2/calendar/​ ?    Authentication Parameters    [token] =  // unique api­key given to partner 

Data  Data will be provided 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:   http://api.benzinga.com/api/v2/calendar?parameters[date]=2013­10­25¶meters[tickers]=F&token=K EY    api/v2/calendar/conference  Conference Call Calendar Data    Options  ● token  Client API Key 

● ● ●

pagesize  The number of results returned.  Default 50.  Limit 1000.  page  The page offset.  Default 0.  parameters  Optional.  Passed as an array/struct.  ○ date  Format: 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  Format: YYYY­MM­DD  Date to query from point in time  ○ date_to  Date to query to point in time  Format: YYYY­MM­DD  ○ updated  The records last Updated timestamp (UTC).  This will force the sort order to be Greater  Than or Equal to the timestamp indicated. 

    api/v2/calendar/dividends  Dividend Calendar Data    Options  ● token  Client API Key  ● pagesize  The number of results returned.  Default 50.  Limit 1000.  ● page  The page offset.  Default 0.  ● parameters  Optional.  Passed as an array/struct.  ○ date  Format: 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  Format: YYYY­MM­DD  Date to query from point in time  ○ date_to 











Date to query to point in time  Format: YYYY­MM­DD  updated  The records last Updated Unix timestamp (UTC).  This will force the sort order to be  Greater Than or Equal to the timestamp indicated.  date_sort  Default date sort is by the announced date  Options are:   announced  ex  payable  record  importance  The importance level to filter by.  Uses Greater Than or Equal To the importance  indicated.  dividend_yield  The dividend yield amount to filter by. Defaults to using Equal To the amount indicated.  1 = 100%  dividend_yield_operation  Specifies how to filter using dividend 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    Options  ● token  Client API Key  ● pagesize  The number of results returned.  Default 50.  Limit 1000.  ● page  The page offset.  Default 0.  ● parameters  Optional.  Passed as an array/struct.  ○ date  Format: 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  Format: YYYY­MM­DD 











Date to query from point in time  date_to  Date to query to point in time  Format: YYYY­MM­DD  updated  The records last Updated timestamp (UTC).  This will force the sort order to be Greater  Than or Equal to the timestamp indicated.  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    Options  ● token  Client API Key  ● pagesize  The number of results returned.  Default 50.  Limit 1000.  ● page  The page offset.  Default 0.  ● parameters  Optional.  Passed as an array/struct.  ○ date  Format: 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  Format: YYYY­MM­DD 













Date to query from point in time  date_to  Date to query to point in time  Format: YYYY­MM­DD  updated  The records last Updated timestamp (UTC).  This will force the sort order to be Greater  Than or Equal to the timestamp indicated.  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  ● token  Client API Key  ● pagesize  The number of results returned.  Default 50.  Limit 1000.  ● page  The page offset.  Default 0.  ● parameters  Optional.  Passed as an array/struct.  ○ date  Format: 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  Format: YYYY­MM­DD  Date to query from point in time  ○ date_to  Date to query to point in time  Format: YYYY­MM­DD 







updated  The records last Updated timestamp (UTC).  This will force the sort order to be Greater  Than or Equal to the timestamp indicated.  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  ● token  Client API Key  ● page  The page offset.  Default 0.  ● event  The event name to filter by  ● country  The country code to filter by    api/v2/calendar/guidance  Guidance Calendar Data    Options  ● token  Client API Key  ● pagesize  The number of results returned.  Default 50.  Limit 1000.  ● page  The page offset.  Default 0.  ● parameters  Optional.  Passed as an array/struct.  ○ date  Format: 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 









Format: YYYY­MM­DD  Date to query from point in time  date_to  Date to query to point in time  Format: YYYY­MM­DD  updated  The records last Updated timestamp (UTC).  This will force the sort order to be Greater  Than or Equal to the timestamp indicated.  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  ● token  Client API Key  ● pagesize  The number of results returned.  Default 50.  Limit 1000.  ● page  The page offset.  Default 0.  ● parameters  Optional.  Passed as an array/struct.  ○ date  Format: 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  Format: YYYY­MM­DD  Date to query from point in time  ○ date_to  Date to query to point in time  Format: YYYY­MM­DD  ○ updated  The records last Updated timestamp (UTC).  This will force the sort order to be Greater  Than or Equal to the timestamp indicated.   

Data Definitions    Conference Calls (type: conference)    id // ID of  updated // Last updated timestamp, UTC  date // Announced Date on Calendar, YYYY­MM­DD  time // Announced Time on Calendar, 24hr format  ticker // Ticker Symbol (F, MSFT, etc...)  exchange // Exchange (NYSE, NASDAQ, etc...)  start_time // Start Time of the call. Time is in EST.  phone_num // Primary / US Phone number for call  international_num // International (outside US) phone number to call in  reservation_num // The reservation number for the call if needed  access_code // Access code to access the conference call  webcast_url // The url to access to the webcast of the conference call  importance // 0 ­ 5 Subjective Basis of How Important Event is to Market    DIVIDENDS (type: dividends)    id // ID of  updated // Last updated timestamp, UTC  active // 1 = active item / 0 = delete or hide item (with field missing, assume 1)  date // Announced Date on Calendar, YYYY­MM­DD  time // Announced Time on Calendar, 24hr format  ticker // Ticker Symbol (F, MSFT, etc...)  exchange // Exchange (NYSE, NASDAQ, etc...)  frequency // Frequency of the dividend  dividend // Dividend value  dividend_prior // Period prior dividend value  dividend_type // Type of dividend  dividend_yield // Yield of dividend  ex_dividend_date // Dividend Ex Date  payable_date // Dividend Payable Date  record_date // Dividend Recorded Date  importance // 0 ­ 5 Subjective Basis of How Important Event is to Market    EARNINGS (type: earnings)    id // ID of  updated // Last updated timestamp, UTC 

active // 1 = active item / 0 = delete or hide item (with field missing, assume 1)  date // Date on Calendar, YYYY­MM­DD  time // Time on Calendar, 24hr format  date_confirmed // If the earnings release date has been confirmed.  1=Yes, 0=No  ticker // Ticker Symbol (F, MSFT, etc...)  exchange // Exchange (NYSE, NASDAQ, etc...)  name // Name of Company  period // Period (Q1,Q2...)  period_year // Period Year  eps // Adjusted EPS  eps_est // Adjusted EPS Consensus Analyst Estimate  eps_prior // Adjusted EPS from Prior Period  revenue // Revenue  revenue_est // Revenue Consensus Analyst Estimate  importance // 0 ­ 5 Subjective Basis of How Important Event is to Market    ECONOMICS (type: economics)    id // ID of  updated // Last updated timestamp, UTC  active // 1 = active item / 0 = delete or hide item (with field missing, assume 1)  date // Date on Calendar, YYYY­MM­DD  time // Time on Calendar, 24hr format  timestamp // Unix timestamp  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: guidance)    id // ID of  updated // Last updated timestamp, UTC  active // 1 = active item / 0 = delete or hide item (with field missing, assume 1)  date // Date on Calendar, YYYY­MM­DD  time // Time on Calendar, 24hr format  ticker // Ticker Symbol (F, MSFT, etc...)  exchange // Exchange (NYSE, NASDAQ, etc...) 

name // Company Name  period // Period (Q1, Q2, FY12, FY13..)  period_year // Period Year  eps // Adjusted EPS Guidance  eps_est // Adjusted EPS Consensus Estimate  eps_prior // Prior Period EPS  revenue // Revenue Guidance  revenue_est // Consensus Revenue Estimate  revenue_prior // Prior Revenue  importance // 0 ­ 5 Subjective Basis of How Important Event is to Market    IPO (type: ipos)    id // ID of  updated // Last updated timestamp, UTC  active // 1 = active item / 0 = delete or hide item  date // Date of the IPO, YYYY­MM­DD  time // Initial Time of the IPO, 24hr format  ticker // Ticker Symbol (F, MSFT, etc...)  exchange // Exchange (NYSE, NASDAQ, etc...)  name // Company Name  price_min // Minimum Open Price  price_max // Maximum Open Price  pricing_date // Date of IPO Pricing (YYYY­MM­DD)  deal_status // Deal Status  insider_lockup_days // Insider lockup period in days  insider_lockup_date // Insider lockup date (YYYY­MM­DD)  offering_value // Offer value  offering_shares // Offer Shares  shares_outstanding // Shares Outstanding  shares_from_selling_holders // Shares Offer by Holders  lead_underwriters // Array ­ Lead Underwriter(s)  other_underwriters // Array ­ Other/Secondary Underwriter(s)  underwriter_quiet_expiration_days // Underwriter quiet expiration period in days  underwriter_quiet_expiration_date // Underwriter quiet expiration date (YYYY­MM­DD)    RATINGS (type: ratings)    id // ID of  updated // Last updated timestamp, UTC  active // 1 = active item / 0 = delete or hide item (with field missing, assume 1)  date // Date on Calendar, YYYY­MM­DD  time // 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  pt_prior // Prior Price Target  rating_current // Current Rating  pt_current // Current Price Target  importance // 0 ­ 5 Subjective Basis of How Important Event is to Market    SPLITS (type: splits)    id // ID of  updated // Last updated timestamp, UTC  ticker // Ticker Symbol (F, MSFT, etc...)  exchange // Exchange (NYSE, NASDAQ, etc...)  ratio // Ratio of the split  optionable // Is the split optionable  date_ex // Ex Date, YYYY­MM­DD  date_announced // Announced Date, YYYY­MM­DD  date_recorded // Recorded Date, YYYY­MM­DD  date_distribution // Distribution Date, YYYY­MM­DD  importance // 0 ­ 5 Subjective Basis of How Important Event is to Market