Docs menu

SEC EDGAR API endpoint

SEC XBRL Frames API

Returns every filer's reported value for one XBRL concept in one reporting period (an EDGAR "frame").

GETapiKey1 credit/requestSEC EDGARsec.framesResponseDoc/sec/frames

Endpoint facts

Method: GET
API path: /sec/frames
Auth: apiKey
Credits: 1 credit/request
Charged on: Successful 2xx responses only
Platform: SEC EDGAR
Response schema: #/definitions/sec.framesResponseDoc

SEC EDGAR API Try SEC XBRL Frames API in Playground SEC EDGAR API documentation

How this endpoint behaves

Query parameters:

concept (required) — XBRL concept tag, e.g. Assets, Revenues.
period (required) — reporting frame, e.g. CY2024, CY2024Q1, CY2024Q4I.
unit (optional, default USD).
taxonomy (optional, default us-gaap) — one of dei, ifrs-full, srt, us-gaap.
limit (optional, default 200, max 2000).

Response includes facts[]: cik, entity_name, value, start, end, accession_number, form.

Live monitoring

Monitored request: GET /sec/frames?concept=Assets&limit=5&period=CY2024Q4I
Checks passed, 7 days to 14 Oct 2026: 100%
Median response time: 0.13 s

Current status of every endpoint

Sampled response

Request, 14 Oct 2026: GET /sec/frames?concept=Assets&limit=20&period=CY2024Q4I
Items in facts: 20
Fields filled in every checked item: 5

Field	Filled in, of 20 checked	Values in the sample
cik	20	1,750 to 5,272, median 3,499
entity_name	20	“AAR CORP” and 19 other values
value	20	15,130 to 271,461,000,000, median 10,519,000,000
end	20	2024-11-30 to 2024-12-31
accession_number	20	“0001410578-25-000003” and 19 other values

Request parameters

Parameter	Type	Required	Description	Example
concept	string	Yes	XBRL concept tag, e.g. Assets, Revenues	Assets
period	string	Yes	Reporting frame, e.g. CY2024, CY2024Q1, CY2024Q4I	CY2024Q4I
unit	string	No	Unit of measure, default USD	USD
taxonomy	string	No	XBRL taxonomy, default us-gaap Allowed values: dei, ifrs-full, srt, us-gaap.
limit	integer	No	Max companies, default 200, max 2000
x-api-key (header)	string	Yes	API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/sec/frames?concept=Assets&period=CY2024Q4I&taxonomy=dei&limit=10" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "taxonomy": "us-gaap",
    "concept": "Assets",
    "unit": "USD",
    "period": "CY2024Q4I",
    "total": 6245,
    "count": 1,
    "facts": [
      {
        "cik": 1750,
        "entity_name": "AAR CORP",
        "value": 2849300000,
        "end": "2024-11-30",
        "accession_number": "0001410578-25-000003"
      }
    ],
    "source_url": "https://data.sec.gov/api/xbrl/frames/us-gaap/Assets/USD/CY2024Q4I.json"
  }
}

Request schema

No body schema

Response schema

#/definitions/sec.framesResponseDoc

Field	Type	Required	Example	Description
code	integer	No	200
data	sec.FramesResponse	No
data.concept	string	No	Assets	XBRL concept tag that was queried, such as `Assets`.
data.count	integer	No		Number of facts returned.
data.facts	array	No		One reported value per company for the concept and frame.
data.facts[].accession_number	string	No		SEC accession number of the filing that reported the value.
data.facts[].cik	integer	No		Reporting company's SEC Central Index Key (CIK) number.
data.facts[].end	string	No		Last day of the period the value covers, in YYYY-MM-DD format.
data.facts[].entity_name	string	No		Name of the reporting company.
data.facts[].form	string	No		SEC form type of the filing that reported the value.
data.facts[].start	string	No		First day of the period the value covers, in YYYY-MM-DD format.
data.facts[].value	number	No		Value the company reported for the concept, in the unit given by `unit`.
data.period	string	No	CY2024Q4I	Reporting frame that was queried, such as `CY2024Q4I`.
data.source_url	string	No		URL the data was read from.
data.taxonomy	string	No	us-gaap	XBRL taxonomy the concept belongs to, such as `us-gaap`.
data.total	integer	No		Number of companies that reported the concept for the frame.
data.unit	string	No	USD	Unit of the reported values, such as `USD`.
msg	string	No	OK

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
404	Not Found	#/definitions/app.Response
500	Internal Server Error	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/sec/frames?concept=Assets&period=CY2024Q4I&taxonomy=dei&limit=10" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Shared guides

Authentication Errors and retries Rate limits and credits Pricing Acceptable use

More SEC EDGAR endpoint docs SEC EDGAR API SEC Company Intelligence API documentation SEC Company Search API documentation SEC Company Submissions API documentation SEC Filing Detail API documentation SEC Filing Section Extraction API documentation SEC Normalized Financials API documentation

Open in Playground Back to group

Docs menu

SEC EDGAR API endpoint

SEC XBRL Frames API

