---
title: "Cross-company ranking by XBRL concept"
method: GET
path: "/api/v1/fundamentals/frames/{concept}"
tags: ["Fundamentals"]
---

# Cross-company ranking by XBRL concept

`GET /api/v1/fundamentals/frames/{concept}`

Rank ALL SEC-filing companies by a single XBRL metric for a given period. Returns up to top_n companies sorted by value. Covers 2000-6000 companies per concept. Use CY2024 for annual income/cashflow, CY2024Q4I for balance sheet (instant).

## Path parameters

- `concept` string, required — XBRL concept name.

## Query parameters

- `period` string — e.g. CY2024, CY2024Q4I, CY2024Q1
- `unit` string — USD, USD/shares, shares, pure
- `taxonomy` string — XBRL taxonomy (us-gaap or dei).
- `top_n` integer — Return top N items.
- `sort` 'desc' | 'asc' — Sort direction.

## Response `200`

Ranked list of companies for the selected XBRL concept and period.

- EnvelopeStubData
  - `data` StubData, required — Response shape not yet documented; fields are returned as-is.
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/4e2740743eb4/schema)