Tag Equivalence Registry

Return registry-backed XBRL tag equivalence groups for client taxonomy alignment.

When To Use It

Use these tools when the model needs normalized financial facts, concept-level series, or statement-shaped outputs grounded in XBRL.

Request Examples

BASE_URL="${EDGAR_API_URL:-https://www.edgarparser.com}"
 
curl -sS -G "$BASE_URL/api/tag_equivalence" \
  -H "Authorization: Bearer $EDGAR_API_KEY" \
  --data-urlencode "tag=us-gaap:Revenues"

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 = {
  "tag": "us-gaap:Revenues"
}
 
response = requests.get(f"{base_url}/api/tag_equivalence", headers=headers, params=params, timeout=30)
response.raise_for_status()
data = response.json()

Response Fields To Inspect

• status / semantic_status for whether the tool produced a usable fact set.
• coverage_status and coverage_warning before treating the value as complete.
• source_ref, concept names, units, and period metadata for citation and auditability.

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.

Related Tools

Metric, List Metrics, Search Metrics

Generated Reference

Contract

Parameters

Response Schema (200)

{}