finra-py 1.2.0

What is finra-py?

finra-py is an unofficial, open-source Python client library for the FINRA API Platform. It provides a lightweight, unopinionated Python interface to the FINRA API while preserving direct access to the API’s responses and full functionality for every supported API endpoint and dataset.

The core features include:

• OAuth 2.0 authentication, client creation, token management, and custom token storage

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

• FINRA notification event datasets via the Notification API

• Submission of regulatory filings and other data to FINRA, including creation, validation, submission, updates, and retrieval for Form U4, Form U5, Form BR, Create Individual, Non-Registered Fingerprint, and other supported workflows via the Submission API

• Support for all credential types

• Support for Mock datasets

• Support for the QA Test Environment API

• Support for asynchronous requests (server-side)

• Support for asyncio (client-side)

Installing finra-py

finra-py requires Python 3.11 or later.

Install the package using pip:

python -m pip install finra-py

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 is FINRA-specific on the way in, and standard HTTPX on the way out.

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, with customizable token storage for applications that need to manage credentials in their own storage systems.

2. Direct API Access: finra-py keeps the client layer deliberately thin. It maps requests to the FINRA API and returns the raw httpx.Response objects directly to you, without imposing a custom response or data model. You get the convenience of a dedicated FINRA client with all of the API’s features, without giving up the control available through direct HTTP requests.

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. It also provides comprehensive test coverage across Windows, macOS, and Linux.

Limitations

Even though finra-py strives to provide coverage of all documented datasets for the FINRA API, there are some datasets and services available through FINRA that may not be available through their 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 with a custom integration?

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

• Issues

• Changelog

• ADRs

• Consulting

• Support

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.