Search Within a Filing's Markdown
Access Level Required: Requires Processed Filings (Level 2) access to search converted content.
Find text inside one filing's processed Markdown without downloading all of it. Case-insensitive substring match; hits come back in document order, each with ~440 characters of context and its character offset. Pass that offset (minus a margin) to GET /filings/{id}/markdown/?offset=&limit= to read the surrounding section. total_hits counts every match, so you can tell when max_hits was spent on the table of contents. Billed as one Markdown request.
Request
- Base URL: https://api.financialreports.eu
- URL: https://api.financialreports.eu/filings/{id}/markdown/search/
- Auth: one of:
- API key in header X-API-Key
- HTTP bearer
Path parameters
A unique integer value identifying this filing.
Query parameters
Hits to return, 1-50 (default 10).
Text to find (1-200 characters).
Response
Matches with their character offsets.
Changes
No recorded changes to this operation across all 2 revisions of this API.