xbrlNetwork: Network

In bergant/xbrlus: Interface to XBRL US API

Description

Gets the relationships in a network by passing the extended link role, an element name and the filing number/CIK.

Usage

xbrlNetwork(Element, Linkbase = NULL, AccessionID = NULL,
  Accession = NULL, CIK = NULL, as_data_frame = TRUE)

Arguments

Element	The element name in the base taxonomy. This parameter will not take a comma separated list.
Linkbase	The type of network relationship. This could be a Presentation, Calculation or Definition. If this is not entered then all will be returned.
AccessionID	Internal Accession identifier used by the XBRL US database.
Accession	Filing accession number. This is the accession number used as the filing identifier used by the SEC.
CIK	CIK of the Company. This must be 10 digits in length. This parameter allows a comma separated list.
as_data_frame	Return value in a data frame (default)

Details

This API allows the user to fetch details about a report (Group/Network/Extended link role) in an XBRL filing that an element appears in such as the balance sheet or income statement. This could return multiple results as Assets for example could be in multiple locations in a filing. The user passes an element and filing number/CIK and the report url will be returned. The API allows the user to specify the different linkbases associated with a report. For example a user can request the calculation network for those reports that contain Assets for company ABC.

All calls to the API must include the Element parameter name and at least an AccessionID or an Accession number or a CIK parameter.

References

https://github.com/xbrlus/data_analysis_toolkit/blob/master/api/xbrlNetwork.md

Examples

## Not run: 
  xbrlNetwork(Element = "Assets", AccessionID = 120617, Linkbase = "Calculation")

## End(Not run)

bergant/xbrlus documentation built on May 12, 2019, 3:06 p.m.