Returns every filer's reported value for one XBRL concept in one reporting period (an EDGAR "frame").

GETapiKey1 credit/requestSEC EDGARsec.framesResponseDoc/sec/frames

Endpoint facts

Method: GET
API path: /sec/frames
Auth: apiKey
Credits: 1 credit/request
Charged on: Successful 2xx responses only
Platform: SEC EDGAR
Response schema: #/definitions/sec.framesResponseDoc

SEC EDGAR API Try SEC XBRL Frames API in Playground SEC EDGAR API documentation

How this endpoint behaves

Query parameters:

concept (required) — XBRL concept tag, e.g. Assets, Revenues.
period (required) — reporting frame, e.g. CY2024, CY2024Q1, CY2024Q4I.
unit (optional, default USD).
taxonomy (optional, default us-gaap) — one of dei, ifrs-full, srt, us-gaap.
limit (optional, default 200, max 2000).

Response includes facts[]: cik, entity_name, value, start, end, accession_number, form.

Live monitoring

Monitored request: GET /sec/frames?concept=Assets&limit=5&period=CY2024Q4I
Checks passed, 7 days to 14 Oct 2026: 100%
Median response time: 0.13 s

Current status of every endpoint

Sampled response

Request, 14 Oct 2026: GET /sec/frames?concept=Assets&limit=20&period=CY2024Q4I
Items in facts: 20
Fields filled in every checked item: 5

Field	Filled in, of 20 checked	Values in the sample
cik	20	1,750 to 5,272, median 3,499
entity_name	20	“AAR CORP” and 19 other values
value	20	15,130 to 271,461,000,000, median 10,519,000,000
end	20	2024-11-30 to 2024-12-31
accession_number	20	“0001410578-25-000003” and 19 other values

Request parameters

Parameter	Type	Required	Description	Example
concept	string	Yes	XBRL concept tag, e.g. Assets, Revenues	Assets
period	string	Yes	Reporting frame, e.g. CY2024, CY2024Q1, CY2024Q4I	CY2024Q4I
unit	string	No	Unit of measure, default USD	USD
taxonomy	string	No	XBRL taxonomy, default us-gaap Allowed values: dei, ifrs-full, srt, us-gaap.
limit	integer	No	Max companies, default 200, max 2000
x-api-key (header)	string	Yes	API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/sec/frames?concept=Assets&period=CY2024Q4I&taxonomy=dei&limit=10" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "taxonomy": "us-gaap",
    "concept": "Assets",
    "unit": "USD",
    "period": "CY2024Q4I",
    "total": 6245,
    "count": 1,
    "facts": [
      {
        "cik": 1750,
        "entity_name": "AAR CORP",
        "value": 2849300000,
        "end": "2024-11-30",
        "accession_number": "0001410578-25-000003"
      }
    ],
    "source_url": "https://data.sec.gov/api/xbrl/frames/us-gaap/Assets/USD/CY2024Q4I.json"
  }
}

Request schema

No body schema

Response schema

#/definitions/sec.framesResponseDoc

Field	Type	Required	Example	Description
code	integer	No	200
data	sec.FramesResponse	No
data.concept	string	No	Assets	XBRL concept tag that was queried, such as `Assets`.
data.count	integer	No		Number of facts returned.
data.facts	array	No		One reported value per company for the concept and frame.
data.facts[].accession_number	string	No		SEC accession number of the filing that reported the value.
data.facts[].cik	integer	No		Reporting company's SEC Central Index Key (CIK) number.
data.facts[].end	string	No		Last day of the period the value covers, in YYYY-MM-DD format.
data.facts[].entity_name	string	No		Name of the reporting company.
data.facts[].form	string	No		SEC form type of the filing that reported the value.
data.facts[].start	string	No		First day of the period the value covers, in YYYY-MM-DD format.
data.facts[].value	number	No		Value the company reported for the concept, in the unit given by `unit`.
data.period	string	No	CY2024Q4I	Reporting frame that was queried, such as `CY2024Q4I`.
data.source_url	string	No		URL the data was read from.
data.taxonomy	string	No	us-gaap	XBRL taxonomy the concept belongs to, such as `us-gaap`.
data.total	integer	No		Number of companies that reported the concept for the frame.
data.unit	string	No	USD	Unit of the reported values, such as `USD`.
msg	string	No	OK

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
404	Not Found	#/definitions/app.Response
500	Internal Server Error	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/sec/frames?concept=Assets&period=CY2024Q4I&taxonomy=dei&limit=10" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Shared guides

Authentication Errors and retries Rate limits and credits Pricing Acceptable use

Open in Playground Back to group

SEC XBRL Frames API

Endpoint facts

How this endpoint behaves

Live monitoring

Sampled response

Request parameters

cURL example

Example JSON response

Failure responses

Code examples

Shared guides

Related

SEC XBRL Frames API

Endpoint facts

How this endpoint behaves

Live monitoring

Sampled response

Request parameters

cURL example

Example JSON response

Failure responses

Code examples

Shared guides

Related