STstockfit
Footnotes

Revenue Segmentation

Changed on

Starter Stock Pro

Returns revenue split by geography and product in a single response, period by period. Sourced from XBRL dimensional facts disclosed in 10-K / 10-Q / 20-F filings.

The geography field is partitioned into four buckets:

  • countries: ISO 3166-1 alpha-2 leaves (e.g. country:US, country:CN) with country name and continent.
  • usStates: US state postal codes (XBRL stpr:XX convention) with full state name. Present when a filer disclosed the metric by US state, common for state-tax disclosures, real-estate property counts, and similar US-internal breakdowns.
  • regions: regional rollups the filer tagged directly (e.g. srt:AmericasMember, us-gaap:EMEAMember). For each region we also compute explainedByCountries (sum of country leaves whose continent matches the region, only attributed for true top-level continent rollups like Americas/Europe/Asia/Africa/Oceania) and other (the region total minus that sum), letting you surface a residual "other countries in region" bucket without losing data.
  • residuals: filer-extension catch-alls like jhx:OtherCountriesMember that don't map to a continent.

The product field is a flat list of revenue-by-product members. Parent/leaf overlap (e.g. us-gaap:ProductMember alongside aapl:iPhoneMember) is preserved as-is; consumers can collapse subtotals client-side. What this data can tell you:

  • Revenue dependence on a single country or region, and how it trends.
  • Product mix: which lines drive growth and which are shrinking.
  • Share of revenue earned outside the reporting currency (FX sensitivity).
  • State-level revenue concentrations where disclosed.
get/api/footnotes/revenue-segmentation

Request

Query parameters

symbolstring

Stock ticker symbol. Identify the entity by exactly one of: symbol, cik, cusip, composite_figi, or share_class_figi. At least one is required.

cikinteger

SEC Central Index Key (CIK).

cusipstring

CUSIP identifier (9 characters).

composite_figistring

Composite OpenFIGI identifier.

share_class_figistring

Share-class OpenFIGI identifier.

period'annual' | 'quarter'

Base reporting period: annual or quarter (the periods companies actually report, without the derived ttm rollup).

The reporting period: annual returns FY entries; quarter returns Q1-Q4 with Q2/Q3 synthesized from cumulative H1/9M as needed.

limitinteger

Maximum number of periods to return (may be clamped by subscription tier).

Response

Revenue segmentation by geography and product, organized by period. Members the filer later renamed or stopped reporting are left out of earlier periods instead of appearing beside their successors.

periodstring date

The fiscal period end date (YYYY-MM-DD)

fiscalYearinteger

The company's fiscal year (handles non-December year-ends).

fiscalPeriod'FY' | 'Q1' | 'Q2' | 'Q3' | 'Q4'

Fiscal period of a reported value: FY (annual) or Q1-Q4 (quarterly).

unitstring

Standardized unit of the values (usually USD)

dateFiledstring date nullable

SEC filing acceptance date for the source 10-K/10-Q. Use this to gate point-in-time data and avoid lookahead bias.

Example response

[
  {
    "period": "2024-03-29",
    "fiscalYear": 2024,
    "fiscalPeriod": "FY",
    "unit": "USD",
    "geography": {
      "countries": [
        {
          "code": "US",
          "name": "United States",
          "continent": "Americas",
          "value": 167045000000
        }
      ],
      "usStates": [
        {
          "code": "CA",
          "name": "California",
          "value": 1269000
        }
      ],
      "regions": [
        {
          "member": "srt:AmericasMember",
          "name": "Americas",
          "continent": "Americas",
          "value": 167045000000,
          "explainedByCountries": 167045000000
        }
      ],
      "residuals": [
        {
          "member": "jhx:OtherCountriesMember",
          "name": "Other Countries",
          "value": 25000000000
        }
      ]
    },
    "product": [
      {
        "member": "aapl:iPhoneMember",
        "name": "i Phone",
        "value": 201183000000
      }
    ],
    "dateFiled": "2024-11-01"
  }
]

Changes