Skip to Content
Tool ReferenceText SearchSearch Filing Text

Search Filing Text

Search cached markdown within one filing and return matching spans.

Tier: registered | Cache: cache-only | Playground: authenticated only | Contract: 1.0.0

When To Use It

Use text search when the caller needs prose evidence from filing sections and already knows the filing scope.

Request Examples

BASE_URL="${EDGAR_API_URL:-https://www.edgarparser.com}" curl -sS -G "$BASE_URL/api/filing/text/search" \ -H "Authorization: Bearer $EDGAR_API_KEY" \ --data-urlencode "ticker=AAPL" \ --data-urlencode "year=2025" \ --data-urlencode "quarter=4" \ --data-urlencode "query=revenue recognition"
import os import requests base_url = os.getenv("EDGAR_API_URL", "https://www.edgarparser.com") headers = {"Authorization": f"Bearer {os.environ['EDGAR_API_KEY']}"} params = { "ticker": "AAPL", "year": 2025, "quarter": 4, "query": "revenue recognition" } response = requests.get(f"{base_url}/api/filing/text/search", headers=headers, params=params, timeout=30) response.raise_for_status() data = response.json()

Response Fields To Inspect

  • Matched section, accession, and snippet text before quoting or summarizing.
  • Pagination fields when the search result set is longer than one page.
  • The original filing context when a phrase appears in multiple sections.

Errors And Coverage

  • 401 or 403: the API key is missing, expired, or not allowed to use this tier.
  • 429: retry after the rate-limit window, and prefer broader batch or series tools over repeated single-period calls.
  • This tool is cache-only; if the target filing is not warm, warm it through an allowed paid path before retrying.
  • Honor pagination and truncation metadata; request the next page instead of assuming the first response is complete.

Filing Document, Filing Evidence, Filing Sections

Generated Reference

Contract

FieldValue
Toolsearch_filing_text
MethodGET
Path/api/filing/text/search
Contract version1.0.0
Schema fingerprintsha256:be08198a156e55118e9b32a0fb41ead07906469059fb27d3010f1a1f5a9c0c8c

Parameters

NameLocationRequiredTypeNotes
tickerqueryyesstring
yearqueryyesinteger
quarterqueryyesinteger
sourcequerynostring
queryqueryyesstring

Response Schema (200)

{}