R API client for calcbenchR

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

• API version: v1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RClientCodegen

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")

Build the package

git clone https://github.com/luceydav/calcbenchR
cd GIT_REPO_ID
R CMD build .
R CMD check calcbenchR_1.0.0.tar.gz --no-manual
R CMD INSTALL --preclean calcbenchR_1.0.0.tar.gz

Install the package

install.packages("calcbenchR")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("luceydav/calcbenchR")

To install the package from a local file:

install.packages("calcbenchR_1.0.0.tar.gz", repos = NULL, type = "source")

Usage

library(calcbenchR)

Reformat code

To reformat code using styler, please run the following in the R console:

install.packages("remotes")
remotes::install_github("r-lib/styler@v1.7.0.9003")
library("styler")
style_dir()

Documentation for API Endpoints

All URIs are relative to https://calcbench.com

Class	Method	HTTP request	Description
AvailableMetricsApi	AvailableMetricsGetValues	GET /api/availablemetrics
BusinessCombinationsApi	BusinessCombinationsBusinessCombinations	POST /api/businessCombinations	The data behind the business combinations page, https://www.calcbench.com/businesscombinations
CompaniesApi	CompaniesAvailableCompanies	POST /api/companies
DimensionalDataApi	DimensionalDataDimensionalData	POST /api/dimensionalData	The data behind https://www.calcbench.com/segments
DisclosureApi	DisclosureFootnoteSearch	POST /api/footnoteSearch	Document Search
FaceStatementsApi	FaceStatementsGetStatementExteneral	GET /api/faceStatement	As-reported face statments, income, balance, statement of cash flows, etc...
FaceStatementsApi	FaceStatementsGetStatements	GET /api/faceStatements	Gets the list of statements for one company/period
FilingsApi	FilingsFilingsV2	POST /api/filingsV2
RawDataApi	RawDataRaw13FData	POST /api/raw13FData	13F data
RawDataApi	RawDataRawNonXBRLData	POST /api/rawNonXBRLData	Non-XBRL Data As-Reported
RawDataApi	RawDataRawXBRLData	POST /api/rawXBRLData	XBRL data As-Reported
RawXBRLApi	RawXBRLXBRLTagValues	POST /api/XBRLTagValuesV2	Get data for individual tags on the multi-company page.
StandardizedDataApi	StandardizedDataMappedData	POST /api/mappedData

Documentation for Models

• APIXBRLCompany
• APIXBRLStatement
• BusinessCombinationsParameters
• CompaniesParameters
• CompanySearchParameters
• DateRange
• DimensionalDataPoint
• DimensionalQueryParameters
• DimensionalSearchParameters
• DisclosureSubSection
• FaceStatementColumn
• Filing
• FilingsParameters
• FilingsQueryParameters
• FootnotePeriodParameters
• FootnoteQueryParameters
• FootnoteQueryResponse
• FootnoteSearchParameters
• Form13FQueryPiece
• IntangibleAssetsCategory
• MappedDataPoint
• MappedDataSearchParameters
• MetricGroups
• MetricSearchCriteria
• NONxbrlQueryPiece
• NonXBRLFact
• PeriodParameters
• PurchasePriceAllocation
• Raw13FDataSearchParams
• Raw13FQueryParams
• RawNonXBRLDataSearchParams
• RawNonXBRLQueryParams
• RawXBRLDataSearchParams
• RawXBRLFact
• RawXBRLQueryParams
• StandardizedFootnoteMetricDefinition
• StandardizedMetricDefinition
• StandardizedQueryParameters
• StatementsMetaData
• TextFootnote
• TraceData
• XBRLDisclosure
• XBRLTagQueryParameters
• XBRLTagSearchParameters
• XBRLcompany
• XBRLcontext
• XBRLstatement
• XbrlQueryPiece

Documentation for Authorization

All endpoints do not require authorization.