Audience: application and coding agent.
Agent mode
Pass?view=agent to receive the compact agent shape: concept, value, unit, and period fields plus lifted accessionNumber / filingUrl from provenance. Metadata envelopes are dropped. See api conventions → response formats for the full ?view= contract.
Selecting comparable facts
Supply one issuer identifier. Omittag to receive the service’s common financial metrics, or pass an XBRL concept such as Revenues, NetIncomeLoss, or PropertyPlantAndEquipmentNet for a concept-specific series. Use taxonomy, form, unit, and fiscal-year filters to avoid mixing different concepts, reporting periods, or units.
With no explicit taxonomy or form, the route starts with us-gaap 10-K / 10-Q coverage and falls back to ifrs-full 20-F / 6-K when that lookup is empty for a foreign private issuer. Read requestedTag, resolvedTag, aliasStrategy, and completeness before treating a series as a like-for-like historical comparison.
Related guides
XBRL API guide
Understand concepts, units, and filing-backed fact retrieval.
Freshness and trust
Interpret provenance and freshness metadata before publishing a result.
Canonical metadata
requestIdtraceparentprovenancefreshnessmaterialization
Example request
Example response
About this example
This response uses a synthetic issuer andexample.com URL to show a coherent annual revenue fact. It does not identify or claim a live SEC source.
Give this prompt to your agent
Failure posture
- provide one issuer identifier and avoid conflicting
tickerandsymbolvalues - do not substitute an unresolved concept or missing fact with zero; retain the returned concept-resolution and completeness fields
- compare only facts with compatible taxonomy, unit, form, and reporting-period context
- preserve
requestIdandtraceparentwhen retrying a transient failure

