finra-py 1.1.0

What is finra-py?

finra-py is an unofficial, open-source Python client library for the FINRA API Platform. It is designed to be a lightweight, unopinionated interface that supports every endpoint and dataset.

Notable functionality includes:

• Authentication and client creation

• Equity, Fixed Income, FINRA, Firm, Registration and TRACE Report Card datasets via the Query API

• Notification event datasets via the Notification API

• Submission of regulatory filings and other data to FINRA via the Submission API

• Support for the Mock API

• Support for the QA Test Environment API

• Support for all credential types

• Support for asynchronous requests (server-side)

• Support for asyncio (client-side)

Quick Start

finra-py requires Python 3.11 or later.

To install the latest stable PyPI package using pip:

python -m pip install finra-py

To install the unstable version from GitHub:

git clone https://github.com/hawkberry/finra-py
cd python finra-py
python -m pip install .

To import the package in Python:

import finra

You can find a full description of the finra-py library’s functionality in the documentation.

For detailed instructions on how to get started with finra-py, see Getting Started.

Why use finra-py?

finra-py focuses on a few key areas:

1. OAuth 2.0 Authentication: The FINRA API uses OAuth 2.0 for authentication and authorization. Implementing the OAuth 2.0 authentication flow yourself can introduce unnecessary complexity and security risks. finra-py handles token acquisition and lifecycle management for you.

2. Direct API Access: finra-py keeps the client layer deliberately thin. It accepts the values expected by the API and returns the responses directly to you, without adding layers of application-specific logic. finra-py enables you to access the FINRA API with ease, without having to build and maintain the HTTP requests yourself.

3. All API Endpoints: The finra-py library is designed to provide thorough coverage of the FINRA API Platform. With this goal in mind, finra-py implements full functionality for every dataset and regulatory filing supported by the FINRA API and described in the documentation.

Limitations

finra-py strives to provide comprehensive coverage of all documented datasets for the FINRA API. However, there are some datasets and services available through FINRA that may not be available through the FINRA API. See FINRA Data for information about all available FINRA datasets.

• finra-py does not currently support FINRA’s fileX API

Help and Development

For troubleshooting guidance and answers to common questions, see the Getting Help page.

Submit bug reports on the finra-py Issues Page on GitHub.

If you need a dataset or feature that is not currently supported by the client, please file a Feature Request. Pull requests are not currently accepted.

FINRA API Consulting

Need help implementing the FINRA API?

As the author and maintainer of finra-py, I provide consulting on FINRA API integrations, Web EFT migrations, compliance-related workflows, and market data systems.

See the consulting page for more information.

Project Links

• Documentation

• Repository

• PyPI

• Changelog

• Consulting

• Support

• Issues

Disclaimer: finra-py is an unofficial, open-source client library for the FINRA API Platform. It is not endorsed by, affiliated with, or sponsored by FINRA or any associated organization. finra-py does not provide financial advice, investment recommendations, trading strategies, or financial analysis. Users are responsible for reviewing and complying with the terms of service and usage requirements of the underlying FINRA API. This software is provided under the terms of the LICENSE without warranty of any kind.