Filings

Case-insensitive exact keyword search within one filing or transcript, matching typographic punctuation (curly quotes, dashes) interchangeably with ASCII. Returns matching lines with one line of context each; matchCount is the returned-row count and totalMatchingLines the document-wide total.

get/v1/filings/{documentId}/keyword-search

Request

Base URL
https://api.equibles.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/equibles/apis/equibles-api/docs/v1/filings/:documentId/keyword-search/get.ts
A function with typed inputs. Its response is checked against the schema.

documentIdstring uuid required

Document id from the filings list.

keywordstring

Keyword or phrase to search for (required).

limitinteger

Maximum matches to return (default 20, max 500).

documentIdstring uuid

tickerstring nullable

companyNamestring nullable

documentTypestring nullable

documentTypeNamestring nullable

filedDatestring date

keywordstring nullable

matchCountinteger

Matching lines returned in THIS response (the length of data, bounded by limit) — not the document-wide total; see totalMatchingLines for that.

totalMatchingLinesinteger

Total lines in the document containing the keyword, before the limit truncation.

hasMoreboolean

True when more matching lines exist than were returned — raise limit (max 500) to retrieve them.

totalLinesinteger

Total text lines in the document.

No recorded changes to this operation across all 1 revision of this API.