Package 'restimizeapi'

Title: Functions for Working with the 'www.estimize.com' Web Services
Description: Provides the user with functions to develop their trading strategy, uncover actionable trading ideas, and monitor consensus shifts with crowdsourced earnings and economic estimate data directly from <www.estimize.com>. Further information regarding the web services this package invokes can be found at <www.estimize.com/api>.
Authors: Thomas P. Fuller <[email protected]>
Maintainer: Thomas P. Fuller <[email protected]>
License: LGPL-3
Version: 1.0.0
Built: 2024-10-31 16:33:17 UTC
Source: https://github.com/cran/restimizeapi

Help Index

Function prints some information about this package.

Description

Function prints some information about this package.

Usage

About()

Examples

## Not run: 
     About()
 
## End(Not run)

Returns the company information for all companies that Estimize covers.

Description

Returns the company information for all companies that Estimize covers.

Usage

GetCompanies()

Value

The companies information as a data frame.

Examples

## Not run: 
 result <- GetCompanies ()
 
## End(Not run)

Returns the company information for the company specified by the ticker.

Description

Returns the company information for the company specified by the ticker.

Usage

GetCompany(ticker)

Arguments

ticker

The Estimize ticker – for example "MSFT".

Value

The company information as a data frame.

Examples

## Not run: 
     result <- GetCompany ("msft")
 
## End(Not run)

Returns all estimates for a company specified by the ticker.

Description

Returns all estimates for a company specified by the ticker.

Usage

GetCompanyEstimates(ticker, year = NULL, quarter = NULL)

Arguments

ticker

The Estimize ticker – for example "MSFT".
year

A four-digit year – for example 1999.
quarter

A numeric value between 1 and 4 inclusive. Note that if the quarter is used the year must also be set as well.

Value

The company estimates as a data frame.

Examples

## Not run: 
 result <- GetCompanyEstimates ("MSFT")
 result <- GetCompanyEstimates ("MSFT", 2015)
 result <- GetCompanyEstimates ("MSFT", 2015, 2)
 
## End(Not run)

Returns the past financial releases for the specified company by the ticker, for the specified fiscal year, and quarter.

Description

Returns the past financial releases for the specified company by the ticker, for the specified fiscal year, and quarter.

Usage

GetCompanyReleases(ticker, year = NULL, quarter = NULL)

Arguments

ticker

The Estimize ticker – for example "MSFT".
year

A four-digit year – for example 1999.
quarter

A numeric value between 1 and 4 inclusive; note that if the quarter is used the year must also be set as well.

Value

The company releases as a data frame.

Examples

## Not run: 
 result <- GetCompanyReleases ("MSFT")
 result <- GetCompanyReleases ("MSFT", 2009)
 result <- GetCompanyReleases ("MSFT", 2009, 2)
 
## End(Not run)

Returns all estimates in the specified date-range for all companies.

Description

Returns all estimates in the specified date-range for all companies.

Usage

GetEstimates(startDate, endDate)

Arguments

startDate

The start date, which must be in the format YYYY-MM-DD, for example "2015-01-20"
endDate

The end date, which must be in the format YYYY-MM-DD, for example "2015-02-15"

Value

The estimates as a data frame.

Examples

## Not run: 
     result <- GetEstimates ("2015-01-20", "2015-02-15")
 
## End(Not run)

Returns the current consensus as well as the consensus history of the specified release. The user can obtain the id from results returned from the GetCompanyReleases function.

Description

Returns the current consensus as well as the consensus history of the specified release. The user can obtain the id from results returned from the GetCompanyReleases function.

Usage

GetReleaseConsensus(id)

Arguments

id

The company identifier.

Value

The release consensus as a data frame.

Examples

## Not run: 
 result <- GetReleaseConsensus ("535c963053c804e0d50002a1")
 
## End(Not run)

Functions for Working with the 'www.estimize.com' Web Services

Description

Provides the user with functions to develop their trading strategy, uncover actionable trading ideas, and monitor consensus shifts with crowdsourced earnings and economic estimate data directly from <www.estimize.com>. Further information regarding the web services this package invokes can be found at <www.estimize.com/api>.

Details

Provides a complete implementation of all web methods available at at api.estimize.com – functions available include:

Note that the SetKey function must be called once prior to invoking any of the other functions in this package.

Function sets the key which is required as a header in every web method call to estimize.com – contact [email protected] to obtain a key.

Description

Function sets the key which is required as a header in every web method call to estimize.com – contact [email protected] to obtain a key.

Usage

SetKey(key)

Arguments

key

The API key as provided by Estimize.com.

Examples

## Not run: 
 SetKey ("ENTER YOUR PRIVATE API KEY HERE.")
 
## End(Not run)