About this project
finra-py is an unofficial, open-source Python client library that wraps the FINRA API Platform. It presents itself as a deliberately thin layer: requests are mapped onto the FINRA API and the raw httpx.Response objects are handed back to the caller, so no proprietary response or data model is imposed. The stated goal is to offer the convenience of a dedicated FINRA client without giving up the control of direct HTTP requests.
Authentication is the main thing the library takes off the user's hands. The FINRA API uses OAuth 2.0, and finra-py manages token acquisition and lifecycle, including customizable token storage for applications that keep credentials in their own systems.
The README lists coverage of three API areas:
- Query API datasets, including Equity, Fixed Income, FINRA, Firm, Registration and TRACE Report Card.
- Notification API datasets for FINRA notification events.
- Submission API workflows for regulatory filings and other data, covering creation, validation, submission, updates and retrieval for Form U4, Form U5, Form BR, Create Individual, Non-Registered Fingerprint and other supported flows.
Additional documented capabilities include support for all credential types, Mock datasets, the QA Test Environment API, asynchronous requests on the server side, and asyncio on the client side.
Installation requires Python 3.11 or later and is done with `python -m pip install finra-py`; the package is imported as `import finra`. Full documentation is hosted separately, with a Getting Started guide, ADR notes and a changelog linked from the README.
Limitations are stated plainly: although the library aims at full coverage of documented datasets, some FINRA datasets and services may not be exposed through the API at all, and the fileX API is explicitly not supported at this time.
Development is handled through GitHub issues, with bug reports and feature requests welcomed, though pull requests are not currently accepted. The author also advertises consulting services around FINRA API integrations, Web EFT migrations, compliance-related workflows and market data systems. The project ships with CI and coverage badges and describes test coverage across Windows, macOS and Linux.
The README carries a disclaimer that the library is unofficial and not endorsed by, affiliated with or sponsored by FINRA, that it provides no financial advice or trading strategies, and that users are responsible for complying with the underlying API's terms of service. It is distributed under a LICENSE file without warranty.
For directory purposes this is best placed under developer-tools as a backend/API client library, with data-integration as a secondary fit since its practical use is pulling regulatory and market datasets into other systems.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.