jadchaar/sec-edgar-downloader

jadchaar/sec-edgar-downloader是从Python库移植过来的

dev-main 2023-08-19 21:41 UTC

This package is auto-updated.

Last update: 2024-09-20 00:33:41 UTC


README

从Python移植。原始仓库:[https://github.com/jadchaar/sec-edgar-downloader/blob/master/sec_edgar_downloader]

安装

要将此库添加到您的composer.json文件中,您可以在项目目录中运行以下命令

composer require jadchaar/sec_edgar_downloader

注意,您的composer文件需要允许开发级别的稳定性才能使用。

示例用法

 use Jadchaar\SecEdgarDownloader\Downloader;
 $filepath = 'sec-documents/';
 $downloader = new Downloader($filepath);
 $filing = '10-K';
 $ticker_or_cik = 'AAPL';
 $amount = 10;
 $before_date = '2023-08-19';
 $after_date = '2021-01-01';
 $include_amends = true;
 $download_details = true;
 $query = '';
 $user_agent = 'Company Name employee@company.com';
 
 $num_filings = $downloader->get(
     $filing,
     $ticker_or_cik,
     $amount,
     $before_date,
     $after_date,
     $include_amends,
     $download_details,
     $query,
     $user_agent
 );
 
 echo "Number of unique filings downloaded: " . $num_filings;

待办事项列表

  • 抽象HTTP客户端
  • 使用默认值参数化速率限制
  • 允许下载不同类型的文件
  • 除了本地文件系统外,还可以启用不同文件类型的路径