Filing Document

Return a readable markdown filing document with section filtering and pagination.

Tier: registered | Cache: cold-allowed | Playground: authenticated only | Contract: 1.0.0

When To Use It

Use these tools to discover filings, inspect filing artifacts, and retrieve source-backed document evidence.

Request Examples


BASE_URL="${EDGAR_API_URL:-https://www.edgarparser.com}"
 
curl -sS -G "$BASE_URL/api/filing/document" \
  -H "Authorization: Bearer $EDGAR_API_KEY" \
  --data-urlencode "accession=0000320193-25-000079" \
  --data-urlencode "sections=Item 7" \
  --data-urlencode "max_chars=20000"


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 = {
  "accession": "0000320193-25-000079",
  "sections": "Item 7",
  "max_chars": 20000
}
 
response = requests.get(f"{base_url}/api/filing/document", headers=headers, params=params, timeout=30)
response.raise_for_status()
data = response.json()

Key Response Fields

Field	Type	Why It Matters
`status`	`const "success"`	Transport-level success indicator inside the JSON response.
`semantic_status`	`"ok" \| "partial" \| "empty" \| "error" \| null`	Whether the response is semantically usable, partial, empty, or errored.
`coverage_status`	`"complete" \| "partial" \| "narrow" \| "none" \| null`	Completeness signal; do not present partial or narrow coverage as complete.
`coverage_warning`	`string \| null`	Human-readable explanation of missing or ambiguous coverage.
`form_type`	`string \| null`	SEC form type; verify it matches the requested filing class.
`markdown`	`string`	Readable filing text returned for downstream summarization or citation.
`truncated`	`boolean`	Indicates the response is incomplete and should be paged.
`next_char_start`	`integer \| null`	Pagination cursor for fetching the next document slice.

Response Fields To Inspect

accession, filing_url, form type, and period fields to confirm the filing identity.
Pagination or truncation fields before assuming the returned text is complete.
Section titles and document names when citing prose back to the filing.

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.
Cold work can take longer and may queue background fetch or parse work; use status fields or follow-up tools before finalizing.
Honor pagination and truncation metadata; request the next page instead of assuming the first response is complete.

Search Filing Text, Filing Sections, Filing Evidence

Generated Reference

Contract

Field	Value
Tool	`get_filing_document`
Method	`GET`
Path	`/api/filing/document`
Contract version	`1.0.0`
Schema fingerprint	`sha256:4d559aded5c9760ccb498944a984a128254a76349348de297da30ee338ff123a`

Parameters

Name	Location	Required	Type
`ticker`	query	no	`string \| null`
`year`	query	no	`integer \| null`
`quarter`	query	no	`integer \| null`
`source`	query	no	`string`
`accession`	query	no	`string \| null`
`cik`	query	no	`string \| null`
`form_type`	query	no	`string \| null`
`primary_document`	query	no	`string \| null`
`sections`	query	no	`string \| null`
`char_start`	query	no	`integer \| null`
`char_end`	query	no	`integer \| null`
`max_chars`	query	no	`integer`

Response Schema (200)


{
  "additionalProperties": true,
  "properties": {
    "char_count_total": {
      "type": "integer"
    },
    "char_end": {
      "type": "integer"
    },
    "char_start": {
      "type": "integer"
    },
    "citation_state": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "coverage_status": {
      "anyOf": [
        {
          "enum": [
            "complete",
            "partial",
            "narrow",
            "none"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "coverage_warning": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "filing": {
      "additionalProperties": true,
      "type": "object"
    },
    "form_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "markdown": {
      "type": "string"
    },
    "next_char_start": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "query": {
      "additionalProperties": true,
      "type": "object"
    },
    "section_offsets": {
      "additionalProperties": {
        "additionalProperties": {
          "type": "integer"
        },
        "type": "object"
      },
      "type": "object"
    },
    "sections_returned": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "semantic_status": {
      "anyOf": [
        {
          "enum": [
            "ok",
            "partial",
            "empty",
            "error"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "const": "success",
      "type": "string"
    },
    "truncated": {
      "type": "boolean"
    }
  },
  "required": [
    "status",
    "query",
    "char_count_total",
    "char_start",
    "char_end",
    "truncated",
    "markdown"
  ],
  "type": "object"
}