Об этом проекте
finra-py — неофициальная open-source библиотека Python, оборачивающая FINRA API Platform. Она представляет собой намеренно тонкий слой: запросы отображаются на FINRA API, а raw-объекты httpx.Response возвращаются вызывающему коду, поэтому не навязывается проприетарная модель ответов или данных. Заявленная цель — предложить удобство специализированного клиента FINRA, не отказываясь от контроля прямых HTTP-запросов.
Аутентификация — главное, что библиотека берёт на себя. FINRA API использует OAuth 2.0, и finra-py управляет получением токенов и их жизненным циклом, включая настраиваемое хранение токенов для приложений, хранящих учётные данные в собственных системах.
В README указан охват трёх направлений API:
— Query API датасеты, включая Equity, Fixed Income, FINRA, Firm, Registration и TRACE Report Card.
— Notification API датасеты для событий уведомлений FINRA.
— Submission API workflows для регуляторных заявок и иных данных, охватывающие создание, валидацию, отправку, обновление и извлечение для Form U4, Form U5, Form BR, Create Individual, Non-Registered Fingerprint и других поддерживаемых потоков.
Дополнительно задокументированы: поддержка всех типов учётных данных, Mock-датасеты, QA Test Environment API, асинхронные запросы на стороне сервера и asyncio на стороне клиента.
Установка требует Python 3.11 или новее и выполняется командой python -m pip install finra-py; пакет импортируется как import finra. Полная документация размещается отдельно, при этом в README доступны ссылки на руководство Getting Started, ADR-заметки и changelog.
Ограничения указаны явно: хотя библиотека нацелена на полный охват задокументированных датасетов, некоторые датасеты и сервисы FINRA могут вообще отсутствовать в API, а fileX API на данный момент явно не поддерживается.
Разработка ведётся через GitHub issues; приветствуются отчёты об ошибках и запросы функций, однако pull requests в настоящее время не принимаются. Автор также предлагает консалтинговые услуги по интеграциям с FINRA API, миграциям Web EFT, workflow, связанным с compliance, и системам рыночных данных. Проект включает CI и badges покрытия, описание тестирования охватывает Windows, macOS и Linux.
В README присутствует дисклеймер о том, что библиотека является неофициальной и не одобряется, не аффилирована и не спонсорируется FINRA; она не предоставляет финансовых рекомендаций или торговых стратегий, а пользователи несут ответственность за соблюдение условий использования базового API. Распространяется согласно LICENSE без каких-либо гарантий.
Для каталогизации проект наилучшим образом подходит в раздел developer-tools как backend/API client library, с data-integration как вторичной категорией, поскольку его практическое применение заключается в извлечении регуляторных и рыночных датасетов для других систем.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.