Endpoint Playground

Try the SEC XBRL Frames API

Test Crawlora's SEC XBRL Frames API with realistic prefilled parameters. Generate a cURL request, inspect the expected structured JSON response, and open the full docs or pricing page when you are ready to integrate this public web data extraction endpoint into your application.

Endpoint facts

Method: GET
API path: /sec/frames
Platform: SEC EDGAR
Auth: apiKey
Credits: 1 credit/request
Required params: concept, period
Common optional params: unit, taxonomy, limit

SEC XBRL Frames API documentation SEC EDGAR platform page Crawlora API pricing Try SEC Company Intelligence API Try SEC Company Search API Try SEC Company Submissions API Try SEC Filing Detail API Try SEC Filing Section Extraction API

Prefilled cURL

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

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
concept	string	Yes	Assets	XBRL concept tag, e.g. Assets, Revenues
period	string	Yes	CY2024Q4I	Reporting frame, e.g. CY2024, CY2024Q1, CY2024Q4I
unit	string	No	USD	Unit of measure, default USD
taxonomy	string	No	dei	XBRL taxonomy, default us-gaap
limit	integer	No		Max companies, default 200, max 2000

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"
  }
}

Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

10 shown

Group

Method

Auth

Endpoint

GETapiKey1 credit/requestsec.framesResponseDocSEC EDGAR

GET /sec/frames

Cross-company values for one XBRL concept and period

Returns every filer's reported value for one XBRL concept in one reporting period (an EDGAR "frame"). Credential-free public SEC data.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Required query parameters

concept

requiredstring

XBRL concept tag, e.g. Assets, Revenuesperiod

requiredstring

Reporting frame, e.g. CY2024, CY2024Q1, CY2024Q4I

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "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"
  }
}

Endpoint details

Returns every filer's reported value for one XBRL concept in one reporting period (an EDGAR "frame"). Credential-free public SEC data.

Method: GET
Path: /sec/frames
Authentication: apiKey
Credit cost: 1 credit/request
Platform: SEC EDGAR
Parameters: 6 documented fields

Request parameters

concept:queryperiod:queryunit:querytaxonomy:querylimit:queryx-api-key:header

Response schema fields

codedatadata.conceptdata.countdata.factsdata.facts[].accession_numberdata.facts[].cikdata.facts[].enddata.facts[].entity_namedata.facts[].formdata.facts[].startdata.facts[].value

Sample response summary

{
  "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"
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/sec/frames?concept=<concept>&period=<period>" \
  -H "x-api-key: $CRAWLORA_API_KEY"

View endpoint docs Open platform page Browse all endpoints Pricing Company 360 overview from SEC data Resolve a ticker or company name to EDGAR companies List a company's EDGAR filings Get a single filing by accession number Extract 10-K/10-Q/8-K item sections

Try the SEC XBRL Frames API

Endpoint facts

Method: GET
API path: /sec/frames
Platform: SEC EDGAR
Auth: apiKey
Credits: 1 credit/request
Required params: concept, period
Common optional params: unit, taxonomy, limit

Prefilled cURL

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

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
concept	string	Yes	Assets	XBRL concept tag, e.g. Assets, Revenues
period	string	Yes	CY2024Q4I	Reporting frame, e.g. CY2024, CY2024Q1, CY2024Q4I
unit	string	No	USD	Unit of measure, default USD
taxonomy	string	No	dei	XBRL taxonomy, default us-gaap
limit	integer	No		Max companies, default 200, max 2000

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"
  }
}

{ "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" } }

Endpoint details

Returns every filer's reported value for one XBRL concept in one reporting period (an EDGAR "frame"). Credential-free public SEC data.

Method: GET
Path: /sec/frames
Authentication: apiKey
Credit cost: 1 credit/request
Platform: SEC EDGAR
Parameters: 6 documented fields

Request parameters

concept:queryperiod:queryunit:querytaxonomy:querylimit:queryx-api-key:header

Response schema fields

codedatadata.conceptdata.countdata.factsdata.facts[].accession_numberdata.facts[].cikdata.facts[].enddata.facts[].entity_namedata.facts[].formdata.facts[].startdata.facts[].value

Sample response summary

{
  "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"
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/sec/frames?concept=<concept>&period=<period>" \
  -H "x-api-key: $CRAWLORA_API_KEY"