finra-py is an unofficial, open-source Python client library for the FINRA API Platform. It provides a lightweight, unopinionated Python interface for the FINRA API while preserving direct access to the API's responses and full functionality for every supported 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, update, and retrieval operations for Form U4, Form U5, Form BR, Create Individual and Non-Registered Fingerprint filings 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)
finra-py requires Python 3.11 or later.
Install the package using pip:
python -m pip install finra-pyImport the package in Python:
import finraFor detailed instructions on how to get started with finra-py, see Getting Started.
You can find a full description of the finra-py library in the documentation.
finra-py is FINRA-specific on the way in, and standard HTTPX on the way out.
- 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-pyhandles token acquisition and lifecycle management for you, and provides flexible options for loading and storing tokens, including support for custom token storage. - Direct API Access:
finra-pykeeps the client layer deliberately thin. It maps requests to the FINRA API and returns the rawhttpx.Responseobjects directly to you, without imposing a custom response format 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. - All API Endpoints: The
finra-pylibrary is designed to provide complete coverage of the FINRA API Platform. It 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 for Windows, macOS, and Linux.
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.
finra-py provides full functionality for the documented datasets supported by the FINRA API, however some datasets and services available from FINRA may not be available through the API. See FINRA Data for information about FINRA's available datasets.
finra-pydoes not currently support FINRA's fileX API
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.
Please report security vulnerabilities privately using GitHub's Private Vulnerability Reporting, rather than as a normal bug report. See the Security Policy for more information.
The policy includes additional security information specific to finra-py, including credential and token handling, sensitive data, diagnostic logging, dependency security, and supported releases.
Need help with a custom integration?
As the author and maintainer of finra-py, I provide consulting on FINRA API integrations, Web EFT migrations, regulatory filing and compliance workflows, and market data systems.
See the consulting page for more information.
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.