Sobre o projeto
finra-py é uma biblioteca cliente Python não oficial, de código aberto, que encapsula a plataforma de API da FINRA. Ela se apresenta como uma camada deliberadamente fina: as solicitações são mapeadas para a API da FINRA e os objetos de resposta bruta httpx.Response são devolvidos ao chamador, de modo que nenhum modelo de resposta ou dado proprietário é imposto. O objetivo declarado é oferecer a conveniência de um cliente dedicado da FINRA sem abrir mão do controle das requisições HTTP diretas.
A autenticação é o principal aspecto que a biblioteca tira das mãos do usuário. A API da FINRA utiliza OAuth 2.0, e o finra-py gerencia a aquisição e o ciclo de vida do token, incluindo armazenamento de token personalizável para aplicações que mantêm credenciais em seus próprios sistemas.
O README lista a cobertura de três áreas de API:
- Conjuntos de dados da API Query, incluindo Equity, Fixed Income, FINRA, Firm, Registration e TRACE Report Card.
- Conjuntos de dados da API Notification para eventos de notificação da FINRA.
- Fluxos de trabalho da API Submission para arquivamentos regulatórios e outros dados, abrangendo criação, validação, submissão, atualizações e recuperação para Form U4, Form U5, Form BR, Create Individual, Non-Registered Fingerprint e outros fluxos suportados.
Capacidades adicionais documentadas incluem suporte para todos os tipos de credenciais, conjuntos de dados Mock, a API de Ambiente de Teste QA, requisições assíncronas do lado do servidor e asyncio do lado do cliente.
A instalação requer Python 3.11 ou posterior e é feita com `python -m pip install finra-py`; o pacote é importado como `import finra`. A documentação completa está hospedada separadamente, com um guia Getting Started, notas ADR e um changelog vinculados ao README.
As limitações são declaradas claramente: embora a biblioteca vise a cobertura total dos conjuntos de dados documentados, alguns conjuntos de dados e serviços da FINRA podem não estar expostos através da API em nenhum momento, e a API fileX é explicitamente não suportada neste momento.
O desenvolvimento é gerenciado por meio de issues no GitHub, com relatos de bugs e solicitações de recursos bem-vindos, embora pull requests não sejam atualmente aceitos. O autor também anuncia serviços de consultoria relacionados a integrações com a API da FINRA, migrações de Web EFT, fluxos de trabalho relacionados à conformidade e sistemas de dados de mercado. O projeto vem com badges de CI e cobertura e descreve a cobertura de testes em Windows, macOS e Linux.
O README contém um aviso de que a biblioteca é não oficial e não é endossada, afiliada ou patrocinada pela FINRA, que ela não oferece aconselhamento financeiro ou estratégias de negociação, e que os usuários são responsáveis por cumprir os termos de serviço da API subjacente. Ela é distribuída sob um arquivo LICENSE sem garantia.
Para fins de diretório, esta biblioteca se encaixa melhor em developer-tools como uma biblioteca de cliente de backend/API, com data-integration como um ajuste secundário, já que seu uso prático é puxar conjuntos de dados regulatórios e de mercado para outros sistemas.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.