sec-edgar-ws - documentation

[aitrailblazer]

scan the sec-edgar-ws project and write documentation in the README.md

cover all endpoints
Route("/", root), # Root endpoint
Route("/cik/{ticker}", get_cik), # Fetch the CIK (Central Index Key) for a ticker
Route("/filings/{ticker}", get_filings), # Fetch all filings for a ticker
Route("/filing/html/{ticker}/{form_type}", download_latest_filing_html, methods=["GET"]), # Fetch the latest filing of a specified form type as raw HTML
Route("/filing/pdf/{ticker}/{form_type}", download_latest_filing_pdf, methods=["GET"]), Route("/forms/{ticker}", get_available_forms, methods=["GET"]),
Route("/10k/pdf/{ticker}", download_latest_10k), # Fetch the latest 10-K as a PDF
Route("/10k/html/{ticker}", download_latest_10k_html), # Fetch the latest 10-K as raw HTML
Route("/xbrl/{ticker}", get_xbrl_data), # Fetch XBRL data as JSON
Route("/xbrl/concepts/{ticker}", list_xbrl_concepts, methods=["GET"]),
Route("/xbrl/plot/{ticker}", plot_xbrl_data), # Plot XBRL data

and their functionality