API

This is the API module of the XBridge.

Convert XBRL instance to a CSV file

xbridge.api.convert_instance(instance_path: str | Path, output_path: str | Path | None = None, headers_as_datapoints: bool = False) → Path

Convert one single instance of XBRL-XML file to a CSV file

Parameters:

• instance_path – Path to the XBRL-XML instance

• output_path – Path to the output CSV file

• headers_as_datapoints – If True, the headers will be treated as datapoints.

Returns:

Converted CSV file.

Load an XBRL-XML instance file

xbridge.api.load_instance(instance_path: str | Path) → Instance

Load an XBRL XML instance file

Parameters:

instance_path – Path to the instance XBRL file

Returns:

An instance object may be return