Skip to main content

finra-py: An Unofficial FINRA API Client

https://github.com/hawkberry/finra-py/actions/workflows/run-tests.yml/badge.svg https://codecov.io/gh/hawkberry/finra-py/branch/main/graph/badge.svg https://app.readthedocs.org/projects/finra-py/badge/?version=latest https://badge.fury.io/py/finra-py.svg https://img.shields.io/pypi/pyversions/finra-py.svg https://img.shields.io/pypi/l/finra-py.svg https://img.shields.io/badge/open%20source-support-blue

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 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)

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

For 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.

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, and provides flexible options for loading and storing tokens, including support for custom token storage.

  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 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.

  3. All API Endpoints: The finra-py library 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.

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 FINRA’s available 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.

Security

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, release provenance, SBOMs, and supported releases.

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, regulatory filing and compliance workflows, and market data systems.

See the consulting page for more information.

Metadata

Release files for finra-py 1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for finra-py 1.3.1
File Size Uploaded Provenance Actions
finra_py-1.3.1.tar.gz 113.1 kB With provenance Details for finra_py-1.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for finra-py 1.3.1
File Interpreter ABI Platform Actions
finra_py-1.3.1-py3-none-any.whl Python 3 none any Details for finra_py-1.3.1-py3-none-any.whl

Total release size: 203.7 kB

Release files / finra_py-1.3.1.tar.gz

Download URL finra_py-1.3.1.tar.gz
Size 113.1 kB
Tags Source
SHA-256 checksum
How to use checksums
47e9070bcdbe745d950fbe80d20d8e18bcf4319454f062b3546d1f9292a43323
BLAKE2b-256 checksum
How to use checksums
8f6c23d7d19665639d2caae9c6828bb226085ad981c6cf294e581f7dae42c27f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / finra_py-1.3.1-py3-none-any.whl

Download URL finra_py-1.3.1-py3-none-any.whl
Size 90.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a1532f8a3e17d3b2c68bf3b654620abc52c85bbf4a88dd5ffe211f5140a7ba52
BLAKE2b-256 checksum
How to use checksums
7f005102a69a0c084bf2e15050163cdacf07d33c15bf658f77c5a1fb00093910
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for finra-py 1.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for finra_py-1.3.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page