api-bricks-sec-api-rest 1.0.2

SDKs for API BRICKS SEC API

API Bricks SEC API REST

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

The api_bricks_sec_api_rest package is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 1.0.2
• Generator version: 7.13.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.finfeedapi.com

Requirements.

Python 3.9+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

• urllib3 >= 2.1.0, < 3.0.0
• python-dateutil >= 2.8.2
• pydantic >= 2
• typing-extensions >= 4.7.1

Getting Started

In your own code, to use this library to connect and interact with API Bricks SEC API REST, you can run the following:

import api_bricks_sec_api_rest
from api_bricks_sec_api_rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api-historical.sec.finfeedapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = api_bricks_sec_api_rest.Configuration(
    host = "https://api-historical.sec.finfeedapi.com"
)



# Enter a context with an instance of the API client
with api_bricks_sec_api_rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = api_bricks_sec_api_rest.ContentExtractionApi(api_client)
    accession_number = 'accession_number_example' # str | The SEC filing accession number used to retrieve the filing from EDGAR database.
    type = api_bricks_sec_api_rest.DTOExtractorType() # DTOExtractorType | Result type (text or html, default: text) (optional)

    try:
        # Extract and classify SEC filing content
        api_response = api_instance.v1_extractor_get(accession_number, type=type)
        print("The response of ContentExtractionApi->v1_extractor_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentExtractionApi->v1_extractor_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api-historical.sec.finfeedapi.com

Class	Method	HTTP request	Description
ContentExtractionApi	v1_extractor_get	GET /v1/extractor	Extract and classify SEC filing content
ContentExtractionApi	v1_extractor_item_get	GET /v1/extractor/item	Extract specific item content from SEC filing
FilingMetadataApi	v1_filings_get	GET /v1/filings	Query SEC filing metadata
FullTextSearchApi	v1_full_text_get	GET /v1/full-text	Full-text search of SEC filing documents
XBRLConversionApi	v1_xbrl_converter_get	GET /v1/xbrl-converter	Convert XBRL data to JSON format

Documentation For Models

• DTOExtractorType
• DTOFilingMetadataDto
• DTOFilingSortBy
• DTOSecFilingResultDto
• MvcProblemDetails
• MvcValidationProblemDetails

Documentation For Authorization

Authentication schemes defined for the API:

APIKey

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Bearer

• Type: Bearer authentication (JWT)

Author

[e-mail]