List Extraction Schemas

List document extraction schemas available to the internal document API.

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

When To Use It

Use these tools for curated extraction caches and premium language-model-backed filing evidence.

Request Examples


BASE_URL="${EDGAR_API_URL:-https://www.edgarparser.com}"
 
curl -sS "$BASE_URL/api/documents/schemas" \
  -H "Authorization: Bearer $EDGAR_API_KEY"


import os
import requests
 
base_url = os.getenv("EDGAR_API_URL", "https://www.edgarparser.com")
headers = {"Authorization": f"Bearer {os.environ['EDGAR_API_KEY']}"}
 
response = requests.get(f"{base_url}/api/documents/schemas", headers=headers, 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.
`schemas`	`array<object>`	Extraction result field; inspect provenance and coverage before treating it as disclosed.

Response Fields To Inspect

schema_name, evidence spans, and source filing metadata for every extracted claim.
Coverage or cache-miss fields before treating missing rows as “not disclosed.”
Confidence, provenance, and extraction timestamp fields when comparing periods.

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.
Treat partial coverage, empty arrays, and warning fields as answer-quality signals even when HTTP status is 200.

Extract Filing File, Filing Extractions, Search Extractions

Generated Reference

Contract

Field	Value
Tool	`list_extraction_schemas`
Method	`GET`
Path	`/api/documents/schemas`
Contract version	`1.0.0`
Schema fingerprint	`sha256:e9cdbc5ab2ca2d04dbfae0e6ec79ac6b1306e738777fcb3e666e580191fec171`

Parameters

Name	Location	Required	Type	Notes
none	-	-	-	-

Response Schema (200)


{
  "properties": {
    "coverage_status": {
      "anyOf": [
        {
          "enum": [
            "complete",
            "partial",
            "narrow",
            "none"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "coverage_warning": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "schemas": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "type": "array"
    },
    "semantic_status": {
      "anyOf": [
        {
          "enum": [
            "ok",
            "partial",
            "empty",
            "error"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "const": "success",
      "type": "string"
    }
  },
  "required": [
    "status"
  ],
  "type": "object"
}